Get tax document details

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

{
  "documentId": "documentId",
  "header": {
    "documentTypeId": "documentTypeId",
    "documentTypeTaxbureau": "documentTypeTaxbureau",
    "documentNumber": 1.1,
    "receivedIssuedFlag": true,
    "taxbureauValidationStatus": 1.1,
    "issueDate": "issueDate",
    "issuerTaxIdCode": "issuerTaxIdCode",
    "issuerTaxIdType": "issuerTaxIdType",
    "issuerLegalName": "issuerLegalName",
    "issuerAddress": "issuerAddress",
    "issuerDistrict": "issuerDistrict",
    "issuerCity": "issuerCity",
    "issuerState": "issuerState",
    "issuerCountry": "issuerCountry",
    "issuerPhone": "issuerPhone",
    "issuerActivity": "issuerActivity",
    "issuerPostalcode": "issuerPostalcode",
    "receiverTaxIdCode": "receiverTaxIdCode",
    "receiverTaxIdType": "receiverTaxIdType",
    "receiverLegalName": "receiverLegalName",
    "receiverAddress": "receiverAddress",
    "receiverDistrict": "receiverDistrict",
    "receiverCity": "receiverCity",
    "receiverState": "receiverState",
    "receiverCountry": "receiverCountry",
    "receiverPhone": "receiverPhone",
    "receiverActivity": "receiverActivity",
    "receiverPostalcode": "receiverPostalcode",
    "paymentConditions": "paymentConditions",
    "currencySymbol": "currencySymbol",
    "transportationDocType": 1.1,
    "transportationDocBilling": 1.1,
    "taxPeriodMonth": 1.1,
    "taxPeriodYear": 1.1,
    "documentStatus": 1.1,
    "taxbureauSendId": 1.1,
    "taxbureauSendDate": "taxbureauSendDate",
    "taxbureauSendStatus": 1.1,
    "taxbureauValidationComments": "taxbureauValidationComments",
    "saleModality": 1.1,
    "saleClause": 1.1,
    "contactId": "contactId",
    "contact": {
      "id": "con_a627a569-51c4-4fc4-ace6-a43482f1b08b",
      "countrySymbol": "AR",
      "merchantId": "mer_84b8b218-2777-4e7f-863e-7d0601ac289f",
      "firstName": "Mariano",
      "lastName": "Romero",
      "email": "mariano.romero@row.com",
      "phone": "0116644624",
      "address": {
        "addressLine1": "San Martín 123",
        "addressLine2": "Belgrano 222",
        "city": "CABA",
        "state": "Buenos Aires",
        "postalCode": "1419",
        "stateId": "st_a627a569-51c4-4fc4-ace6-a43482f1b08b",
        "countyId": "cnt_a627a569-51c4-4fc4-ace6-a43482f1b08b"
      },
      "businessType": "PERSON",
      "tax": {
        "taxIdType": "DNI",
        "taxIdNumber": "123456789"
      },
      "document": {
        "documentType": "DNI",
        "documentNumber": "123456789"
      },
      "createdAt": "2024-09-03T15:47:03Z",
      "updatedAt": "2024-09-03T15:47:03Z",
      "externalId": "ext_a627a569-51c4-4fc4-ace6-a43482f1b08b",
      "documents": [
        {
          "id": "cdoc_a627a569-51c4-4fc4-ace6-a43482f1b08b",
          "documentType": "DNI",
          "documentNumber": "12345678",
          "isDefault": true,
          "isCompany": false
        }
      ],
      "dateOfBirth": "1990-01-15T00:00:00Z",
      "documentExpirationDate": "2030-12-31T00:00:00Z",
      "nationalityCountryId": "ctry_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "nationalityCountry": {
        "key": "value"
      }
    }
  },
  "details": [
    {
      "quantity": 1.1,
      "lineDescription": "lineDescription",
      "unitMeasure": "unitMeasure",
      "unitPrice": 1.1,
      "vatStatus": true,
      "taxTypeId": 1.1,
      "taxAmount": 1.1,
      "longDescription": "longDescription",
      "modifierAmount": 1.1,
      "totalTaxes": 1.1,
      "modifierPercentage": 1.1,
      "totalNetAmount": 1.1,
      "totalAmountLine": 1.1,
      "sku": "sku",
      "taxes": [
        "taxes"
      ]
    }
  ],
  "totals": {
    "key": "value"
  },
  "electronicDocument": {
    "documentXml": "documentXml",
    "documentPdf": "documentPdf",
    "stampImg": "stampImg"
  },
  "references": [
    {
      "documentTypeId": "documentTypeId",
      "documentTypeTaxbureau": "documentTypeTaxbureau",
      "referenceNumber": "referenceNumber",
      "issueDate": "issueDate",
      "referenceType": 1.1,
      "description": "description"
    }
  ],
  "paymentLink": {
    "key": "value"
  }
}

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

paymentLinkmap from strings to any

Errors

401

Get Document Request Unauthorized Error

403

Get Document Request Forbidden Error

404

Get Document Request Not Found Error

500

Get Document Request Internal Server Error