Taxpayers
Onboard a taxpayer
Register the business you're sending on behalf of.
A taxpayer is a business you send on behalf of. Create one before sending its first document. The details here become the supplier block on every invoice it issues, so they must match the business's VAT registration.
POST
idempotent on vat_id/v1/api/taxpayersRequest fields
| Field | Type | Description | |
|---|---|---|---|
| name | string | required | Registered legal name, as it appears on the VAT certificate |
| vat_id | string | required | Oman VAT identifier, OM plus 10 digits |
| cr_number | string | required | Commercial Registration number |
| country_code | string | required | ISO 3166-1 alpha-2. OM for Omani taxpayers |
| address_line_1 | string | required | Street or building |
| address_line_2 | string | required | Area or district. Required by Oman rules, not optional as in base Peppol |
| address_line_3 | string | optional | Wilayat or further detail |
| city | string | required | City |
| post_code | string | required | Postal code |
| country_subdivision | string | optional | Governorate |
| phone | string | required | Contact number |
| string | optional | Billing contact address | |
| contact_point | string | optional | Department name shown on invoices |
| currency | string | optional | Default invoicing currency. Defaults to OMR |
| trade_name | string | optional | Trading name, when it differs from the legal name |
Response fields
| Field | Type | Description | |
|---|---|---|---|
| taxpayer_id | uuid | — | Use this as sender_id when sending on this taxpayer's behalf |
| peppol_id | string | — | Network address, derived as 0248:<vat_id>. This is how other parties reach them |
| peppol_status | enum | — | unregistered · pending · registered · failed |
| capabilities | array | — | Document types this taxpayer can receive. Empty until registered |
Not registered yet
Creating a taxpayer does not put it on the Peppol network. It can send immediately, but nobody can send to it until you call Register on Peppol.