Skip to main content
GET
/
orders
/
invoices
List invoices (document_type=invoice shorthand)
curl --request GET \
  --url https://api.arcuserp.com/v1/orders/invoices \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "object": "order",
      "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order_number": "<string>",
      "document_type": "quote",
      "order_status": "draft",
      "payment_status": "unpaid",
      "fulfillment_status": "unfulfilled",
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "po_number": "<string>",
      "order_date": "2023-11-07T05:31:56Z",
      "due_date": "2023-11-07T05:31:56Z",
      "subtotal": 123,
      "discount_total": 123,
      "shipping_total": 123,
      "tax_total": 123,
      "fee_total": 123,
      "order_total": 123,
      "amount_paid": 123,
      "balance_due": 123,
      "tax_exempt": true,
      "delivery_option": "ship",
      "notes": "<string>",
      "internal_notes": "<string>",
      "invoice_number": "<string>",
      "invoice_type": "order",
      "is_on_hold": true,
      "hold_type": "<string>",
      "ship_complete": true,
      "source_platform": "<string>",
      "external_order_id": "<string>",
      "external_order_number": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "has_more": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Query Parameters

​
limit
integer
default:50
Required range: 1 <= x <= 200
​
offset
integer
default:0
Required range: x >= 0

Response

Paginated invoice list

​
object
enum<string>
Available options:
list
​
data
object[]
​
total
integer
​
has_more
boolean