Developer docs
/
Rebilly API
/
Invoices
/
Retrieve transaction amounts allocations

Retrieve transaction amounts allocations

Retrieves amounts from a transaction that are allocated as invoice payments.

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

get
/invoices/{id}/transaction-allocations
Request samples
$service = new \Rebilly\Sdk\CoreService($client);
$transactionAllocations = $service->invoices()->getAllTransactionAllocations('invoiceId');
Responses

200

List of allocations retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
invoiceId
string <= 50 characters

Unique resource ID.

transactionId
string (TransactionId) <= 50 characters

ID of the transaction.

amount
number <double>
currency
string (CurrencyCode) = 3 characters

Currency code in ISO 4217 format.

Array of objects

Related links.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

Response samples
application/json
[
{
"invoiceId": "in_0YVF9605RKC62BP14NE2R7V2XT",
"transactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0",
"amount": 0.1,
"currency": "USD",

}
]