Get received documents list

1 import requests 2 3 url = "https://api.koywe.com/api/v1/billing/organizations/org_12345/merchants/mer_67890/received-documents" 4 5 querystring = {"page":"1","limit":"10","issuerTaxId":"12345678","receiverTaxId":"87654321","receiverName":"Company ABC","issuerName":"Company XYZ","amountLte":"1000","amountGte":"100","documentType":"invoice"} 6 7 headers = {"Authorization": "Bearer <token>"} 8 9 response = requests.get(url, headers=headers, params=querystring) 10 11 print(response.json())

1 { 2 "receivedDocuments": [ 3 { 4 "receivedDocumentId": 1.1, 5 "emailSubject": "emailSubject", 6 "senderEmail": "senderEmail", 7 "documentDate": "documentDate", 8 "receiveDate": "receiveDate", 9 "receivedDocumentStatus": 1.1, 10 "documentId": 1.1, 11 "issuerName": "issuerName", 12 "issuerTaxIdCode": "issuerTaxIdCode", 13 "issuerTaxIdType": "issuerTaxIdType", 14 "documentTypeId": 1.1, 15 "documentTypeTaxbureau": "documentTypeTaxbureau", 16 "documentNumber": 1.1, 17 "accountId": 1.1, 18 "purchaseOrder": "purchaseOrder", 19 "receptionConfirmationStatus": 1.1, 20 "receptionConfirmationDate": "receptionConfirmationDate", 21 "receiverTaxIdCode": "receiverTaxIdCode", 22 "receiverTaxIdType": "receiverTaxIdType", 23 "documentApprovalStatus": 1.1, 24 "documentApprovalDate": "documentApprovalDate", 25 "productReceiptStatus": 1.1, 26 "productReceiptDate": "productReceiptDate", 27 "productReceiptLocation": "productReceiptLocation", 28 "netAmount": "netAmount", 29 "totalAmount": "totalAmount", 30 "documentXml": "documentXml", 31 "documentPdf": "documentPdf", 32 "stampImg": "stampImg" 33 } 34 ], 35 "totalItems": 1.1, 36 "pageSize": 1.1, 37 "pageCount": 1.1, 38 "page": 1.1 39 }

Returns a paginated list of received documents with filtering options

Path parameters

merchantIdstringRequired

Merchant ID

organizationIdstringRequired

Organization ID

Query parameters

pagestringOptional

Page number for pagination

limitstringOptional

Number of items per page

issuerTaxIdstringOptional

Filter by issuer tax ID

receiverTaxIdstringOptional

Filter by receiver tax ID

receiverNamestringOptional

Filter by receiver name

issuerNamestringOptional

Filter by issuer name

amountLtedoubleOptional

Filter by amount less than or equal to

amountGtedoubleOptional

Filter by amount greater than or equal to

documentTypestringOptional

Filter by document type

Response

Returns a paginated list of received documents with details including issuer, receiver, items, totals and document status

receivedDocumentslist of objects

List of paginated received documents

totalItemsdouble

Total number of items across all pages

pageSizedouble

Number of items per page

pageCountdouble

Total number of pages

pagedouble

Current page number

Get received documents list

Path parameters

Headers

Query parameters

Response

Errors