VUZDevelopers

Get payment summary for a document

GET
/documents/{id}/payment-summary

Retrieves the payment summary for a document including payment status, balance, and totals.

Response Includes:

  • Grand total of the document
  • Total payments received (from linked receipts)
  • Total credits applied (from credit notes)
  • Outstanding document balance
  • Current payment status (UNPAID, PARTIALLY_PAID, PAID, OVERPAID, CANCELLED)

Use Cases:

  • Displaying payment information in the UI
  • Pre-filling payment amounts
  • Checking outstanding balances
  • Financial reporting and reconciliation

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

id*string

Document unique identifier (UUID)

Response Body

application/json

application/json

curl -X GET "https://example.com/documents/880e8400-e29b-41d4-a716-446655440000/payment-summary"
{  "documentId": "880e8400-e29b-41d4-a716-446655440000",  "grandTotal": 1000,  "totalPaymentsReceived": 600,  "totalCreditsApplied": 0,  "documentBalance": 400,  "paymentStatus": "PARTIALLY_PAID"}