| Method | Endpoint | Authentication Required |
|---|---|---|
GET | {{baseUrl}}/{{stage}}/external/businesses/:businessId/resources/invoice-types | Yes |
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
businessId | string | ✅ | Unique identifier of the business | 26ede24b-ac50-475f-aacc-5ea6339f0863 |
| Header | Value | Required |
|---|---|---|
Content-Type | application/json or */* | Yes |
Accept | application/json or */* | Yes |
X-Business-Key | businessKey | Yes |
{
"responseCode": "00",
"responseMessage": "Invoice types retrieved successfully",
"data": [
{
"code": "389",
"value": "Standard Invoice"
},
{
"code": "381",
"value": "Credit Note"
},
{
"code": "383",
"value": "Debit Note"
},
{
"code": "326",
"value": "Partial Invoice"
}
]
}| Field | Type | Description |
|---|---|---|
code | string | FIRS invoice type code |
value | string | Descriptive name of the invoice type |
| Error Code | Message | Description |
|---|---|---|
404 | Business not found | Business ID doesn't exist |
403 | Access denied | User doesn't have permission |
400 | Invalid business ID | Business ID format is invalid |
{
"responseCode": "404",
"responseMessage": "Business not found with ID: invalid-business-id",
"data": null
}/invoices - Create invoice (uses invoice type codes)/businesses/{businessId}/settings - Get business configurationcurl --location --globoff '/{{stage}}/external/{{businessId}}/resources/invoice-types' \
--header 'X-Business-Key: BK-26EDE24BAC50475FAACC5EA6339F0863-DEV-B2Z6QCEHI3X9' \
--header 'Accept: */*'{
"responseCode": "00",
"responseMessage": "Completed successfully",
"data": [
{
"code": "380",
"value": "Credit Note"
},
{
"code": "381",
"value": "Commercial Invoice"
},
{
"code": "384",
"value": "Debit Note"
},
{
"code": "385",
"value": "Self Billed Invoice"
},
{
"code": "386",
"value": "Factored Invoice"
},
{
"code": "388",
"value": "Statement of Account"
},
{
"code": "389",
"value": "Purchase Order"
},
{
"code": "390",
"value": "Proforma Invoice"
},
{
"code": "392",
"value": "Consignment Invoice"
},
{
"code": "393",
"value": "Self-billed Credit Note"
},
{
"code": "394",
"value": "Self-billed Invoice Debit Note"
},
{
"code": "395",
"value": "Credit Note Request"
},
{
"code": "396",
"value": "Invoice Request"
},
{
"code": "397",
"value": "Final Settlement"
},
{
"code": "399",
"value": "Bill of Lading"
},
{
"code": "400",
"value": "Waybill"
},
{
"code": "402",
"value": "Shipping Instructions"
},
{
"code": "404",
"value": "Certificate of Origin"
},
{
"code": "406",
"value": "Customs Declaration"
},
{
"code": "408",
"value": "Packing List"
}
]
}