Accounting API Instalments

Retrieve an instalment plan

GET https://api.tamio.com/v2/instalments/retrieve/{uuid}

Retrieves a single instalment plan by its UUID. The plan must belong to the authenticated user.

Path Parameters

uuid string*

UUID of the instalment plan to retrieve

Responses

200 Instalment plan retrieved successfully

Instalment plan retrieved successfully

status integer

instalment_plan InstalmentPlan

400 Bad request. Possible `error_code` values:

Bad request. Possible error_code values:

Code	Description
`1002`	ResourceNotFound

status integer

error string

Human-readable error message

error_code integer

Machine-readable error code

401 Missing or invalid API key

Update an instalment plan

Delete an instalment plan

/instalments/retrieve/{uuid}

1 const response = await fetch("https://api.tamio.com/v2/instalments/retrieve/{uuid}", {
2   headers: {
3     "Authorization": "Bearer YOUR_API_KEY",
4     "Accept": "application/json"
5   }
6 });
7 const data = await response.json();

1 require "uri"
2 require "net/http"
3 
4 url = URI("https://api.tamio.com/v2/instalments/retrieve/{uuid}")
5 
6 https = Net::HTTP.new(url.host, url.port)
7 https.use_ssl = true
8 
9 request = Net::HTTP::Get.new(url)
10 request["Accept"] = "application/json"
11 request["Authorization"] = "Bearer YOUR_API_KEY"
12 
13 response = https.request(request)
14 puts response.read_body

Responses

{
  "status": 200,
  "instalment_plan": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "object": "instalment_plan",
    "label": "Monthly 3x Plan",
    "interval": 1,
    "billing_cycle": "month",
    "upfront": 10,
    "interest": 5,
    "instalments": 3,
    "countries": [
      "de",
      "fr",
      "us"
    ],
    "sales": 15,
    "active": true,
    "created_at": 1700000000
  }
}

1	const response = await fetch("https://api.tamio.com/v2/instalments/retrieve/{uuid}", {
2	headers: {
3	"Authorization": "Bearer YOUR_API_KEY",
4	"Accept": "application/json"
5	}
6	});
7	const data = await response.json();

1	require "uri"
2	require "net/http"
3
4	url = URI("https://api.tamio.com/v2/instalments/retrieve/{uuid}")
5
6	https = Net::HTTP.new(url.host, url.port)
7	https.use_ssl = true
8
9	request = Net::HTTP::Get.new(url)
10	request["Accept"] = "application/json"
11	request["Authorization"] = "Bearer YOUR_API_KEY"
12
13	response = https.request(request)
14	puts response.read_body