curl --request POST \
--url https://api.arcuserp.com/v1/orders/{id}/company-use \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"notes": "<string>",
"entry_date": "2023-12-25",
"backdate_reason": "<string>",
"gl_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accrue_use_tax": false,
"use_tax_rate": 123,
"use_tax_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notify_customer": false,
"expect": {
"invoice_number": "<string>",
"order_total": 123
}
}
'import requests
url = "https://api.arcuserp.com/v1/orders/{id}/company-use"
payload = {
"notes": "<string>",
"entry_date": "2023-12-25",
"backdate_reason": "<string>",
"gl_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accrue_use_tax": False,
"use_tax_rate": 123,
"use_tax_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notify_customer": False,
"expect": {
"invoice_number": "<string>",
"order_total": 123
}
}
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({
notes: '<string>',
entry_date: '2023-12-25',
backdate_reason: '<string>',
gl_account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
accrue_use_tax: false,
use_tax_rate: 123,
use_tax_account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
notify_customer: false,
expect: {invoice_number: '<string>', order_total: 123}
})
};
fetch('https://api.arcuserp.com/v1/orders/{id}/company-use', 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}/company-use",
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([
'notes' => '<string>',
'entry_date' => '2023-12-25',
'backdate_reason' => '<string>',
'gl_account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'accrue_use_tax' => false,
'use_tax_rate' => 123,
'use_tax_account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'notify_customer' => false,
'expect' => [
'invoice_number' => '<string>',
'order_total' => 123
]
]),
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}/company-use"
payload := strings.NewReader("{\n \"notes\": \"<string>\",\n \"entry_date\": \"2023-12-25\",\n \"backdate_reason\": \"<string>\",\n \"gl_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accrue_use_tax\": false,\n \"use_tax_rate\": 123,\n \"use_tax_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notify_customer\": false,\n \"expect\": {\n \"invoice_number\": \"<string>\",\n \"order_total\": 123\n }\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}/company-use")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"notes\": \"<string>\",\n \"entry_date\": \"2023-12-25\",\n \"backdate_reason\": \"<string>\",\n \"gl_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accrue_use_tax\": false,\n \"use_tax_rate\": 123,\n \"use_tax_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notify_customer\": false,\n \"expect\": {\n \"invoice_number\": \"<string>\",\n \"order_total\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/orders/{id}/company-use")
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 \"notes\": \"<string>\",\n \"entry_date\": \"2023-12-25\",\n \"backdate_reason\": \"<string>\",\n \"gl_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accrue_use_tax\": false,\n \"use_tax_rate\": 123,\n \"use_tax_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notify_customer\": false,\n \"expect\": {\n \"invoice_number\": \"<string>\",\n \"order_total\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"dry_run": true,
"order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"order_number": "<string>",
"invoice_number": "<string>",
"entry_date": "2023-12-25",
"floor_date": "2023-12-25",
"ship_date": "2023-12-25",
"account": {},
"default_account": {},
"overridden": true,
"cost": 123,
"use_tax": {},
"entries": [
{}
],
"groups": [
{}
],
"tax": {}
}
}{
"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"
}{
"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",
"default_account": {}
}{
"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",
"default_account": {}
}Convert a shipped order to company use
Converts a fully shipped, invoiced sales order with no money paid or credited against it to company use, for goods that went to the seller’s own company instead of a customer. In one transaction it reverses the order’s recognition (its invoice, fulfillment including the cost of goods sold, tax, shipping and discount entries) on the chosen entry_date, moves the cost of the goods from cost of goods sold to an expense account on the same day (stock stays relieved, because the goods did leave), optionally accrues use tax on that cost, voids the invoice so the order owes nothing and leaves receivables, statements and reminders, and marks the order as company use. After the transaction commits, the invoice’s tax document is voided at the tax service; a refusal because its period was already reported is recorded as a reconciling item and nothing is filed. The key’s user needs the accounting.post permission. An API key never chooses an account: the cost goes to the company-use account set in Settings > AR & Invoicing and the use tax to sales tax payable. To see the entries first, send the same body to POST /orders/{id}/company-use/dry-run, which writes nothing and is never stored under the Idempotency-Key; a body that carries dry_run is refused 400 dry_run_not_accepted here. Once converted, the order refuses cancel, void, undo fulfillment, invoicing, re-opening the bill and returns with 409 order_is_company_use.
curl --request POST \
--url https://api.arcuserp.com/v1/orders/{id}/company-use \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"notes": "<string>",
"entry_date": "2023-12-25",
"backdate_reason": "<string>",
"gl_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accrue_use_tax": false,
"use_tax_rate": 123,
"use_tax_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notify_customer": false,
"expect": {
"invoice_number": "<string>",
"order_total": 123
}
}
'import requests
url = "https://api.arcuserp.com/v1/orders/{id}/company-use"
payload = {
"notes": "<string>",
"entry_date": "2023-12-25",
"backdate_reason": "<string>",
"gl_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accrue_use_tax": False,
"use_tax_rate": 123,
"use_tax_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notify_customer": False,
"expect": {
"invoice_number": "<string>",
"order_total": 123
}
}
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({
notes: '<string>',
entry_date: '2023-12-25',
backdate_reason: '<string>',
gl_account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
accrue_use_tax: false,
use_tax_rate: 123,
use_tax_account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
notify_customer: false,
expect: {invoice_number: '<string>', order_total: 123}
})
};
fetch('https://api.arcuserp.com/v1/orders/{id}/company-use', 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}/company-use",
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([
'notes' => '<string>',
'entry_date' => '2023-12-25',
'backdate_reason' => '<string>',
'gl_account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'accrue_use_tax' => false,
'use_tax_rate' => 123,
'use_tax_account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'notify_customer' => false,
'expect' => [
'invoice_number' => '<string>',
'order_total' => 123
]
]),
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}/company-use"
payload := strings.NewReader("{\n \"notes\": \"<string>\",\n \"entry_date\": \"2023-12-25\",\n \"backdate_reason\": \"<string>\",\n \"gl_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accrue_use_tax\": false,\n \"use_tax_rate\": 123,\n \"use_tax_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notify_customer\": false,\n \"expect\": {\n \"invoice_number\": \"<string>\",\n \"order_total\": 123\n }\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}/company-use")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"notes\": \"<string>\",\n \"entry_date\": \"2023-12-25\",\n \"backdate_reason\": \"<string>\",\n \"gl_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accrue_use_tax\": false,\n \"use_tax_rate\": 123,\n \"use_tax_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notify_customer\": false,\n \"expect\": {\n \"invoice_number\": \"<string>\",\n \"order_total\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/orders/{id}/company-use")
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 \"notes\": \"<string>\",\n \"entry_date\": \"2023-12-25\",\n \"backdate_reason\": \"<string>\",\n \"gl_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"accrue_use_tax\": false,\n \"use_tax_rate\": 123,\n \"use_tax_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notify_customer\": false,\n \"expect\": {\n \"invoice_number\": \"<string>\",\n \"order_total\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"dry_run": true,
"order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"order_number": "<string>",
"invoice_number": "<string>",
"entry_date": "2023-12-25",
"floor_date": "2023-12-25",
"ship_date": "2023-12-25",
"account": {},
"default_account": {},
"overridden": true,
"cost": 123,
"use_tax": {},
"entries": [
{}
],
"groups": [
{}
],
"tax": {}
}
}{
"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"
}{
"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",
"default_account": {}
}{
"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",
"default_account": {}
}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. A second request with the same
key sent while the first is still running waits for it and returns its
answer; if the first is still running after 20 seconds the second
answers 409 idempotency_key_in_use (retryable, nothing done). An
answer carrying retryable: true is not cached. Reusing a key with a
different request body answers 409 idempotency_key_collision (nothing
done; send the new request with a fresh key). The replay, the wait and
these two 409 codes come from the idempotency layer, so they apply to
the operations that run it, each of which can answer the two codes
whether or not its own 409 response lists them. The handlers of these
operations take the header but do not run the layer, so on them the key
neither replays nor answers either code: createPaymentPlan,
chargePaymentPlanInstallment, setProductLocations, updateOrder,
emailOrder, updateOrderItem, confirmPickup, markOrderNoShow,
applyExistingPaymentToInvoices, updatePackage, movePackageItem,
changePackageBox, changePackageCarrier, voidPackageLabel,
printPackageLabel, emailPackage, setProNumberV1, setPackageProNumber,
sendPurchaseOrderToVendorV1, notifyRevisionPurchaseOrderV1,
addMaintenanceLog, generateBOLV1,
createReportJobV1 and customerAcknowledgeRevision; recordVendorPrepaymentV1
and recordCustomerDepositV1 hand the key to their own write instead.
255Path Parameters
Body
Why these goods went to the company (required). Kept on the order and on every entry.
400The day the entries post (default today). On or after the order's ship date and never after today; the posting-date window and closed periods apply.
The reason that allows an entry_date before the posting-date window, for a user who may override it.
The expense account the cost moves to. Omitted: the company-use account set in Settings > AR & Invoicing. A value other than that default is refused 403 company_use_account_choice_requires_user for an API key.
Also accrue use tax on the cost: debit the same expense account and credit the liability.
The use tax rate in percent, above 0 and at most 25. Omitted: the entity's rate at the shipping warehouse, else the rate the order was taxed at.
The liability the use tax is credited to. Omitted: sales tax payable. Any other value is refused 403 company_use_account_choice_requires_user for an API key.
Email the customer that the invoice is voided.
The order as the caller last read it. When a named field has changed the endpoint returns 409 company_use_pre_image_moved and changes nothing.
Show child attributes
Show child attributes
Response
The order is converted. The dry run (POST /orders/{id}/company-use/dry-run) answers the same shape with dry_run true.
Show child attributes
Show child attributes
Was this page helpful?