Reference
Suppliers
Vendor directory for bills, expenses, and procurement. PII encrypted at rest, TIN verification supported.
Suppliers mirror the customers module on the purchasing side. Same CRUD shape, same encryption-at-rest for PII, plus a TIN verification status field that indicates whether the tax ID has been validated against the FIRS database.
List suppliers
GET
/v1/suppliersReturns active suppliers for a business.
Query parameters
| Field | Type | Required | Notes |
|---|---|---|---|
businessId | string | yes | |
limit | integer | no | Default 50, max 100. |
tinVerificationStatus | string | no | Filter by verified, unverified, failed, pending, or no_tin. |
Response — 200
{
"success": true,
"data": {
"suppliers": [
{
"id": "sup_789",
"name": "IKEDC",
"email": "billing@ikedc.com",
"phone": "+2348012345678",
"tin": "01234567-0001",
"rcNumber": "RC123456",
"tinVerificationStatus": "verified",
"companyType": "limited_company",
"accountBalanceKobo": 0,
"isActive": true,
"createdAt": "2026-03-01T09:00:00.000Z"
}
],
"count": 1
}
}Get a single supplier
GET
/v1/suppliers/{id}Fetches one supplier.
Search suppliers
GET
/v1/suppliers/searchSubstring match on name, email, phone, or TIN.
Query parameters
| Field | Type | Required | Notes |
|---|---|---|---|
businessId | string | yes | |
q | string | yes | Case-insensitive substring. |
Create a supplier
POST
/v1/suppliersCreates a supplier record.
Body
| Field | Type | Required | Notes |
|---|---|---|---|
name | string | yes | |
email | string | no | Encrypted at rest. |
phone | string | no | Encrypted at rest. |
tin | string | no | Nigerian Tax Identification Number. |
rcNumber | string | no | Corporate Affairs Commission registration number. |
companyType | string | no | sole_proprietor, limited_company, partnership, individual. |
defaultExpenseCategory | string | no | COA account ID to prefill on new expenses. |
address | string | no |
Update a supplier
PUT
/v1/suppliers/{id}Updates supplier fields. Allowed fields match the create body.
Soft-delete a supplier
DELETE
/v1/suppliers/{id}Marks the supplier inactive. Does not affect historical bills or expenses.
Related endpoints
Reference index
Back to all modules