Get tax documents list

1 curl -G https://api.koywe.com/api/v1/billing/organizations/org_12345/merchants/mer_67890/documents \ 2 -H "Authorization: Bearer <token>" \ 3 -d page=1 \ 4 -d limit=10 \ 5 -d dateFrom=2024-01-01 \ 6 -d dateTo=2024-12-31 \ 7 -d sendingStatus=sent \ 8 -d validationStatus=validated \ 9 -d documentType=invoice \ 10 -d documentNumber=INV-001 \ 11 -d received=true \ 12 -d receiverTaxIdCode=12345678 \ 13 -d orderBy=createdAt

1 { 2 "documents": [ 3 { 4 "documentId": "documentId", 5 "taxbureauSendingStatus": "taxbureauSendingStatus", 6 "issueDate": "issueDate", 7 "documentNumber": "documentNumber", 8 "documentTypeId": "documentTypeId", 9 "issuerTaxIdCode": "issuerTaxIdCode", 10 "issuerTaxIdType": "issuerTaxIdType", 11 "receiverTaxIdCode": "receiverTaxIdCode", 12 "receiverTaxIdType": "receiverTaxIdType", 13 "documentStatus": 1.1, 14 "currencySymbol": "currencySymbol", 15 "received": true, 16 "netAmount": 1.1, 17 "taxesAmount": 1.1, 18 "totalAmount": 1.1, 19 "documentTypeTaxbureau": "documentTypeTaxbureau", 20 "taxbureauValidationStatus": 1.1 21 } 22 ], 23 "totalItems": 1.1, 24 "pageSize": 1.1, 25 "pageCount": 1.1, 26 "page": 1.1, 27 "links": { 28 "self": "/api/v2/documents?page=2", 29 "first": "/api/v2/documents?page=1", 30 "last": "/api/v2/documents?page=10", 31 "next": "/api/v2/documents?page=3" 32 } 33 }

Returns a paginated list of tax documents with filtering options

Path parameters

merchantIdstringRequired

Merchant ID

organizationIdstringRequired

Organization ID

Query parameters

pagedoubleOptional

Page number for pagination

limitdoubleOptional

Number of items per page

dateFromstringOptional

Filter documents from this date

dateTostringOptional

Filter documents until this date

sendingStatusstringOptional

Filter by sending status

validationStatusstringOptional

Filter by validation status

documentTypestringOptional

Filter by document type

documentNumberstringOptional

Filter by document number

receivedbooleanOptional

Filter by received status

receiverTaxIdCodestringOptional

Filter by receiver tax ID code

orderBystringOptional

Order results by field

Response

Returns a paginated list of tax documents with details including issuer, receiver, items, totals and associated electronic documents

documentslist of objects

List of paginated documents

totalItemsdouble

Total number of items across all pages

pageSizedouble

Number of items per page

pageCountdouble

Total number of pages

pagedouble

Current page number

linksmap from strings to any

Navigation links for pagination

Get tax documents list

Path parameters

Headers

Query parameters

Response

Errors