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.