Skip to main content
GET
/
vendors
/
{id}
/
prepayments
List vendor prepayments
curl --request GET \
  --url https://api.arcuserp.com/v1/vendors/{id}/prepayments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "prepayment_number": "<string>",
      "amount": 123,
      "applied_amount": 123,
      "balance": 123,
      "status": "<string>",
      "payment_method": "<string>",
      "payment_date": "2023-11-07T05:31:56Z",
      "note": "<string>",
      "journal_entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "vendor_name": "<string>"
    }
  ],
  "meta": {
    "count": 123,
    "total_unapplied_balance": 123
  }
}

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.

Path Parameters

id
string<uuid>
required

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

Query Parameters

status
enum<string>

Filter by prepayment status.

Available options:
active,
partially_applied,
fully_applied,
refunded,
voided

Response

Vendor prepayments list

data
object[]
meta
object