Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.
For more information, see Search filters.
Use credit memos to provide a customer with store credit. A common use case for using a credit memo is to provide a customer with store credit, rather than a refund, if the customer pays more than they owe or returns a product. For information on the credit memo resource, see Resources.
Security
SecretApiKey or JWT or ApplicationJWT
Expands a request to include embedded objects within the _embedded property of the response. This field accepts a comma-separated list of objects.
For more information, see Embedded resources.
- Mock serverhttps://www.rebilly.com/_mock/catalog/all/credit-memos
- Sandbox serverhttps://api-sandbox.rebilly.com/organizations/{organizationId}/credit-memos
- Live serverhttps://api.rebilly.com/organizations/{organizationId}/credit-memos
curl -i -X GET \
'https://www.rebilly.com/_mock/catalog/all/credit-memos?filter=string&sort=string&limit=0&offset=0&q=string&expand=string' \
-H 'REB-APIKEY: YOUR_API_KEY_HERE'Headers
Total number of items that match the request. The value is independent of limit, including when limit is 0.
Example:332
Array [Auto-incrementing number based on the sequence of credit memos for any particular customer. Status of the credit memo.
Reason for the credit memo. Public description, that is visible to customers, which describes the purpose of the credit memo. Total amount of all credits in the credit memo, including items, shipping, and tax. Unused credit memo amount that has not been allocated. ID of the customer resource. ID of the invoice to which the credit memo is issued. ID of the related quote. Date and time when the resource is created.
This value is set automatically when the resource is created. Date and time when the resource is updated.
This value is set automatically when the resource is updated. ]
| Enum Value | Description |
|---|---|
| draft | |
| quotation | Credit memo is associated with a quote. If the customer approves the quotation, the credit memo changes to the |
| issued | |
| applied | |
| partially-applied | |
| voided |
Enum:"return""product-unsatisfactory""order-change""order-cancellation""chargeback""write-off""waiver""customer-credit""prepayment""other"
Default:0
Default:0
Example:"cus_0YV7DDSDD1C8DA64KHH2W33CPF"
Example:"in_0YVF9605RKC62BP14NE2R7V2XT"
Example:"qt_0YVF9605RKC62BP14NE2R7V2XT"
ID of the transaction associated with the credit memo. Associating a transaction does not change the unused amount of the credit memo. The transaction must be approved and associated with the same customer as the credit memo. Approved transactions of any type are accepted, including refunds and voided sales. If the transaction result changes later, the association is retained. If this field is omitted in an update request and customerId is not changed, this field retains its current value. If this field is omitted and customerId is changed, the transaction is removed from the credit memo. To remove the transaction from the credit memo, set this field to null.
Example:"txn_0YVDTQJ8YKC82BP14NE2R7V2XT"
Response
[ { "id": "crmm_0YVCNN22TWC3G8H82QNPNVZCHG", "number": 0, "allocations": { … }, "items": [ … ], "status": "draft", "reason": "return", "description": "string", "shippingAmount": 0, "taxAmount": 0, "totalAmount": 0, "unusedAmount": 0, "revision": 0, "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF", "currency": "USD", "invoiceId": "in_0YVF9605RKC62BP14NE2R7V2XT", "quoteId": "qt_0YVF9605RKC62BP14NE2R7V2XT", "transactionId": "txn_0YVDTQJ8YKC82BP14NE2R7V2XT", "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "_links": [ … ], "_embedded": { … } } ]