Save a Customer

POST/api/v1/customers

Save a customer to the Kenya Revenue Authority eTIMS branch customer list (/saveBhfCustomer). This registers the customer against your branch so they appear in your Kenya Revenue Authority branch customer records.

Requires x-api-key

http://localhost:8100/api/v1/customers

Headers

Field	Type	Required	Description
x-api-key	string	Required	Your Ushuru API key.
Content-Type	string	Required	application/json

Request Body

Field	Type	Required	Description
custTin	string	Required	11-character Kenya Revenue Authority PIN of the customer.
custNm	string	Required	Customer full name.
custNo	string	Optional	Customer number. Defaults to '000'.
adrs	string	Optional	Customer physical address.
telNo	string	Optional	Phone number.
email	string	Optional	Email address.
faxNo	string	Optional	Fax number.
useYn	string	Optional	Active status: Y=Active, N=Inactive. Defaults to 'Y'.
regrId	string	Optional	Registering user ID. Defaults to 'USR01'.
regrNm	string	Optional	Registering user name. Defaults to 'Admin'.
modrId	string	Optional	Modifying user ID.
modrNm	string	Optional	Modifying user name.

Request

{
  "custTin": "A000000000Z",
  "custNm": "BUYER COMPANY LTD",
  "custNo": "001",
  "adrs": "P.O. Box 12345, Nairobi",
  "telNo": "+254700000000",
  "email": "accounts@buyerco.ke",
  "useYn": "Y",
  "regrId": "USR01",
  "regrNm": "Admin"
}

Response

{
  "success": true,
  "message": "Customer saved to Kenya Revenue Authority eTIMS branch customer list.",
  "data": {
    "resultCd": "000",
    "resultMsg": "Customer saved successfully"
  }
}

curl -X POST http://localhost:8100/api/v1/customers \\
  -H "x-api-key: YOUR_API_KEY" \\
  -H "Content-Type: application/json" \\
  -d '{
    "custTin": "A000000000Z",
    "custNm": "BUYER COMPANY LTD",
    "adrs": "P.O. Box 12345, Nairobi",
    "telNo": "+254700000000",
    "email": "accounts@buyerco.ke"
  }'