Get FIRS Currencies

Get FIRS Currencies

Retrieve available currencies for a specific business.

Quick Reference

Method Endpoint Authentication Required
GET https://api-dev.nairainvoice.com/dev/external/businesses/:businessId/resources/currencies 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

Currency Object

Field Type Description
code string ISO currency code (e.g., NGN, USD)
decimalDigits number Number of decimal places for the currency
name string Full currency name
namePlural string Plural form of currency name
rounding number Rounding increment (0 = no rounding)
symbol string Currency symbol
symbolNative string Native currency symbol representation

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

✅ Validation Rules

Request Body Validation

  • page must be a positive integer (≥ 1)
  • size must be between 1 and 100
  • Both fields are required

Path Parameter Validation

  • businessId must be a valid UUID format
  • Business must exist and be accessible to the user

Business Logic Validation

  • User must have permission to access the business’s invoices
  • Only finalized/sent invoices are included in results
  • Deleted invoices are excluded from results

⚠️ Error Responses

Common Error Scenarios

Error Code Message Description Solution
400 Invalid page parameter Page number is less than 1 Use page ≥ 1
400 Invalid size parameter Page size is outside allowed range Use size between 1–100
404 Business not found Business ID doesn’t exist Verify business ID
403 Access denied User doesn’t have permission Check user permissions
422 Missing required fields Page or size not provided Include both page and size

Example Error Response

Copy to Clipboard

Related Endpoints

  • POST /invoices – Create invoice (uses currency data)
  • GET /businesses//settings – Get business configuration

This endpoint provides currency information for businesses to use in invoices and financial documents.

Request

Path Params

Field Type Required Description Example
stage string required –
businessId string required (Required) businessId
Header Type Required Description Example
X-Business-Key string required (Required) X-Business-Key BK-26EDE24BAC50475FAACC5EA6339F0863-DEV-B2Z6QCEHI3X9
Accept string required – */*

Response

Response Status

  • 200 OK

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found