List an order's invoices

Returns one page of the invoices raised for an order.

GET /orders/{order_id}/invoices

cURL

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/orders/ORD-0001/invoices?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200

{
  "data": [
    {
      "id": "<string>",
      "uuid": "<string>",
      "version": 123,
      "status": "<string>",
      "type": "<string>",
      "origin": "<string>",
      "payment_status": "<string>",
      "account_id": "<string>",
      "account_name": "<string>",
      "order_id": "<string>",
      "customer_purchase_order_id": "<string>",
      "invoice_note": "<string>",
      "issue_date": "<string>",
      "due_date": "<string>",
      "alternate_issue_date": "<string>",
      "alternate_due_date": "<string>",
      "billing_start_date": "<string>",
      "billing_end_date": "<string>",
      "alternate_billing_start_date": "<string>",
      "alternate_billing_end_date": "<string>",
      "subtotal": "<string>",
      "tax": "<string>",
      "tax_total": "<string>",
      "total": "<string>",
      "due": "<string>",
      "paid": "<string>",
      "discount_amount": 123,
      "shipping_cost": "<string>",
      "credit_applied": "<string>",
      "credit_issued": "<string>",
      "payment_applied": "<string>",
      "outstanding": "<string>",
      "price_tax_inclusive": true,
      "recurring_rate_count": "<string>",
      "usage_rate_count": "<string>",
      "currency": {
        "code": "<string>",
        "href": "<string>",
        "id": "<string>",
        "name": "<string>",
        "object": "<string>"
      },
      "custom_form": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "href": "<string>"
      },
      "kpis": {
        "credit_applied": "<string>",
        "credit_issued": "<string>",
        "payment_applied": "<string>",
        "last_payment_date": "<string>",
        "last_amended_on": "<string>",
        "last_cancelled_on": "<string>",
        "last_reactivated_on": "<string>",
        "deleted_on": "<string>",
        "voided_on": "<string>",
        "outstanding": "<string>",
        "overdue": 123
      },
      "last_payment": {
        "uuid": "<string>",
        "id": "<string>",
        "date": "<string>",
        "amount": "<string>",
        "created_on": "<string>"
      },
      "created_on": "<string>",
      "created_by": {
        "name": "<string>",
        "object": "<string>"
      },
      "last_updated_on": "<string>",
      "last_updated_by": {
        "name": "<string>",
        "object": "<string>"
      },
      "lines": [
        {
          "object": "<string>",
          "id": "<string>",
          "version": 123,
          "item": {
            "object": "<string>",
            "id": "<string>",
            "name": "<string>",
            "href": "<string>"
          },
          "item_id": "<string>",
          "item_uuid": "<string>",
          "item_name": "<string>",
          "item_uom": "<string>",
          "item_warehouse": "<string>",
          "item_serial_or_batch_number": "<string>",
          "item_order_quantity": 123,
          "item_charge_type": "<string>",
          "item_custom_attributes": [
            "<unknown>"
          ],
          "pricing_snapshot_price": 123,
          "pricing_snapshot_uuid": "<string>",
          "charging_start_date": "<string>",
          "charging_end_date": "<string>",
          "alternate_charging_start_date": "<string>",
          "alternate_charging_end_date": "<string>",
          "subtotal": "<string>",
          "total": "<string>",
          "tax": {
            "object": "<string>",
            "id": "<string>",
            "name": "<string>",
            "rate": 123,
            "amount": "<string>",
            "href": "<string>"
          },
          "accounting_code": {
            "sales_revenue": "<string>"
          }
        }
      ],
      "custom_attributes": [
        {
          "name": "<string>",
          "value": "<unknown>"
        }
      ],
      "custom_objects": [
        "<unknown>"
      ],
      "activity_logs": [
        {
          "activity": "<string>"
        }
      ],
      "notes": [
        {
          "object": "<string>",
          "id": "<string>",
          "href": "<string>",
          "content": "<string>",
          "version": 123,
          "invoice": {
            "href": "<string>",
            "id": "<string>",
            "object": "<string>"
          },
          "group": "<unknown>",
          "user": "<unknown>",
          "attachments": [
            {
              "uuid": "<string>",
              "filename": "<string>",
              "content_type": "<string>",
              "size": 123,
              "href": "<string>"
            }
          ],
          "watchers": [
            {
              "email": "<string>",
              "name": "<string>",
              "type": "<string>"
            }
          ],
          "created_on": "<string>",
          "created_by": {
            "name": "<string>",
            "object": "<string>"
          },
          "last_updated_on": "<unknown>",
          "last_updated_by": "<unknown>"
        }
      ],
      "item_fulfillments": [
        {
          "uuid": "<string>",
          "id": "<string>",
          "version": "<string>",
          "invoice_id": "<string>",
          "order_id": "<string>",
          "date": "<string>",
          "status": "<string>",
          "note": "<string>",
          "tracking_number": "<string>",
          "created_on": "<string>",
          "created_by": "<string>",
          "last_updated_on": "<string>",
          "last_updated_by": "<string>",
          "fulfillments": [
            "<unknown>"
          ]
        }
      ],
      "return_merchandise_authorisations": [
        "<unknown>"
      ],
      "account": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "href": "<string>"
      },
      "object": "<string>",
      "order": {
        "object": "<string>",
        "id": "<string>",
        "name": "<string>",
        "href": "<string>"
      }
    }
  ],
  "object": "<string>",
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  },
  "url": "<string>"
}

Lists the invoices of one order, one page at a time, under data. Each record has the same fields as an entry of the invoice listing.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization · string · header · required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

order_id · string · required

The order's id.

Query Parameters

limit · integer

The most records to return on one page.

Example:

20

cursor · string

The next_cursor value from the previous page, to fetch the page after it.

sort · string

The field to sort by. Put - in front for descending order, such as -created_on.

Example:

"-created_on"

Response

200 - application/json

One page of the order's invoices, under data, with pagination.

data · object[]

Show child attributes

object · string

pagination · object

Show child attributes

url · string