Get FIRS Service Codes
Get FIRS Service Codes
Retrieve available service codes for a specific business.
Quick Reference
| Method | Endpoint | Authentication Required |
|---|---|---|
| GET | https://api-dev.nairainvoice.com/dev/external/businesses/:businessId/resources/service-codes | Yes |
Request Structure
Path Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| businessId | string | ✅ | Unique identifier of the business | 26ede24b-ac50-475f-aacc-5ea6339f0863 |
Response Format
Success Response (200)
Copy to Clipboard
Response Data Structure
Service Code Object
| Field | Type | Description |
|---|---|---|
| code | string | Unique service code identifier |
| description | string | Brief description of the service |
Error Responses
| 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 |
Example Error Response
Copy to Clipboard
Related Endpoints
- POST
/invoices– Create invoice (uses service codes) - GET
/businesses//settings– Get business configuration
This endpoint provides service codes for businesses to categorize and identify services in invoices.
Request
Path Params
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| stage | string | ✅ | Stage identifier for the API environment | |
| businessId | string | ✅ | Unique identifier of the business |
Header Params
| Header | Type | Required | Description | Example |
|---|---|---|---|---|
| X-Business-Key | string | ✅ | (Required) Unique business key used for authentication | BK-26EDE24BAC50475FAACC5EA6339F0863-DEV-B2Z6QCEHI3X9 |
| Accept | string | ✅ | Specifies the accepted response format | */* |
