Retrieve credit memos

Retrieves a list of credit memos.

SecurityAPI Key: SecretApiKey or HTTP: JWT or HTTP: ApplicationJWT
Request
query Parameters
filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

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.

q
string

Use this field to perform a partial search of text fields.

get
/credit-memos
Responses

200

List of credit memos 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
id
string <= 50 characters

ID of the credit memo.

number
integer

Auto-incrementing number based on the sequence of credit memos for any particular customer.

object

Allocations reduce the unused amount of a credit memo.

Array of objects

Items of the credit memo.

status
string

Status of the credit memo.

Enum Value Description
issued

The credit memo is available with a full amount to be applied.

applied

The full amount of the credit memo has been applied. No more credit can be created from it.

partially-applied

A partial amount of the credit memo has been applied. A credit can be created from the remaining amount.

voided

Credit memo has been voided and cannot be used anymore.

reason
string

Reason for the credit memo.

Enum: "return" "product-unsatisfactory" "order-change" "order-cancellation" "chargeback" "write-off" "waiver" "customer-credit" "other"
description
string

Public description, that is visible to customers, which describes the purpose of the credit memo.

shippingAmount
number <double>
Default: 0

Shipping amount of an invoice to credit.

taxAmount
number <double>
Default: 0

Sum of items tax amount of an invoice to credit.

totalAmount
number <double>
Default: 0

Total amount of all credits in the credit memo, including items, shipping, and tax.

unusedAmount
number <double>
Default: 0

Unused credit memo amount that has not been allocated.

revision
integer

Number of times the credit memo has been modified.

customerId
required
string (CustomerId) <= 50 characters

ID of the customer resource.

currency
required
string (CurrencyCode) = 3 characters

Currency code in ISO 4217 format.

invoiceId
string or null <= 50 characters

ID of the invoice to which the credit memo is issued.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects

Related links.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

Response samples
application/json
[ { "id": "crmm_0YVCNN22TWC3G8H82QNPNVZCHG", "number": 0, "status": "issued", "reason": "return", "description": "string", "shippingAmount": 0, "taxAmount": 0, "totalAmount": 0, "unusedAmount": 0, "revision": 0, "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "currency": "USD", "invoiceId": "in_0YVF9605RKC62BP14NE2R7V2XT", "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", } ]