Skip to main content
POST
/
vendors
/
{id}
/
prepayments
Record a vendor prepayment
curl --request POST \
  --url https://api.arcuserp.com/v1/vendors/{id}/prepayments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 5000,
  "payment_method": "check",
  "payment_date": "2026-05-14",
  "note": "PO 4821 advance -- 50% deposit required by vendor"
}
'
{
  "data": {
    "prepayment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "prepayment_number": "VPREP-0000001",
    "amount": 123,
    "applied_amount": 123,
    "balance": 123,
    "status": "active",
    "payment_method": "<string>",
    "payment_date": "2023-11-07T05:31:56Z",
    "journal_entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

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<uuid>

Optional idempotency key. Re-POST with same key returns cached 201 without re-processing.

Path Parameters

​
id
string<uuid>
required

Vendor account UUID (account_type must be 'vendor').

Body

application/json
​
amount
number<double>
required

Prepayment amount in entity currency. Must be > 0.

Required range: x >= 0.01
​
payment_method
enum<string>
required

Tender method used for the advance payment.

Available options:
cash,
check,
card,
ach,
external,
wire,
other
​
payment_date
string<date> | null

Effective date for the journal entry. Defaults to today if omitted.

​
note
string | null

Optional free-text note (reference number, reason for advance, etc.).

​
payment_method_id
string<uuid> | null

Optional reference to an account_payment_methods row.

​
bank_account_id
string<uuid> | null

Optional bank account reference for ACH / wire payments.

​
idempotency_key
string<uuid> | null

Alternative idempotency key in body (header takes precedence).

Response

Vendor prepayment recorded

​
data
object