API reference
The invoicing API lives at https://api.flashpi.com.ec. Its OpenAPI 3.1 document describes every endpoint, field, answer and webhook event, with examples, and is the source of the SDK models. The pages under Endpoints (v1) are generated from that document on every build of these docs, so they always say what the API does.
Endpoints (v1)The overview of the invoicing API: authentication and every operation, with its parameters, request body, answers and a code sample.
| Area | Endpoints |
|---|---|
| Status | GET /v1/status |
| Issuers | /v1/issuers, its establishments and their emission-points |
| Issuer onboarding | POST /v1/issuer-onboardings, /v1/issuer-onboardings/{onboardingId}, .../complete |
| Certificates | /v1/issuers/{issuerId}/certificates |
| Documents | POST /v1/invoices, /v1/credit-notes, /v1/debit-notes, /v1/withholdings, /v1/waybills, /v1/purchase-settlements |
| Reading documents | GET /v1/documents, /v1/documents/{documentId}, .../xml, .../pdf, POST .../email |
| Webhooks | /v1/webhook-endpoints, their secret, verification and deliveries |
| Events | GET /v1/events, /v1/events/{eventId} |
| Webhook events | The payload of each event Flashpi sends to your endpoints, such as invoice.authorized |
Downloads
Section titled “Downloads”openapi.json: the OpenAPI document these pages are generated from.- Postman collection: every operation, ready to send with your test key.
Conventions
Section titled “Conventions”Every operation needs an API key as a Bearer token (Authentication), and every error is a problem details object whose code has its own page.
Planned
Section titled “Planned”- Batch submission (SRI lotes), document queries by access key, and the other SRI services. They are not in the OpenAPI document yet, so they have no reference pages.