Skip to main content
POST
/
vendor-prepayments
/
{id}
/
apply
Apply a vendor prepayment to a bill
curl --request POST \
  --url https://api.arcuserp.com/v1/vendor-prepayments/{id}/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bill_id": "b1234567-0000-0000-0000-000000000001",
  "amount": 2500
}
'
{
  "data": {
    "application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "prepayment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "prepayment_number": "<string>",
    "prepayment_balance": 123,
    "bill_balance_due": 123,
    "amount_applied": 123,
    "journal_entry_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.

Path Parameters

​
id
string<uuid>
required

Vendor prepayment UUID.

Body

application/json
​
bill_id
string<uuid>
required

UUID of the vendor bill to apply the prepayment against.

​
amount
number<double> | null

Amount to apply. If omitted, applies min(prepayment.balance, bill.balance_due).

Response

Prepayment applied to bill

​
data
object