API Endpoints
Complete reference of all available API endpoints organized by resource.
This page provides a quick reference for all available API endpoints. Click on any endpoint to view detailed documentation.
Invoices
Endpoints for creating, managing, and submitting invoices.
| Method | Endpoint | Description |
|---|---|---|
| POST | /v1/invoices | Create a new invoice |
| GET | /v1/invoices | List all invoices |
| GET | /v1/invoices/{id} | Retrieve an invoice |
| PATCH | /v1/invoices/{id} | Update an invoice |
| DELETE | /v1/invoices/{id} | Delete a draft invoice |
| POST | /v1/invoices/{id}/submit | Submit to ZIMRA |
| POST | /v1/invoices/{id}/void | Void an invoice |
Receipts
Endpoints for point-of-sale receipt management.
| Method | Endpoint | Description |
|---|---|---|
| POST | /v1/receipts | Create a new receipt |
| GET | /v1/receipts | List all receipts |
| GET | /v1/receipts/{id} | Retrieve a receipt |
| POST | /v1/receipts/{id}/void | Void a receipt |
Products
Endpoints for product catalog management.
| Method | Endpoint | Description |
|---|---|---|
| POST | /v1/products | Create a new product |
| GET | /v1/products | List all products |
| GET | /v1/products/{id} | Retrieve a product |
| PATCH | /v1/products/{id} | Update a product |
| DELETE | /v1/products/{id} | Delete a product |
Customers
Endpoints for customer management.
| Method | Endpoint | Description |
|---|---|---|
| POST | /v1/customers | Create a new customer |
| GET | /v1/customers | List all customers |
| GET | /v1/customers/{id} | Retrieve a customer |
| PATCH | /v1/customers/{id} | Update a customer |
| DELETE | /v1/customers/{id} | Delete a customer |
Webhooks
Endpoints for webhook management.
| Method | Endpoint | Description |
|---|---|---|
| POST | /v1/webhooks | Create a webhook endpoint |
| GET | /v1/webhooks | List webhook endpoints |
| GET | /v1/webhooks/{id} | Retrieve a webhook |
| PATCH | /v1/webhooks/{id} | Update a webhook |
| DELETE | /v1/webhooks/{id} | Delete a webhook |
Previous API Overview
NextError Codes