VUZDevelopers

Get all documents for a specific client

GET
/clients/{id}/documents

Retrieves all documents (invoices, receipts, quotes, etc.) for a specific client with comprehensive filtering and pagination.

Filtering Options:

  • docType: Filter by document type (invoice, receipt, tax_invoice_receipt, quote, etc.)
  • status: Filter by document status (draft, issued, paid, canceled, etc.)
  • fromDate: Filter documents from this date (inclusive)
  • toDate: Filter documents until this date (inclusive)
  • docNumber: Search by document number (partial match)
  • page, limit: Pagination parameters
  • sortBy: Sort field (issueDate, createdAt, docNumber, grandTotal)
  • sortOrder: ASC or DESC

Cascading Filters: If only clientId is provided, returns ALL documents for that client. Additional filters narrow down the results progressively.

Use Cases:

  • Client document history page
  • Filter invoices vs receipts for a client
  • Find specific document by number
  • View documents in date range
  • Show outstanding/unpaid documents

Example Queries:

  • All documents: GET /api/v1/clients/:id/documents
  • Only invoices: GET /api/v1/clients/:id/documents?docType=invoice
  • Issued in 2025: GET /api/v1/clients/:id/documents?fromDate=2025-01-01&toDate=2025-12-31
  • Unpaid invoices: GET /api/v1/clients/:id/documents?docType=invoice&status=issued

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

Client unique identifier (UUID)

Query Parameters

docType?string

Filter by document type (e.g., invoice, receipt, tax_invoice_receipt)

status?string

Filter by document status

Value in

  • "draft"
  • "issued"
  • "partially_paid"
  • "paid"
  • "expired"
  • "converted"
  • "canceled"
fromDate?string

Filter documents from this date (ISO format)

toDate?string

Filter documents until this date (ISO format)

docNumber?string

Search by document number

page?number

Page number

Default1
limit?number

Number of items per page

Default10
sortBy?string

Sort by field (e.g., issueDate, createdAt, docNumber)

Default"issueDate"
sortOrder?string

Sort order

Default"DESC"

Value in

  • "ASC"
  • "DESC"

Response Body

application/json

application/json

curl -X GET "https://example.com/clients/770e8400-e29b-41d4-a716-446655440000/documents"
{  "items": [    {      "id": "880e8400-e29b-41d4-a716-446655440000",      "createdAt": "2025-11-09T09:31:07.507Z",      "updatedAt": "2025-11-09T09:31:07.523Z",      "deletedAt": null,      "docType": "quote",      "docNumber": null,      "status": "draft",      "issueDate": "2025-11-09",      "issueTime": "14:32:07",      "documentDate": "2025-11-05",      "dueDate": "2025-12-09",      "documentDatePeriodClosed": true,      "backdateAckAt": "2019-08-24T14:15:22Z",      "backdateAckByUserId": "7009be0c-f167-48ba-92d0-be39eb8a403b",      "paymentTermsId": "990e8400-e29b-41d4-a716-446655440000",      "paymentTermsText": "שוטף + 30",      "currency": "ILS",      "fxRate": null,      "vatMode": "exclusive",      "vatRateDefault": 17,      "subTotal": "150.00",      "vatTotal": "25.50",      "grandTotal": "175.50",      "clientName": null,      "clientTaxId": null,      "clientAddress": null,      "notes": null,      "metadata": null,      "originalDocumentId": null,      "parentDocumentId": null,      "cancelledByDocumentId": null,      "pdfPath": null,      "publicSlug": "j3AxtCjwHS",      "isPublicEnabled": true,      "clientPhoneSnapshot": "+972522456789",      "branchId": "string",      "branchName": "string",      "parentClientName": "string",      "signedAt": null,      "signatureImagePath": null,      "signatureName": null,      "signatureNote": null,      "outstandingAmount": null,      "paidAt": null,      "paymentStatus": "UNPAID",      "documentBalance": 1000,      "totalPaymentsReceived": 0,      "totalCreditsApplied": 0,      "roundingAdjustment": -0.01,      "paymentStatusUpdatedAt": null,      "paymentLinkUrl": "https://pay.vuz.co.il/abc123def456",      "paymentLinkId": "990e8400-e29b-41d4-a716-446655440000",      "paymentLinkStatus": "active",      "paymentLinkExpiresAt": "2025-12-25T00:00:00.000Z",      "isClosed": false,      "closedAt": null,      "closedBy": null,      "isInteractive": false,      "interactiveStatus": "negotiation",      "publicToken": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",      "publicTokenExpiresAt": "2025-12-25T00:00:00.000Z",      "negotiationVersion": 1,      "business": {        "id": "50596d36-8006-4aeb-a29e-ca78edddb2df",        "businessName": "אקו דב",        "ownerPhone": "972527253023",        "vatRate": 18,        "currency": "ILS",        "vatNumber": "300160629",        "logoPath": null,        "address": null,        "email": "naor@echo-dev.co.il",        "businessMeta": {          "logoUrl": "/uploads/logos/fd32d6f3-f790-4999-b30a-df360993123b.jpg"        },        "userId": "45b9de13-426f-45f8-98f8-a8a8961acf34",        "isActive": true,        "isOnTrial": true,        "trialEndDate": "2025-11-11"      },      "businessId": "50596d36-8006-4aeb-a29e-ca78edddb2df",      "client": {        "id": "3c3e3b30-924b-4a9f-9fbc-516010d36427",        "name": "אקסיומה",        "type": "company_ltd",        "email": "yosi@exioma.co.il",        "phone": "0522456789",        "address": "צנחנים 1 רעננה",        "vatNumber": "111111111",        "contactPerson": "יוסי בוכניק",        "notes": "",        "isActive": true,        "userId": "45b9de13-426f-45f8-98f8-a8a8961acf34",        "businessId": "50596d36-8006-4aeb-a29e-ca78edddb2df"      },      "clientId": "3c3e3b30-924b-4a9f-9fbc-516010d36427",      "createdBy": null,      "updatedBy": null,      "origin": "web",      "originName": "vuz",      "items": [        {          "id": "990e8400-e29b-41d4-a716-446655440000",          "lineNo": 1,          "description": "ייעוץ עסקי - 10 שעות",          "quantity": "10.000",          "unit": "שעות",          "unitPrice": "150.00",          "discountPercent": "0.00",          "vatApplicable": true,          "vatRate": 17,          "lineSubTotal": "150.00",          "lineVatTotal": "25.50",          "lineGrandTotal": "175.50",          "createdAt": "2025-11-09T09:31:07.518Z",          "updatedAt": "2025-11-09T09:31:07.518Z",          "deletedAt": null,          "documentId": "25cd5cfb-8e24-4dd6-b564-0b3c06cb9056"        }      ],      "payments": [        {          "id": "990e8400-e29b-41d4-a716-446655440000",          "paymentMethod": "cash",          "paymentProvider": "string",          "amount": 500,          "paymentDate": "2025-11-09",          "notes": "Payment for invoice #123",          "referenceNumber": "REF-12345",          "bankNumber": "12",          "branchNumber": "456",          "accountNumber": "123456789",          "checkNumber": "123456",          "dueDate": "2025-02-15",          "creditCompanyCode": 2,          "cardName": "Visa",          "cardLastDigits": "1234",          "creditTransactionType": 1,          "numberOfInstallments": 3,          "tranzilaTransactionId": "6982",          "tranzilaAuthCode": "0672865"        }      ],      "aiSummaryData": {}    }  ],  "total": 15,  "page": 1,  "limit": 10}