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>'
import requests

url = "https://api.arcuserp.com/v1/orders/invoices"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.arcuserp.com/v1/orders/invoices', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.arcuserp.com/v1/orders/invoices",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.arcuserp.com/v1/orders/invoices"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.arcuserp.com/v1/orders/invoices")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/orders/invoices")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "object": "list",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "object": "order",
      "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order_number": "<string>",
      "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,
      "list_price_total": 123,
      "pricing_savings": 123,
      "amount_paid": 123,
      "balance_due": 123,
      "tax_exempt": true,
      "notes": "<string>",
      "internal_notes": "<string>",
      "invoice_number": "<string>",
      "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
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}

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