Credits

Credits are issued by vendors to retailers after returns have been accepted by the vendor. Like most other objects, a credit has line items for each unique item. The subtotal and quantities of the credit cannot exceed the value of the issuing return (prior to adjustments).

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 Properties

id

integer (11)

A static id assigned by RevCascade. Can be used as the primary key in the url of other credit-related endpoints.

retailer

retailer

The retailer that owns the purchase order and that is expected to receive the credit.

"retailer": {
    "id": 1000,
    "name": "Demo Retailer",
    ...
}

brand

retailer

The brand or vendor that submitted the credit.

"brand": {
    "id": 1000,
    "name": "Demo Brand"
    ...
}

order

order (simplified)

A simplied view of original purchase order.

"order": {
    "id": 10050,
    "purchase_order_number": "PO-315163",
    "ordered_at": "2016-09-24T16:27:50Z"
}

rma

rma (simplified)

The RMA that created the credit.

"rma": {
    "id": 10050,
    "rma_number": "RMA-35135123",
    "rmad_at": "2016-09-28T16:27:50Z"
}

invoice

invoice (simplified)

The original invoice from the PO. The invoice is optional and not guaranteed to be tied to the credit.

"invoice": {
    "id": 10550,
    "invoice_number": "INV-2341",
    "invoiced_at": "2016-09-22T16:27:50Z"
}

credit_number

string (32)

The credit number from the vendor's financial system.

currency

string (3)

The currency of the credit. Always 'USD' for now.

subtotal

decimal (8,2)

The sum of all credit lines before any adjustments.

adjustments

array of adjustments

An array of additional credit adjustments that modify the amount credited by the vendor.

credit_amount

decimal (8,2)

The total amount being credited.

is_acknowledged

boolean

Boolean flag that indicates whether the credit has been received and acknowledged by the Retailer.

credited_at

ISO-8601 Datetime

The date & time when the credit was received by RevCascade.

acknowledged_at

ISO-8601 Datetime

The date & time when the credit was acknowledged by the retailer. This field is null if the credit has not been acknowledged.

credit_lines

array of objects

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 vendor expects to be paid for the item.

Back to Top

Operation Details & Examples
GET /v1/retailers/credits/ Get a list of credits
Optional Query String Parameters

is_acknowledged

boolean

Boolean filter that returns credits based on whether or not they have been acknowleged.

1 - show only only credits that have been acknowledged.
0 - show credits that have not been acknowledged.

credited_at_{operator}

timestamp

Filter credits 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

integer (3)

Customize the number of results return (max 250). Requests that return more records than the limit will be paginated.

Get all new credit that have been not yet been acknowledged.

GET https://api.revcascade.com/v1/retailers/500/credits/?is_acknowledged=0

Back to Top

GET /v1/retailers/{retailer_id}/credits/{id}/ Get a single credit

Get a single credit by its ID.

GET https://api.revcascade.com/v1/retailers/500/credits/123645/

Back to Top

PUT /v1/retailers/{retailer_id}/credits/{id}/acknowledge/ Acknowledge receipt

Acknowledge receipt of a new credit.

PUT https://api.revcascade.com/v1/retailers/500/credits/123645/acknowledge/

Back to Top

powered by