logo

Retrieve transaction amounts allocations

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

SecuritySecretApiKey or 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

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

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 (ResourceId) <= 50 characters

Unique resource ID. Defaults to UUID v4.

transactionId
string (ResourceId) <= 50 characters

Unique resource ID. Defaults to UUID v4.

amount
number
currency
string = 3 characters

Currency code in ISO 4217 format.

Array of objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Enum: "invoice" "transaction"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/invoices/{id}/transaction-allocations
Request samples 
$service = new Rebilly\Sdk\CoreService($client);
$transactionAllocations = $service->invoices()->getAllTransactionAllocations('invoiceId');
Response samples
application/json
[
  • {
    }
]
➔ Next to Apply a transaction to an invoice