Overview
The main function of the eInvoicing solution is registration of the issued documents with tax authority. There are multiple types of documents supported by the solution and this API allows taxpayer ERP systems to retrieve their definitions through API call.
Signature
API is REST based API that does not take additional URL parameters, yet it returns the list of active and deactivated document types that were once active.
Signature:
GET /api/v1.0/documenttypes
Inputs
This API accepts standard eInvoicing API header parameters for authenticated call.
No additional URL or request body parameters are provided to this API.
Outputs
Successful Response
API returns HTTP status code 200.
The resulting structure is part of a single object result that includes list of DocumentType elements.
Document Type contains:
| Output parameter | Type | Description | Value example |
|---|---|---|---|
| id | Number | Unique identifier of the document type | 45 |
| name | String | Unique name of the document type | i (for invoice), c (for credit note), d (for debit note) |
| description | String | Description of the document type | Credit note |
| activeFrom | Date | Date when the activity of the document type started | 2015-02-13T13:15Z |
| activeTo | Date | Optional: date when the activity of the document type ends | 2027-03-01T00:00:00Z |
| documentTypeVersions | Document Type Version[] | Array of document type version summary objects | 1 or more array values |
Document Type Version contains:
| Output parameter | Type | Description | Value example |
|---|---|---|---|
| id | Number | Unique identifier of the document type version | 454 |
| name | String | Name of the document type version within the document type | 1.0 |
| description | String | Description of the document type version | Credit note version 1.1 |
| versionNumber | Decimal | Unique version number of the document type version | 1.1 |
| status | String | Status of the document type version - “published”, “deactivated” | published |
| activeFrom | Date | Date when the activity of the document type version started | 2015-02-13T13:15Z |
| activeTo | Date | Optional: date when the activity of the document type version sends/when it was deactivated | 2027-03-01T00:00:00Z |
Error Response
Error situations are reported back by this API through the standard error response.
No custom error codes are provided by this API.
Additional considerations
When document type list is returned to caller, they can query more detailed information about document type or document type version using returned internal identifiers.