/

Get list of business purchases

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

Items

Operations

Notices

Operations

Purchases

Operations

Get list of business purchases

Request

Get list of business purchases

Query

pagenumber

Page number

Example: page=1

limitnumber

Limit

Example: limit=10

curl -i -X GET \
  'https://docs-etims.churpy.co/_mock/openapi/purchases?limit=10&page=1' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

List of purchases returned successfully

Bodyapplication/json

paginationobject

dataArray of objects

Response

application/json

{
  "pagination": {
    "current_page": 1,
    "total_pages": 1,
    "has_next": false,
    "limit": 10,
    "total_count": 10
  },
  "data": [
    { … }
  ]
}

Get a specific purchase

Request

Get a specific purchase

Path

purchase_idstringrequired

Purchase id

Example: ARxgmcTEoL

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

Responses

Purchase returned successfully

Bodyapplication/json

idstring

Example: "cljvm2neg0000p57z71g7xbar"

registration_type_codestring

Example: "A"

receipt_type_codestring

Example: "P"

purchase_type_codestring

Example: "N"

payment_type_codestring

Example: "07"

purchase_status_codestring

Example: "06"

invoice_numberinteger

Example: 4000

purchase_datestring

Example: "20230620"

trader_invoice_numberstring

Example: "12"

supplierBranchIdstring

Example: "00"

supplierNamestring

Example: "KENYA REVENUE AUTHORITY"

supplierInvoiceNumberinteger

Example: 12

item_listArray of objects

Response

application/json

{
  "id": "cljvm2neg0000p57z71g7xbar",
  "registration_type_code": "A",
  "receipt_type_code": "P",
  "purchase_type_code": "N",
  "payment_type_code": "07",
  "purchase_status_code": "06",
  "invoice_number": 4000,
  "purchase_date": "20230620",
  "trader_invoice_number": "12",
  "supplierBranchId": "00",
  "supplierName": "KENYA REVENUE AUTHORITY",
  "supplierInvoiceNumber": 12,
  "item_list": [
    { … }
  ]
}

Link purchase item to item

Request

Link purchase item to item

Path

purchase_idstringrequired

Purchase id

Example: clk5c8y380000p5wtae2mz7gr

Bodyapplication/jsonrequired

itemsArray of objects

curl -i -X POST \
  'https://docs-etims.churpy.co/_mock/openapi/purchases/{purchase_id}/purchase_items/link_item' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "items": [
      {
        "item_sequence_number": 1,
        "item_id": "clka6cqmd0003p5intib19jdb"
      }
    ]
  }'

Responses

Purchase item linked to item successfully

Bodyapplication/json

idstring

Example: "clk5c8y380000p5wtae2mz7gr"

registration_type_codestring

Example: "A"

receipt_type_codestring

Example: "P"

purchase_type_codestring

Example: "N"

payment_type_codestring

Example: "07"

purchase_status_codestring

Example: "06"

invoice_numberinteger

Example: 60002

purchase_datestring

Example: "20230620"

trader_invoice_numberstring

Example: "12"

supplierBranchIdstring

Example: "00"

supplierNamestring

Example: "KENYA REVENUE AUTHORITY"

supplierInvoiceNumberinteger

Example: 12

item_listArray of objects

Response

application/json

{
  "id": "clk5c8y380000p5wtae2mz7gr",
  "registration_type_code": "A",
  "receipt_type_code": "P",
  "purchase_type_code": "N",
  "payment_type_code": "07",
  "purchase_status_code": "06",
  "invoice_number": 60002,
  "purchase_date": "20230620",
  "trader_invoice_number": "12",
  "supplierBranchId": "00",
  "supplierName": "KENYA REVENUE AUTHORITY",
  "supplierInvoiceNumber": 12,
  "item_list": [
    { … }
  ]
}

Sales

Operations

Stock

Operations