curl --request POST \
--url https://api.arcuserp.com/v1/orders/{id}/invoice \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"is_historical_import": true,
"invoice_date": "2023-12-25",
"posted_at": "2023-11-07T05:31:56Z",
"skip_revision_ack": true,
"bill_ahead_of_shipment": true,
"bill_ahead_reason": "<string>"
}
'import requests
url = "https://api.arcuserp.com/v1/orders/{id}/invoice"
payload = {
"is_historical_import": True,
"invoice_date": "2023-12-25",
"posted_at": "2023-11-07T05:31:56Z",
"skip_revision_ack": True,
"bill_ahead_of_shipment": True,
"bill_ahead_reason": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
is_historical_import: true,
invoice_date: '2023-12-25',
posted_at: '2023-11-07T05:31:56Z',
skip_revision_ack: true,
bill_ahead_of_shipment: true,
bill_ahead_reason: '<string>'
})
};
fetch('https://api.arcuserp.com/v1/orders/{id}/invoice', 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/{id}/invoice",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'is_historical_import' => true,
'invoice_date' => '2023-12-25',
'posted_at' => '2023-11-07T05:31:56Z',
'skip_revision_ack' => true,
'bill_ahead_of_shipment' => true,
'bill_ahead_reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.arcuserp.com/v1/orders/{id}/invoice"
payload := strings.NewReader("{\n \"is_historical_import\": true,\n \"invoice_date\": \"2023-12-25\",\n \"posted_at\": \"2023-11-07T05:31:56Z\",\n \"skip_revision_ack\": true,\n \"bill_ahead_of_shipment\": true,\n \"bill_ahead_reason\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.arcuserp.com/v1/orders/{id}/invoice")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"is_historical_import\": true,\n \"invoice_date\": \"2023-12-25\",\n \"posted_at\": \"2023-11-07T05:31:56Z\",\n \"skip_revision_ack\": true,\n \"bill_ahead_of_shipment\": true,\n \"bill_ahead_reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/orders/{id}/invoice")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"is_historical_import\": true,\n \"invoice_date\": \"2023-12-25\",\n \"posted_at\": \"2023-11-07T05:31:56Z\",\n \"skip_revision_ack\": true,\n \"bill_ahead_of_shipment\": true,\n \"bill_ahead_reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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,
"list_price_total": 123,
"pricing_savings": 123,
"amount_paid": 123,
"balance_due": 123,
"amount_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"
}{
"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"
}{
"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"
}Create an invoice
Creates an invoice from a confirmed sales order under its own invoice number, posting the accounts-receivable journal entry for the standard order-to-cash workflow. Billing before anything on the order has shipped requires the bill_ahead_of_shipment flag with a reason and the matching permission, and an order with an unacknowledged revision returns 409 until the customer acknowledges it.
curl --request POST \
--url https://api.arcuserp.com/v1/orders/{id}/invoice \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"is_historical_import": true,
"invoice_date": "2023-12-25",
"posted_at": "2023-11-07T05:31:56Z",
"skip_revision_ack": true,
"bill_ahead_of_shipment": true,
"bill_ahead_reason": "<string>"
}
'import requests
url = "https://api.arcuserp.com/v1/orders/{id}/invoice"
payload = {
"is_historical_import": True,
"invoice_date": "2023-12-25",
"posted_at": "2023-11-07T05:31:56Z",
"skip_revision_ack": True,
"bill_ahead_of_shipment": True,
"bill_ahead_reason": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
is_historical_import: true,
invoice_date: '2023-12-25',
posted_at: '2023-11-07T05:31:56Z',
skip_revision_ack: true,
bill_ahead_of_shipment: true,
bill_ahead_reason: '<string>'
})
};
fetch('https://api.arcuserp.com/v1/orders/{id}/invoice', 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/{id}/invoice",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'is_historical_import' => true,
'invoice_date' => '2023-12-25',
'posted_at' => '2023-11-07T05:31:56Z',
'skip_revision_ack' => true,
'bill_ahead_of_shipment' => true,
'bill_ahead_reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.arcuserp.com/v1/orders/{id}/invoice"
payload := strings.NewReader("{\n \"is_historical_import\": true,\n \"invoice_date\": \"2023-12-25\",\n \"posted_at\": \"2023-11-07T05:31:56Z\",\n \"skip_revision_ack\": true,\n \"bill_ahead_of_shipment\": true,\n \"bill_ahead_reason\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.arcuserp.com/v1/orders/{id}/invoice")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"is_historical_import\": true,\n \"invoice_date\": \"2023-12-25\",\n \"posted_at\": \"2023-11-07T05:31:56Z\",\n \"skip_revision_ack\": true,\n \"bill_ahead_of_shipment\": true,\n \"bill_ahead_reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/orders/{id}/invoice")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"is_historical_import\": true,\n \"invoice_date\": \"2023-12-25\",\n \"posted_at\": \"2023-11-07T05:31:56Z\",\n \"skip_revision_ack\": true,\n \"bill_ahead_of_shipment\": true,\n \"bill_ahead_reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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,
"list_price_total": 123,
"pricing_savings": 123,
"amount_paid": 123,
"balance_due": 123,
"amount_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"
}{
"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"
}{
"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
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.
Headers
Client-generated unique key for idempotent POST/PATCH/DELETE operations. Alias for the Idempotency parameter. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours.
255Path Parameters
Body
Migration-mode flag. When true AND the key carries
migration:write, the invoice skips the AR/revenue JE
(AR is loaded separately by the migration). Silently
coerced to false for non-migration callers.
Caller-supplied invoice date. Honored only when the key
carries migration:write; ignored otherwise.
Caller-supplied GL posting timestamp. Honored only when
the key carries migration:write; ignored otherwise.
When true, bypasses the revision acknowledgment gate. Requires the caller to have the orders.revision_override permission; returns 403 otherwise. Equivalent to the ?override=true query parameter.
Bill the whole order although nothing on it has shipped yet.
Without this flag the endpoint returns HTTP 422
nothing_shipped_blocks_whole_order_invoice when the order has
zero shipped units and unshipped units outstanding, because a
whole-order invoice would bill undelivered goods and put
receivable on the books with no revenue posted behind it.
Billing ahead of shipment is a supported workflow, so the flag
is an audited override rather than a bypass: it requires
bill_ahead_reason and the orders.bill_ahead_of_shipment
permission on the key's user, and it writes an
order_billed_ahead_of_shipment activity row naming the
principal, the reason, the unshipped units and their value.
Sending it on an order that has shipped units changes nothing.
Why this order is being invoiced before the goods leave the warehouse. Required whenever bill_ahead_of_shipment is true; at least 10 characters after trimming, or the endpoint returns HTTP 422 bill_ahead_reason_required. Recorded on the order's activity trail and surfaced on the billed-not-shipped report.
10Response
Invoice created
An Arcus ERP order document. One table holds quotes, sales_orders, invoices, returns, and purchase_orders -- always filter by document_type. entity_id is always from the API key (Layer 1 isolation).
order quote, sales_order, invoice, return, purchase_order draft, confirmed, partially_fulfilled, fulfilled, cancelled, voided, awaiting_ach_clearance, on_hold unpaid, partially_paid, paid, overpaid, refunded, partially_refunded, voided unfulfilled, partially_fulfilled, fulfilled Derived (display-only): SUM(list_price * qty) over non-kit lines. The gross baseline of the gross-to-net bridge (List price minus pricing_savings equals subtotal). Never part of order_total.
Derived (display-only): SUM(pricing_rule_adjustment * qty) over non-kit lines (positive magnitude). Per-unit pricing-rule savings already baked into subtotal via sell_rate (ASC 606 transaction price); shown as an informational List-to-Subtotal bridge, never subtracted from order_total.
SSOT: utils/ar-helpers.mjs::updateARBalance. Do not write directly.
AR receivable (the amount this document is owed AS A RECEIVABLE). Forced to 0 on DRAFT sales documents, on cancelled / archived / expired orders, and on voided or fully-refunded invoices, because none of those carries a receivable: a draft is not a receivable, and a terminal document owes nothing. This is the number that ties to AR aging, the AR outstanding total, and the GL AR control account. For the amount still COLLECTIBLE on any document at any status (including a draft), use amount_due. Purchase orders and quotes are never forced to 0. SSOT: utils/ar-helpers.mjs::updateARBalance. Do not write directly.
Collectible remainder: order_total minus amount_paid, rounded to 2 decimals. Status-blind BY DESIGN, so it answers "how much is still OUTSTANDING on this document as simple arithmetic" even where balance_due is 0 because the document is not (yet) a receivable. Negative when the customer has overpaid (money owed back to them). On a confirmed, non-refunded document with no sales allowance and no cancellation, amount_due and balance_due are equal. NOT A PAYABLE AMOUNT. Because it is status-blind it stays positive on documents that can accept no payment at all -- a cancelled / archived / expired order, a voided invoice, a fully-refunded order -- and it OVERSTATES what is owed on an allowance-settled order (a standalone concession refund reversed goods or tax: balance_due correctly settles to 0 while the remainder does not). Collecting amount_due on either shape creates an overpayment, and the payment endpoints will refuse it with order_not_payable (422). To decide how much to collect, take the amount from the payment surface you are about to call (POST /v1/orders/{id}/payments validates and caps server-side); to reconcile against AR aging or the GL AR control account, use balance_due.
ship, pick_up, local_delivery order, manual, proforma, correction Was this page helpful?

