einvo API reference
einvo API v1 · openapi.json · Postman collection · Guides
Invoicing
| GET | /api/v1/billing/customers | Customers |
| POST | /api/v1/billing/customers | Create customer |
| PUT | /api/v1/billing/customers/{id} | Update customer |
| GET | /api/v1/billing/customers/{id}/statement | Statement of account of a customer (PDF, EN/AR) |
| POST | /api/v1/billing/customers/{id}/statement/email | Email statement |
| POST | /api/v1/billing/import | Create invoice drafts from a CSV or Excel file (all or nothing) |
| GET | /api/v1/billing/invoices | Invoices |
| POST | /api/v1/billing/invoices | Create an invoice draft |
| GET | /api/v1/billing/invoices/advance-candidates | Issued invoices of a customer, to reference as advance payments in a final invoice |
| GET | /api/v1/billing/invoices/{id} | Invoice |
| PUT | /api/v1/billing/invoices/{id} | Update invoice |
| DELETE | /api/v1/billing/invoices/{id} | Delete invoice |
| POST | /api/v1/billing/invoices/{id}/credit-note | Create a credit-note draft for an issued invoice |
| POST | /api/v1/billing/invoices/{id}/email | E-mail an issued invoice (PDF + UBL attached) to the customer or another address |
| GET | /api/v1/billing/invoices/{id}/emails | E-mails sent for an invoice |
| POST | /api/v1/billing/invoices/{id}/issue | Issue a draft: number, PINT AE UBL, validation, Peppol delivery and FTA reporting |
| GET | /api/v1/billing/invoices/{id}/payments | Payments |
| POST | /api/v1/billing/invoices/{id}/payments | Record a (partial) payment received for an issued invoice |
| GET | /api/v1/billing/invoices/{id}/pdf | Bilingual PDF (issued: from the sent UBL; draft: preview with DRAFT watermark) |
| POST | /api/v1/billing/invoices/{id}/remind | E-mail a payment reminder now |
| GET | /api/v1/billing/invoices/{id}/reminders | Reminders |
| POST | /api/v1/billing/invoices/{id}/retention-release | Release a contract retention: new draft invoice for the amount released |
| DELETE | /api/v1/billing/payments/{paymentId} | Delete payment |
| POST | /api/v1/billing/preview | Compute totals of draft lines (same rounding as issuing) |
| GET | /api/v1/billing/products | Products |
| POST | /api/v1/billing/products | Create product |
| PUT | /api/v1/billing/products/{id} | Update product |
| GET | /api/v1/billing/quotes | Quotes |
| POST | /api/v1/billing/quotes | Create a quotation draft |
| POST | /api/v1/billing/quotes/{id}/accept | Accept |
| POST | /api/v1/billing/quotes/{id}/convert | Create an invoice draft from the quote |
| POST | /api/v1/billing/quotes/{id}/decline | Decline |
| POST | /api/v1/billing/quotes/{id}/send | Number the quote and mark it sent; optionally e-mail the PDF |
| GET | /api/v1/billing/recurring | Recurring |
| POST | /api/v1/billing/recurring | Create recurring |
| PUT | /api/v1/billing/recurring/{id} | Update recurring |
| DELETE | /api/v1/billing/recurring/{id} | Delete recurring |
| GET | /api/v1/billing/reports/export.xlsx | Export |
| GET | /api/v1/billing/reports/summary | Summary |
| GET | /api/v1/billing/reports/vat | Vat |
| GET | /api/v1/billing/reports/vat201 | VAT return (VAT 201) of a company for a tax period: every box, with the documents behind it |
| GET | /api/v1/billing/reports/vat201/companies | Companies a VAT return can be prepared for |
| GET | /api/v1/billing/reports/vat201/export.pdf | |
| GET | /api/v1/billing/reports/vat201/export.xlsx | Xlsx |
| POST | /api/v1/billing/reports/vat201/file | Record that the return was filed on EmaraTax (date and FTA reference) and freeze it |
| GET | /api/v1/billing/reports/vat201/history | Saved VAT returns of a company |
| PUT | /api/v1/billing/reports/vat201/manual | Save the boxes einvo cannot know (tourist refunds, imports, documents outside einvo) |
| POST | /api/v1/billing/reports/vat201/reopen | Reopen a filed return (back to draft) |
| GET | /api/v1/billing/sellers | Sellers |
Price lists
| GET | /api/v1/billing/customers/{id}/prices | Customer prices |
| PUT | /api/v1/billing/customers/{id}/prices | Save customer prices |
| GET | /api/v1/billing/price-lists | Lists |
| POST | /api/v1/billing/price-lists | Create |
| PUT | /api/v1/billing/price-lists/{id} | Update |
| DELETE | /api/v1/billing/price-lists/{id} | Delete |
| GET | /api/v1/billing/prices/resolve | Resolve |
Purchase orders
| PUT | /api/v1/billing/customers/{id}/supplier | Mark supplier |
| GET | /api/v1/billing/purchase-orders | List |
| POST | /api/v1/billing/purchase-orders | Create |
| GET | /api/v1/billing/purchase-orders/{id} | Get |
| PUT | /api/v1/billing/purchase-orders/{id} | Update |
| DELETE | /api/v1/billing/purchase-orders/{id} | Delete |
| POST | /api/v1/billing/purchase-orders/{id}/cancel | Cancel |
| GET | /api/v1/billing/purchase-orders/{id}/candidates | Candidates |
| POST | /api/v1/billing/purchase-orders/{id}/close | Close |
| POST | /api/v1/billing/purchase-orders/{id}/invoices/{documentId} | Match |
| DELETE | /api/v1/billing/purchase-orders/{id}/invoices/{documentId} | Unmatch |
| GET | /api/v1/billing/purchase-orders/{id}/pdf | |
| POST | /api/v1/billing/purchase-orders/{id}/send | Send |
| GET | /api/v1/billing/suppliers | Suppliers |
Delivery notes
| GET | /api/v1/billing/delivery-notes | List |
| POST | /api/v1/billing/delivery-notes | Create |
| POST | /api/v1/billing/delivery-notes/from/{documentId} | From |
| GET | /api/v1/billing/delivery-notes/{id} | Get |
| PUT | /api/v1/billing/delivery-notes/{id} | Update |
| DELETE | /api/v1/billing/delivery-notes/{id} | Delete |
| POST | /api/v1/billing/delivery-notes/{id}/cancel | Cancel |
| POST | /api/v1/billing/delivery-notes/{id}/delivered | Delivered |
| POST | /api/v1/billing/delivery-notes/{id}/invoice | Create invoice |
| PUT | /api/v1/billing/delivery-notes/{id}/invoice | Link |
| POST | /api/v1/billing/delivery-notes/{id}/issue | Issue |
| GET | /api/v1/billing/delivery-notes/{id}/pdf |
Payment links
| GET | /api/v1/billing/invoices/{id}/paylinks | Payment links of an invoice (newest first) with their gateway orders |
| POST | /api/v1/billing/invoices/{id}/paylinks | Create a payment link for what is outstanding (or a partial amount) |
| DELETE | /api/v1/billing/invoices/{id}/paylinks | Close the open payment links of an invoice |
| POST | /api/v1/billing/invoices/{id}/paylinks/check | Read the open payment orders from the gateway now |
| GET | /api/v1/billing/invoices/{id}/whatsapp | WhatsApp messages sent for an invoice, with their delivery status |
| POST | /api/v1/billing/invoices/{id}/whatsapp | Send the invoice PDF to the customer's WhatsApp number |
Mapping profiles
| GET | /api/v1/billing/mappings | List |
| POST | /api/v1/billing/mappings | Create |
| POST | /api/v1/billing/mappings/preview | Applies a mapping (config as JSON) to a sample file without creating anything |
| PUT | /api/v1/billing/mappings/{id} | Update |
| DELETE | /api/v1/billing/mappings/{id} | Delete |
| POST | /api/v1/billing/mappings/{id}/import | Creates invoice drafts from a CSV / XML file with a saved mapping profile (all or nothing) |
Peppol directory
| GET | /api/v1/billing/peppol-directory/checks | Checks |
| GET | /api/v1/billing/peppol-directory/invitations | Invitations |
| POST | /api/v1/billing/peppol-directory/invitations | E-mails suppliers an invitation to register on e-invoicing |
| GET | /api/v1/billing/peppol-directory/search | Searches participants by name, Peppol ID (0235:...), TIN or TRN |
| POST | /api/v1/billing/peppol-directory/verify | Checks customers on the SMP: registered for the PINT AE invoice? Optionally updates peppolEnabled |
Aps
| GET | /api/v1/cashbook/ap/invoices | Invoices |
| POST | /api/v1/cashbook/ap/invoices/acknowledge | Acknowledge |
Inbox
| GET | /api/v1/inbox | Received, validated documents not yet acknowledged (oldest first) |
| POST | /api/v1/inbox/{id}/ack | Confirm the document was imported; idempotent |
Invoices
| GET | /api/v1/invoices | List documents visible to the caller |
| POST | /api/v1/invoices | Submit an invoice or credit note as simplified JSON; einvo generates the PINT AE UBL |
| POST | /api/v1/invoices/validate | Validate a document against PINT AE / UAE TDD rules without sending it |
| GET | /api/v1/invoices/{id} | Get a document with its status and validation findings |
| GET | /api/v1/invoices/{id}/pdf | Bilingual (EN/AR) PDF copy of an invoice or credit note, rendered from its UBL |
| GET | /api/v1/invoices/{id}/ubl | Download the UBL XML of a document |
Session
| GET | /api/v1/me | Me |
Webhooks
| GET | /api/v1/webhooks | List |
| POST | /api/v1/webhooks | Create |
| DELETE | /api/v1/webhooks/{id} | Delete |
| GET | /api/v1/webhooks/{id}/events | Events |
| POST | /api/v1/webhooks/{id}/test | Test |