Credit Memos
Credit Memos are issued by Suppliers to Retailers after returns have been accepted by the Supplier. Like most other objects, a credit memo has line items for each unique item. The subtotal and quantities of the credit memo cannot exceed the value of the issuing return (prior to adjustments).
Relationships
- Brand • Credit memos belong to a single Supplier.
- Retailer • Credit memos belong to a single Retailer.
- Credit Lines • Credit memos can have many Credit Lines.
Operations
Click on an Operation to view requirements, options, & examples.
| GET | /v1/retailers/{retailer_id}/credits/ | Get a list of Credits |
|---|---|---|
| GET | /v1/retailers/{retailer_id}/credits/{id}/ | Get a single Credit |
| PUT | /v1/retailers/{retailer_id}/credits/{id}/acknowledge/ | Acknowledge receipt |
Credit Memo Properties
| id | A static id assigned by RevCascade. Can be used as the primary key in the url of other credit-related endpoints. |
|---|---|
| retailer |
The retailer that owns the purchase order and that is expected to receive the credit. "retailer": {
"id": 1000,
"name": "Demo Retailer"
...
}
|
| brand |
The supplier that submitted the credit. "brand": {
"id": 1000,
"name": "Demo Vendor"
...
}
|
| currency | The currency of the credit memo. Always 'USD' for now. |
| order |
A simplied view of original purchase order. "order": {
"id": 10050,
"purchase_order_number": "PO-315163",
"ordered_at": "2016-09-24T16:27:50Z"
}
|
| credit_number | The credit memo number from the Supplier's financial system. |
| rma |
The RMA that created the credit memo. "rma": {
"id": 10050,
"rma_number": "RMA-35135123",
"rmad_at": "2016-09-28T16:27:50Z"
}
|
| invoice |
The original invoice from the PO. The invoice is optional and not guaranteed to be tied to the credit memo. "invoice": {
"id": 10550,
"invoice_number": "INV-2341",
"invoiced_at": "2016-09-22T16:27:50Z"
}
|
| subtotal | The sum of all credit lines before any adjustments. |
| adjustments | An array of additional credit memo adjustments that modify the amount credited by the supplier. |
| credit_amount | The total amount being credited. |
| is_acknowledged | Boolean flag that indicates whether the credit memo has been received and acknowledged by the Retailer. |
| credited_at | The timestamp when the credit memo was received by RevCascade. |
| acknowledged_at | The timestamp when the credit memo was acknowledged by the Retailer. This field is null if the credit memo has not been acknowledged. |
| credit_lines |
An array or Credit Line Items. Each credit line represents a unique item from the Purchase Order. {
"id": 15411,
"variant": {
"id": "100084",
"brand": {
"id": "501",
"name": "Marla Cielo",
},
"name": "Contemporary Nightstand",
"description": "Black"
"identifier": "1234",
"upc": "123456789456",
"attributes": [{
// subset of attributes
}]
},
"quantity": 2,
"price": "21.00",
}
id - The credit line id. variant - The exact item that was sold and returned. quantity - The number of items being credited. price - The price that the supplier expects to be paid for the item. |
Examples
| GET | /v1/retailers/credits/ | Get a list of credit memos |
|---|
| Optional Query String Parameters | |
| is_acknowledged |
Boolean filter that returns credit memos based on whether or not they have been acknowleged.
1 - show only only credit memos that have been acknowledged. 0 - show credit memos that have not been acknowledged. |
|---|---|
| credited_at_{operator} |
Filter credit memos received by RevCascade before or after an epoch timestamp in UTC.
Please substitute {operator} with "lt" (less than),"lte" (less than or equal), "gt" (greater than), or "gte" (greater than or equal). |
| limit | Customize the number of results return (max 250). Requests that return more records than the limit will be paginated. |
|
Get all new credit memos that have been not yet been acknowledged. GET https://api.revcascade.com/v1/retailers/500/credits/?is_acknowledged=0 |
|
| GET | /v1/retailers/{retailer_id}/credits/{id}/ | Get a single credit memo |
|---|
|
Get a single credit memo by its ID. GET https://api.revcascade.com/v1/retailers/500/credits/123645/ |
| PUT | /v1/retailers/{retailer_id}/credits/{id}/acknowledge/ | Acknowledge receipt |
|---|
|
Acknowledge receipt of a new credit memo. PUT https://api.revcascade.com/v1/retailers/500/credits/123645/acknowledge/ |
