Get credit memo allocations to invoices

Get the precise amounts from a credit memo allocated to the invoice.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

Responses
200

List of allocations was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Example: 332
Pagination-Limit
integer

Items per page limit.

Example: 100
Pagination-Offset
integer

Pagination offset.

Example: 2
Response Schema: application/json
Array
amount
required
number <double>

Amount of credit from the credit memo allocated to the given invoice.

invoiceId
string <= 50 characters

ID of the invoice where the credit memo is allocated to.

creditMemoId
string <= 50 characters

ID of the credit memo that was allocated.

currency
string = 3 characters

ISO 4217 alphabetic currency code.

createdTime
string <date-time>

Credit memo allocation time.

updatedTime
string <date-time> (UpdatedTime)

Read-only timestamp updates when the resource is updated.

Array of InvoiceLink (object) or CreditMemoLink (object)

The links related to the resource.

Array
Any of:
rel
required
string

The link type.

Value: "invoice"
href
required
string

The link URL.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/invoices/{id}/credit-memo-allocations
Request samples
Response samples
application/json
[
  • {
    }
]