Skip to main content
POST
/
payments
/
multi-invoice-apply
Apply a single payment to multiple invoices (atomic create)
curl --request POST \
  --url https://api.arcuserp.com/v1/payments/multi-invoice-apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payment_method": "check",
  "amount": 5000,
  "applications": [
    {
      "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount_applied": 2500
    }
  ],
  "check_number": "<string>",
  "check_date": "2023-12-25",
  "external_reference": "<string>",
  "notes": "<string>",
  "payment_date": "2023-12-25"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "amount": 123,
    "payment_method": "<string>",
    "status": "<string>",
    "journal_entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "applied_count": 123,
    "applications": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount_applied": 123
      }
    ]
  },
  "idempotent_replay": 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.

Headers

​
Idempotency-Key
string

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.

Maximum string length: 255

Body

application/json
​
account_id
string<uuid>
required

The customer account receiving this payment.

​
payment_method
enum<string>
required

Tender method for this payment.

Available options:
check,
ach,
wire,
external,
cash,
credit
​
amount
number
required

Total payment amount in dollars. Must equal sum of applications[].amount_applied within $0.005.

Example:

5000

​
applications
object[]
required

Per-invoice application lines. Sum of amount_applied must equal amount.

Required array length: 1 - 50 elements
​
check_number
string

Check number (for check payments).

​
check_date
string<date>

Check date (YYYY-MM-DD).

​
external_reference
string

External reference (ACH trace number, wire memo, etc.).

​
notes
string

Internal notes for this payment.

​
payment_date
string<date>

Payment date for GL posting (YYYY-MM-DD; defaults to today).

Response

Payment applied successfully

​
data
object
​
idempotent_replay
boolean