Record a receipt against a purchase order

curl --request POST \
  --url https://api.arcuserp.com/v1/purchase-orders/{id}/receive \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "quantity_received": 123,
      "order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "po_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "damaged_qty": 123,
      "damage_notes": "<string>"
    }
  ],
  "create_bill": true,
  "notes": "<string>",
  "vendor_shipment": {
    "tracking_number": "<string>",
    "carrier": "<string>",
    "shipped_at": "2023-11-07T05:31:56Z",
    "note": "<string>"
  }
}
'

import requests

url = "https://api.arcuserp.com/v1/purchase-orders/{id}/receive"

payload = {
    "items": [
        {
            "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "quantity_received": 123,
            "order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "po_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "damaged_qty": 123,
            "damage_notes": "<string>"
        }
    ],
    "create_bill": True,
    "notes": "<string>",
    "vendor_shipment": {
        "tracking_number": "<string>",
        "carrier": "<string>",
        "shipped_at": "2023-11-07T05:31:56Z",
        "note": "<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({
    items: [
      {
        product_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        quantity_received: 123,
        order_item_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        po_item_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        damaged_qty: 123,
        damage_notes: '<string>'
      }
    ],
    create_bill: true,
    notes: '<string>',
    vendor_shipment: {
      tracking_number: '<string>',
      carrier: '<string>',
      shipped_at: '2023-11-07T05:31:56Z',
      note: '<string>'
    }
  })
};

fetch('https://api.arcuserp.com/v1/purchase-orders/{id}/receive', 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/purchase-orders/{id}/receive",
  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([
    'items' => [
        [
                'product_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'quantity_received' => 123,
                'order_item_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'po_item_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'damaged_qty' => 123,
                'damage_notes' => '<string>'
        ]
    ],
    'create_bill' => true,
    'notes' => '<string>',
    'vendor_shipment' => [
        'tracking_number' => '<string>',
        'carrier' => '<string>',
        'shipped_at' => '2023-11-07T05:31:56Z',
        'note' => '<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/purchase-orders/{id}/receive"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity_received\": 123,\n      \"order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"po_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"damaged_qty\": 123,\n      \"damage_notes\": \"<string>\"\n    }\n  ],\n  \"create_bill\": true,\n  \"notes\": \"<string>\",\n  \"vendor_shipment\": {\n    \"tracking_number\": \"<string>\",\n    \"carrier\": \"<string>\",\n    \"shipped_at\": \"2023-11-07T05:31:56Z\",\n    \"note\": \"<string>\"\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/purchase-orders/{id}/receive")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity_received\": 123,\n      \"order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"po_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"damaged_qty\": 123,\n      \"damage_notes\": \"<string>\"\n    }\n  ],\n  \"create_bill\": true,\n  \"notes\": \"<string>\",\n  \"vendor_shipment\": {\n    \"tracking_number\": \"<string>\",\n    \"carrier\": \"<string>\",\n    \"shipped_at\": \"2023-11-07T05:31:56Z\",\n    \"note\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/purchase-orders/{id}/receive")

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  \"items\": [\n    {\n      \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity_received\": 123,\n      \"order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"po_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"damaged_qty\": 123,\n      \"damage_notes\": \"<string>\"\n    }\n  ],\n  \"create_bill\": true,\n  \"notes\": \"<string>\",\n  \"vendor_shipment\": {\n    \"tracking_number\": \"<string>\",\n    \"carrier\": \"<string>\",\n    \"shipped_at\": \"2023-11-07T05:31:56Z\",\n    \"note\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "idempotent": true,
  "message": "<string>",
  "receipt": {}
}

{
  "receipt": {},
  "auto_bill": {},
  "auto_bill_error": "<string>"
}

"<unknown>"

{
  "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"
}

Purchasing

Record a receipt against a purchase order

Records physical receipt of goods against a purchase order, creating inventory receive transactions and incrementing on-hand balances for each received line. Partial receipts are supported; the PO transitions to status: partially_received and finally to received when all lines are fully received.

Over-receipt tolerance (NEW-GAP-PO-RECEIVE-OVER-RECEIPT-ZERO-TOLERANCE-CONFLICTS-AP-5PCT, 2026-05-16): the receive cap is Math.floor(remaining * tolerance) where tolerance is resolved per-entity as settings.po_overreceipt_tolerance (dock-side knob) -> fall through to settings.ap_qty_tolerance (AP-side knob) -> default 1.05 (5%). Bodies whose quantity_received + damaged_qty > cap reject with HTTP 400 over_receipt_blocked and an envelope of { ordered, already_received, remaining, attempted, tolerance_pct, cap, hint }. Industry parity: NetSuite Over-Receipt Tolerance / Acumatica Receipt Tolerance / SAP B1 Goods Receipt over-tolerance all expose a single tolerance % governing both dock + 3-way match. Arcus exposes two knobs (dock falls through to AP) so entities can tighten dock control without affecting 3-way match.

Idempotency (NEW-GAP-AP-PO-RECEIVE-IDEMPOTENCY-GUARD, 2026-06-15): the receive is a financial mutation (inventory + GRNI + optional auto vendor bill). A server-side guard dedups an identical retry (same PO + same line set: product / qty / damaged_qty) within a 120-second window and returns the original receipt with HTTP 200 + idempotent: true and zero new side effects. A legitimately distinct follow-up partial (different qty / lines) still creates a new receipt. You may additionally send a standard Idempotency-Key header for cross-window safety.

Requires purchasing:write scope.

Drop-ship clamp (2026-07-10). Lines linked to a sales order (drop-ship) fulfill the customer directly: only the SO-matched quantity is processed (COGS + PO progress clamped to it). Receiving beyond the linked SO open quantity returns 422 dropship_receive_exceeds_so_open unless the body carries divert_to_stock: true, which deliberately receives the excess into warehouse stock (audited).

POST

purchase-orders

{id}

receive

Record a receipt against a purchase order

curl --request POST \
  --url https://api.arcuserp.com/v1/purchase-orders/{id}/receive \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "quantity_received": 123,
      "order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "po_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "damaged_qty": 123,
      "damage_notes": "<string>"
    }
  ],
  "create_bill": true,
  "notes": "<string>",
  "vendor_shipment": {
    "tracking_number": "<string>",
    "carrier": "<string>",
    "shipped_at": "2023-11-07T05:31:56Z",
    "note": "<string>"
  }
}
'

import requests

url = "https://api.arcuserp.com/v1/purchase-orders/{id}/receive"

payload = {
    "items": [
        {
            "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "quantity_received": 123,
            "order_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "po_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "damaged_qty": 123,
            "damage_notes": "<string>"
        }
    ],
    "create_bill": True,
    "notes": "<string>",
    "vendor_shipment": {
        "tracking_number": "<string>",
        "carrier": "<string>",
        "shipped_at": "2023-11-07T05:31:56Z",
        "note": "<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({
    items: [
      {
        product_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        quantity_received: 123,
        order_item_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        po_item_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        damaged_qty: 123,
        damage_notes: '<string>'
      }
    ],
    create_bill: true,
    notes: '<string>',
    vendor_shipment: {
      tracking_number: '<string>',
      carrier: '<string>',
      shipped_at: '2023-11-07T05:31:56Z',
      note: '<string>'
    }
  })
};

fetch('https://api.arcuserp.com/v1/purchase-orders/{id}/receive', 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/purchase-orders/{id}/receive",
  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([
    'items' => [
        [
                'product_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'quantity_received' => 123,
                'order_item_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'po_item_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'damaged_qty' => 123,
                'damage_notes' => '<string>'
        ]
    ],
    'create_bill' => true,
    'notes' => '<string>',
    'vendor_shipment' => [
        'tracking_number' => '<string>',
        'carrier' => '<string>',
        'shipped_at' => '2023-11-07T05:31:56Z',
        'note' => '<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/purchase-orders/{id}/receive"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity_received\": 123,\n      \"order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"po_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"damaged_qty\": 123,\n      \"damage_notes\": \"<string>\"\n    }\n  ],\n  \"create_bill\": true,\n  \"notes\": \"<string>\",\n  \"vendor_shipment\": {\n    \"tracking_number\": \"<string>\",\n    \"carrier\": \"<string>\",\n    \"shipped_at\": \"2023-11-07T05:31:56Z\",\n    \"note\": \"<string>\"\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/purchase-orders/{id}/receive")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity_received\": 123,\n      \"order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"po_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"damaged_qty\": 123,\n      \"damage_notes\": \"<string>\"\n    }\n  ],\n  \"create_bill\": true,\n  \"notes\": \"<string>\",\n  \"vendor_shipment\": {\n    \"tracking_number\": \"<string>\",\n    \"carrier\": \"<string>\",\n    \"shipped_at\": \"2023-11-07T05:31:56Z\",\n    \"note\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/purchase-orders/{id}/receive")

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  \"items\": [\n    {\n      \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity_received\": 123,\n      \"order_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"po_item_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"damaged_qty\": 123,\n      \"damage_notes\": \"<string>\"\n    }\n  ],\n  \"create_bill\": true,\n  \"notes\": \"<string>\",\n  \"vendor_shipment\": {\n    \"tracking_number\": \"<string>\",\n    \"carrier\": \"<string>\",\n    \"shipped_at\": \"2023-11-07T05:31:56Z\",\n    \"note\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "idempotent": true,
  "message": "<string>",
  "receipt": {}
}

{
  "receipt": {},
  "auto_bill": {},
  "auto_bill_error": "<string>"
}

"<unknown>"

{
  "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

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.

Headers

X-Location-Id

string<uuid>

Path Parameters

string<uuid>

required

Body

application/json

items

object[]

required

Show child attributes

create_bill

boolean

notes

string

vendor_shipment

object | null

DROP-SHIP "Mark shipped by vendor" (2026-07-11). For a drop-ship PO the receive IS the vendor-shipped event: supplying vendor_shipment captures the vendor's tracking and creates a real shipped package on the linked sales order so the customer shipment email carries a working tracking link. Tracking is OPTIONAL ("we might have a tracking"); with no tracking a package is still created and the email renders without a tracking block. carrier is required only when tracking_number is supplied.

Show child attributes

Response

Idempotent replay. The identical receive was already recorded within the dedup window; the original receipt is returned with no new side effects.

idempotent

boolean

message

string

receipt

object

Overview

All Endpoints

Record a receipt against a purchase order

Authorizations

Headers

Path Parameters

Body

Response