Get tax document details

1 curl -G https://api-test.koywe.com/api/v1/billing/organizations/org_12345/merchants/mer_67890/documents/doc_xyz789 \ 2 -H "Authorization: Bearer <token>" \ 3 --data-urlencode expand=[contact,country]

1 { 2 "documentId": "documentId", 3 "header": { 4 "documentTypeId": "documentTypeId", 5 "documentTypeTaxbureau": "documentTypeTaxbureau", 6 "documentNumber": 1.1, 7 "receivedIssuedFlag": true, 8 "taxbureauValidationStatus": 1.1, 9 "issueDate": "issueDate", 10 "issuerTaxIdCode": "issuerTaxIdCode", 11 "issuerTaxIdType": "issuerTaxIdType", 12 "issuerLegalName": "issuerLegalName", 13 "issuerAddress": "issuerAddress", 14 "issuerDistrict": "issuerDistrict", 15 "issuerCity": "issuerCity", 16 "issuerState": "issuerState", 17 "issuerCountry": "issuerCountry", 18 "issuerPhone": "issuerPhone", 19 "issuerActivity": "issuerActivity", 20 "issuerPostalcode": "issuerPostalcode", 21 "receiverTaxIdCode": "receiverTaxIdCode", 22 "receiverTaxIdType": "receiverTaxIdType", 23 "receiverLegalName": "receiverLegalName", 24 "receiverAddress": "receiverAddress", 25 "receiverDistrict": "receiverDistrict", 26 "receiverCity": "receiverCity", 27 "receiverState": "receiverState", 28 "receiverCountry": "receiverCountry", 29 "receiverPhone": "receiverPhone", 30 "receiverActivity": "receiverActivity", 31 "receiverPostalcode": "receiverPostalcode", 32 "paymentConditions": "paymentConditions", 33 "currencySymbol": "currencySymbol", 34 "transportationDocType": 1.1, 35 "transportationDocBilling": 1.1, 36 "taxPeriodMonth": 1.1, 37 "taxPeriodYear": 1.1, 38 "documentStatus": 1.1, 39 "taxbureauSendId": 1.1, 40 "taxbureauSendDate": "taxbureauSendDate", 41 "taxbureauSendStatus": 1.1, 42 "taxbureauValidationComments": "taxbureauValidationComments", 43 "saleModality": 1.1, 44 "saleClause": 1.1, 45 "contactId": "contactId", 46 "contact": { 47 "id": "con_a627a569-51c4-4fc4-ace6-a43482f1b08b", 48 "countrySymbol": "AR", 49 "merchantId": "mer_84b8b218-2777-4e7f-863e-7d0601ac289f", 50 "firstName": "Mariano", 51 "lastName": "Romero", 52 "email": "mariano.romero@row.com", 53 "phone": "0116644624", 54 "address": { 55 "addressLine1": "San Martín 123", 56 "addressLine2": "Belgrano 222", 57 "city": "CABA", 58 "state": "Buenos Aires", 59 "postalCode": "1419", 60 "stateId": "st_a627a569-51c4-4fc4-ace6-a43482f1b08b", 61 "countyId": "cnt_a627a569-51c4-4fc4-ace6-a43482f1b08b" 62 }, 63 "businessType": "PERSON", 64 "tax": { 65 "taxIdType": "DNI", 66 "taxIdNumber": "123456789" 67 }, 68 "document": { 69 "documentType": "DNI", 70 "documentNumber": "123456789" 71 }, 72 "createdAt": "2024-09-03T15:47:03Z", 73 "updatedAt": "2024-09-03T15:47:03Z", 74 "externalId": "ext_a627a569-51c4-4fc4-ace6-a43482f1b08b", 75 "documents": [ 76 { 77 "id": "cdoc_a627a569-51c4-4fc4-ace6-a43482f1b08b", 78 "documentType": "DNI", 79 "documentNumber": "12345678", 80 "isDefault": true, 81 "isCompany": false 82 } 83 ] 84 } 85 }, 86 "details": [ 87 { 88 "quantity": 1.1, 89 "lineDescription": "lineDescription", 90 "unitMeasure": "unitMeasure", 91 "unitPrice": 1.1, 92 "vatStatus": true, 93 "taxTypeId": 1.1, 94 "taxAmount": 1.1, 95 "longDescription": "longDescription", 96 "modifierAmount": 1.1, 97 "totalTaxes": 1.1, 98 "modifierPercentage": 1.1, 99 "totalNetAmount": 1.1, 100 "totalAmountLine": 1.1, 101 "sku": "sku", 102 "taxes": [ 103 "taxes" 104 ] 105 } 106 ], 107 "totals": { 108 "key": "value" 109 }, 110 "electronicDocument": { 111 "documentXml": "documentXml", 112 "documentPdf": "documentPdf", 113 "stampImg": "stampImg" 114 }, 115 "references": [ 116 { 117 "documentTypeId": "documentTypeId", 118 "documentTypeTaxbureau": "documentTypeTaxbureau", 119 "referenceNumber": "referenceNumber", 120 "issueDate": "issueDate", 121 "referenceType": 1.1, 122 "description": "description" 123 } 124 ], 125 "paymentLink": { 126 "key": "value" 127 } 128 }

Returns the details of a specific tax document

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path Parameters

merchantIdstringRequired

Merchant ID

documentIdstringRequired

Document ID

organizationIdstringRequired

Organization ID

Query Parameters

expandstringOptional

Comma-separated list of fields to expand.

Response

Returns the details of a specific tax document with details including issuer, receiver, items, totals and associated electronic documents

documentIdstring

headerobject

detailslist of objects

totalsmap from strings to any

electronicDocumentobject

referenceslist of objects or null

paymentLinkmap from strings to any or null

Get tax document details

Authentication

Path Parameters

Headers

Query Parameters

Response

Errors