VUZDevelopers

Get linked documents (parent and children)

GET
/documents/{id}/linked

Returns parent document and all linked documents (conversions) for a given document.

Response includes:

  • Parent document (if this document was converted from another)
  • Linked documents (documents converted from this one)
  • Outstanding amount (for invoices)
  • Payment status

Use Cases:

  • Display document conversion history in UI
  • Track invoice payment status
  • Show document relationships
  • Calculate outstanding balances

Example Response:

{  "parent": {    "id": "...",    "type": "quote",    "number": "QT-2025-001",    "total": 1170.00  },  "linked": [    {      "id": "...",      "type": "invoice",      "number": "INV-2025-001",      "total": 1170.00,      "date": "2025-01-15",      "status": "issued",      "outstandingAmount": 500.00    }  ],  "outstandingAmount": 0,  "isFullyPaid": true}

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 ID

Response Body

application/json

application/json

curl -X GET "https://example.com/documents/660e8400-e29b-41d4-a716-446655440000/linked"
{  "parent": {    "id": "660e8400-e29b-41d4-a716-446655440000",    "type": "quote",    "number": "QT-2025-001",    "total": 1170  },  "linked": [    {      "id": "660e8400-e29b-41d4-a716-446655440001",      "type": "invoice",      "number": "INV-2025-001",      "total": 1170,      "date": "2025-01-15",      "status": "issued",      "outstandingAmount": 0    }  ],  "outstandingAmount": 500,  "isFullyPaid": false}