Save a Supplier

POST/api/v1/suppliers

Kenya Revenue Authority eTIMS uses the same /saveBhfCustomer endpoint for both customers and suppliers. To save a supplier to your branch records, use POST {{API_PATH}}/customers, the underlying Kenya Revenue Authority endpoint is identical.

Requires x-api-key

http://localhost:8100/api/v1/suppliers

How to Save a Supplier

FieldTypeRequiredDescription
custTinstringRequiredSupplier's 11-character Kenya Revenue Authority PIN.
custNmstringRequiredSupplier company name.
custNostringOptionalSupplier reference number.
adrsstringOptionalSupplier address.
telNostringOptionalSupplier phone number.
emailstringOptionalSupplier email address.
useYnstringOptionalActive status: Y or N. Defaults to 'Y'.

Request

{
  "custTin": "B000000000Z",
  "custNm": "SUPPLIER COMPANY LTD",
  "custNo": "SUP001",
  "adrs": "Industrial Area, Nairobi",
  "telNo": "+254722000000",
  "email": "orders@supplierco.ke",
  "useYn": "Y",
  "regrId": "USR01",
  "regrNm": "Admin"
}

Response

{
  "success": true,
  "message": "Customer saved to Kenya Revenue Authority eTIMS.",
  "data": {
    "custTin": "B000000000Z",
    "custNm": "SUPPLIER COMPANY LTD"
  }
}
curl -X POST http://localhost:8100/api/v1/customers \\
  -H "x-api-key: YOUR_API_KEY" \\
  -H "Content-Type: application/json" \\
  -d '{
    "custTin": "B000000000Z",
    "custNm": "SUPPLIER COMPANY LTD",
    "custNo": "SUP001",
    "useYn": "Y",
    "regrId": "USR01",
    "regrNm": "Admin"
  }'