API documentation
Operation reference
Every operation a machine credential can call: parameters, body, responses and an example in five languages. Generated from the OpenAPI contract the API serves at /openapi.yaml.
Fiscal documents
Synchronous Normal Sale issuance, copies, receipt representations, the electronic journal and the turnover report.
- post/v1/fiscal-documentsIssue a Normal Sale receipt
- get/v1/fiscal-documentsSearch the journal
- get/v1/fiscal-documents/exportExport the journal (CSV)
- post/v1/fiscal-documents/{fiscalDocumentId}/copiesIssue a copy
- get/v1/fiscal-documents/{fiscalDocumentId}Read a document
- get/v1/fiscal-documents/turnover-reportTurnover report
- get/v1/fiscal-documents/turnover-report/exportExport the turnover report (CSV)
- get/v1/fiscal-documents/{fiscalDocumentId}/representations/{representationFormat}Fetch a receipt representation
Refunds
Full or partial refund of a receipt BokaPOS issued, with the automatic copy when cash is returned.
Advances
A server-managed advance chain: Advance Sales, cancelling an erroneous advance and closing with the final Sale.
- get/v1/advance-casesList advance cases
- post/v1/advance-casesOpen an advance case
- get/v1/advance-cases/{advanceCaseId}Read an advance case
- post/v1/advance-cases/{advanceCaseId}/paymentsFiscalize an advance payment
- post/v1/advance-cases/{advanceCaseId}/cancellationsCancel the latest advance
- post/v1/advance-cases/{advanceCaseId}/closeClose an advance case
Proforma and Training
The bounded workflow for Proforma and Training documents, with a refund that must repeat the whole source document.
Receipt delivery by e-mail
Sending a fiscalized receipt to the customer from the platform, with the verification link and PDF attachments (E-mail module).
Operations
The durable state of one fiscal operation, without contacting the V-PFR.
Catalogue
Products and services with price, unit of measure, GTIN and tax labels; CSV import and export.
Tax rates
The current tax labels and rates the V-PFR returns for the exact security element of the premise.
Taxpayers and premises
The taxpayer and business-premise identifiers every fiscal request carries. They are created in the portal; the API reads them.
Security elements
Safe certificate metadata (JID, validity, status) without secrets. For monitoring expiry and environment.
Licence
Licence state and enabled modules, so a system knows in advance whether production is allowed.
Runtime
The ESIR identity, version and fiscal-adapter readiness as seen by your credential.