logo

Get credit memo's amount allocated to the invoice

Get the allocation from the given credit memo to the given invoice with the credit amount.

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

The resource identifier string.

creditMemoId
required
string

Credit memo ID.

query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

Responses
200

The allocation was retrieved successfully.

Response Schema: application/json
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/{creditMemoId}
Request samples
Response samples
application/json
{
  • "invoiceId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "creditMemoId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "amount": 0,
  • "currency": "USD",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}
➔ Next to Apply a credit memo to an invoice