Business Partners/Customers
This section covers adding a customer, fetching the eTIMS customer list, and sending (syncing) a customer to eTIMS.
Add customer
Description
This endpoint creates a new customer
Request Body
| Priority | Key | Type | Description |
|---|---|---|---|
| REQUIRED | partner_name | text | Customer full name |
| REQUIRED | country | text | country ISO code |
| REQUIRED | currency | text | currency id of customer |
| Optional | customer_tax_pin | text | Customer KRA pin |
| REQUIRED | email_address | text | customer email |
| Optional | customer_type | text | Options: CATERING, EMPLOYER, INFORMATION TECHNOLOGY, FURNITURE INSURANCE, LEGAL, MEDICAL EQUIPMENT, NUTRITION, PATIENT, PHARMACEUTICAL |
| optional | is_customer | text | Boolean for whether customer or business partner |
| Optional | phone_number | text | customer phone number |
Headers
AcceptReturns the response in JSON format
Add customer › Request Body optional
partner_nameCustomer full name
countrycountry ISO code
currencycurrency id of customer
customer_typeType of customer being created Options: CATERING, EMPLOYER, INFORMATION TECHNOLOGY, FURNITURE INSURANCE, LEGAL, MEDICAL EQUIPMENT, NUTRITION, PATIENT, PHARMACEUTICAL
phone_numbercustomer phone number
Add customer › Responses
Created
idcodecustomer_amount_owedcustomer_credit_utilizedsupplier_credit_utilizedpayables_accountsupplier_deposits_accountbilling_accountsbusiness_partner_personidentifiersbusiness_partner_idbusiness_partner_photobusiness_partner_attachmentsbusiness_partner_contactcustomer_sync_to_etimsslade_codeactivepartner_namedescriptionphysical_addresscountrytownbox_numbercredit_limitis_supplieris_customersupplier_typecustomer_typebp_typephone_numberemail_addresscustomer_tax_pincurrencyparentSend a customer to eTIMS
Description
Manually sync a customer to eTIMS. Sends branch customer data and, for INSURANCE customers, branch insurance data.
The id in the path is the customer ID returned when the customer was created via the Add customer endpoint.
Required
- id - [REQUIRED] The ID of the customer to sync to eTIMS.
- X-Workstation - [REQUIRED] The workstation ID of the user.
path Parameters
id[REQUIRED] The ID of the customer to sync to eTIMS
Headers
AcceptReturns the response in JSON format
X-Workstation[REQUIRED] Workstation ID
Send a customer to eTIMS › Responses
OK
detailFetch eTIMS customer list
Description
This endpoint retrieves the list of customers registered on eTIMS.
Required
- X-Workstation - [REQUIRED] The workstation ID of the user.
Headers
AcceptReturns the response in JSON format
X-Workstation[REQUIRED] Workstation ID
Fetch eTIMS customer list › Responses
OK
count