Create a manual ledger adjustment

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Path Parameters

customerId*string

Customer/Client UUID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

transactionType*string

Transaction type - DEBIT or CREDIT

Value in

"DEBIT"
"CREDIT"

amount*number

Adjustment amount (positive)

description*string

Description/reason for adjustment

entryDate*string

Entry date

Formatdate-time

reason?string

Reason category

appliesToDocumentId?string

Document ID this adjustment applies to

metadata?

Additional metadata

Response Body

`application/json`

curl -X POST "https://example.com/customers/string/ledger/manual-adjustment" \  -H "Content-Type: application/json" \  -d '{    "transactionType": "CREDIT",    "amount": 50,    "description": "Goodwill credit for service issue",    "entryDate": "2025-01-25"  }'

{  "id": "550e8400-e29b-41d4-a716-446655440000",  "entryDate": "2025-01-15",  "entryType": "INVOICE",  "transactionType": "DEBIT",  "documentNumber": "INV-60001",  "description": "Tax Invoice #60001",  "debitAmount": 1180,  "creditAmount": 500,  "runningBalance": 680,  "currency": "ILS",  "document": {},  "allocations": [],  "createdAt": "2025-01-15T10:30:00.000Z"}