Invoices

Invoices are submitted by vendors to retailers after an order has been completely fulfilled. In general, one invoice is submitted per purchase order.

Operations

Click on an Operation to view requirements, options, & examples.

Invoice Properties
Name Description

id

integer (11)

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

retailer

retailer

The retailer that owns the purchase order and that is expected to pay the invoice.

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

brand

brand

The brand or vendor that submitted the invoice.

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

purchase_order_number

string (32)

The purchase order number from the Retailer's Order Management System.

invoice_number

string (32)

The invoice number from the vendor's financial system.

terms_net_days_due

integer (11)

The number of days until the invoice is due.

terms_date_due

date

The due date of the invoice.

terms_discount_percent

integer (3)

A discount offered by the vendor if the invoice is paid early.

terms_discount_days

integer (11)

The number of days until the cutoff date for the discount period.

terms_discount_date_due

date

The due date of the invoice in order to qualify for discount.

remit_to

address

The address where the invoice the invoice should be paid.

"remit_to": {
    "type": "null"",
    "name1": "Demo Vendor, Inc.",
    "name2": null,
    "street1": "1332 Hermosa Ave",
    "street2": "Suite 14",
    "city": "Hermosa Beach",
    "province": "CA",
    "postal_code": "90254",
    "country": "US",
    "phone1": (310) 867-5309,
    "phone2": null,
    "fax": null,
    "email": invoices@demovendor.com
}

currency

string (3)

The currency of the invoice.

subtotal

decimal (8,2)

The sum of all invoice lines before any charges or allowances.

charges

array of objects

An array of additional invoice adjustments that increase the amount due by the retailer (e.g. dropship fees, etc).

allowances

array of objects

An array of additional invoice adjustments that decrease the amount due by the retailer (e.g. return allowances, etc).

due_amount

decimal (8,2)

The total amount due.

is_acknowledged

boolean

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

invoiced_at

ISO-8601 Datetime

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

acknowledged_at

ISO-8601 Datetime

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

invoice_lines

array of objects

An array or Invoice Line Items. Each invoice line represents a unique item from the Purchase Order.

"invoice_lines": [{
    "invoice_line_number": 1,
    "variant": {
        "id": "100084",
        "brand": {
            "id": "501",
            "name": "Marla Cielo",
        },
        "name": "Contemporary Nightstand",
        "description": "Black"
        "identifier": "1234",
        "upc": "123456789456",
        "attributes": [{
            // subset of attributes (redacted for brevity)
        }]
    },
    "quantity": 2,
    "price": "21.00"
}]

invoice_line_number - The ordinal line number on the invoice.

variant - The exact item that was sold.

quantity - The number of items being invoiced.

price - The price that the vendor expects to be paid for the item.

Back to Top

Examples
GET /v1/retailers/invoices/ Get a list of invoices
Optional Query String Parameters

is_acknowledged

boolean

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

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

invoiced_at_{operator}

timestamp

Filter invoices 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 invoices that have been not yet been acknowledged.

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

Back to Top

GET /v1/retailers/{retailer_id}/invoices/{id}/ Get a single invoice

Get a single invoice by its ID.

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

Back to Top

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

Acknowledge receipt of a new invoice.

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

Back to Top

powered by