Churpy_Etims (1.0)

Churpy_Etims Public API

Download OpenAPI description

Overview

URL https://etims.churpy.co

Churpy info@churpy.co

License Apache 2.0

Terms of Service

Servers

Mock server

https://docs-etims.churpy.co/_mock/openapi/

API

https://etims.churpy.co/

Branches

Operations

Customers

Operations

Add branch customer

Request

Add branch customer

Bodyapplication/jsonrequired

customer_namestringrequired

Customer Name

Example: "John Doe"

customer_pinstringrequired

Customer PIN

Example: "P012345678P"

customer_emailstring

Customer Email

Example: "info@churpy.co"

customer_phone_numberstring

Customer Phone number

Example: "+254112685368"

curl -i -X POST \
  https://docs-etims.churpy.co/_mock/openapi/branches/customer \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "customer_name": "John Doe",
    "customer_pin": "P012345678P",
    "customer_email": "info@churpy.co",
    "customer_phone_number": "+254112685368"
  }'

Responses

Success

Bodyapplication/json

customer_namestring

Customer Name

Example: "John Doe"

customer_pinstring

Customer PIN

Example: "P012345678P"

idstring

Customer ID

Example: "clwgjr1b200bzztaknq1twiun"

Response

application/json

{
  "customer_name": "John Doe",
  "customer_pin": "P012345678P",
  "id": "clwgjr1b200bzztaknq1twiun"
}

Get a customer

Request

Retrieves information about a customer

Path

customer_pinstringrequired

The customer pin

curl -i -X GET \
  'https://docs-etims.churpy.co/_mock/openapi/customers/{customer_pin}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json

customer_namestring

Example: "TAXPAYER1"

customer_pinstring

Example: "P123456789A"

county_namestring

Example: "NAIROBI CITY"

sub_county_namestring

Example: "KASARANI"

location_descriptionstring

Example: "KASARANI TOWERS"

tax_locality_namestring

Example: "NON"

taxpayer_status_codestring

Example: "A"

Response

application/json

{
  "customer_name": "TAXPAYER1",
  "customer_pin": "P123456789A",
  "county_name": "NAIROBI CITY",
  "sub_county_name": "KASARANI",
  "location_description": "KASARANI TOWERS",
  "tax_locality_name": "NON",
  "taxpayer_status_code": "A"
}

Items

Operations

Notices

Operations

Purchases

Operations

Sales

Operations

Stock

Operations