Skip to main content
POST
/
ap-payments
Create an AP payment
curl --request POST \
  --url https://api.arcuserp.com/v1/ap-payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 123,
  "payment_method": "check",
  "bill_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "vendor_credit_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "payment_date": "2023-12-25",
  "reference_number": "<string>",
  "notes": "<string>",
  "suppress_gl": true,
  "skip_plaid": true,
  "idempotency_key": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "ap_payment",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "bill_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "method": "check",
  "amount": 123,
  "currency": "USD",
  "reference": "<string>",
  "status": "pending",
  "payment_date": "2023-12-25",
  "cleared_date": "2023-12-25",
  "notes": "<string>",
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z"
}

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-provided idempotency key. Requires migration:write scope.

Maximum string length: 64

Body

application/json
​
vendor_id
string<uuid>
required
​
amount
number
required
​
payment_method
enum<string>
required
Available options:
check,
ach,
wire,
credit_card,
cash,
other
​
bill_ids
string<uuid>[]
required
​
vendor_credit_ids
string<uuid>[]
​
payment_date
string<date>
​
reference_number
string
​
notes
string
​
suppress_gl
boolean

migration:write scope required. Skip cash/check GL posting for historical import.

​
skip_plaid
boolean

migration:write scope required. Skip Plaid ACH initiation for historical payment import.

​
idempotency_key
string

migration:write scope required. Client-provided idempotency key stored on ap_payments row.

Maximum string length: 64

Response

Created AP payment

A payment Arcus made to a vendor (AP-side).

​
id
string<uuid>
​
object
enum<string>
Available options:
ap_payment
​
entity_id
string<uuid>
read-only
​
vendor_id
string<uuid>
​
bill_id
string<uuid> | null

Set when payment is applied to a single bill; null for batch/on-account.

​
batch_id
string<uuid> | null
​
method
enum<string>
Available options:
check,
ach,
wire,
credit_card,
cash,
other
​
amount
number
​
currency
string
default:USD
​
reference
string | null

Check number, ACH trace, etc.

​
status
enum<string>
read-only
Available options:
pending,
sent,
cleared,
voided,
returned
​
payment_date
string<date>
​
cleared_date
string<date> | null
​
notes
string | null
​
metadata
object
​
created_at
string<date-time>
read-only