Stock
/
Create a new master stock

Churpy_Etims (1.0)

Churpy_Etims Public API

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL https://etims.churpy.co
Churpy info@churpy.co
License Apache 2.0
 Terms of Service
Languages
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

Sales

Operations

Stock

Operations

Create a new master stock

Request

Create a new master stock

Bodyapplication/jsonrequired
item_idstring

Item id as saved in Churpy_Etims

Example: "cls8iu3rd002qs601af4qzb9g"
remaining_quantitynumber

Remaining quantity

Example: 100
curl -i -X POST \
  https://docs-etims.churpy.co/_mock/openapi/stock/master \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "item_id": "cls8iu3rd002qs601af4qzb9g",
    "remaining_quantity": 100
  }'

Responses

Created

Bodyapplication/json
idstring
Example: "cls8iu3rd002qs601af4qzb9g"
item_codestring
Example: "KE1PD-U230411121122"
remaining_quantityinteger
Example: 300
Response
application/json
{
  "id": "cls8iu3rd002qs601af4qzb9g",
  "item_code": "KE1PD-U230411121122",
  "remaining_quantity": 300
}

Get list of stock movement

Request

Get list of stock movement

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

Responses

Success

Bodyapplication/json
paginationobject
dataArray of objects
Response
application/json
{
  "pagination": {
    "current_page": 1,
    "total_pages": 1,
    "has_next": false,
    "limit": 10,
    "total_count": 2
  },
  "data": [
    { … }
  ]
}

Create a new stock move

Request

Create a new stock move

Bodyapplication/jsonrequired
original_stored_and_released_numberinteger
Example: 10
registration_type_codestring
Example: "M"
stored_and_released_codestring
Example: "13"
occurred_datestring
Example: "20230510"
customer_branch_office_idstring
Example: "cln8mpz9i001ls601ulo7fq4q"
itemsArray of objects
curl -i -X POST \
  https://docs-etims.churpy.co/_mock/openapi/stock \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "original_stored_and_released_number": 10,
    "registration_type_code": "M",
    "stored_and_released_code": "13",
    "occurred_date": "20230510",
    "customer_branch_office_id": "cln8mpz9i001ls601ulo7fq4q",
    "items": [
      {
        "id": "cls8irr4l001vs601cbf200bv",
        "quantity": 20,
        "price": 100,
        "discount_amount": 0
      }
    ]
  }'

Responses

Created

Bodyapplication/json
stored_and_released_codeinteger
Example: 13
total_item_countinteger
Example: 2
total_supply_pricenumber
Example: 3575.99
total_vatnumber
Example: 424.01
total_amountinteger
Example: 4000
registration_type_codestring
Example: "M"
original_stored_and_released_numberinteger
Example: 10
stored_and_released_numberinteger
Example: 1
occurred_datestring(date-time)
Example: "2023-05-10T00:00:00.000Z"
customer_branch_office_idstring
Example: "00"
listArray of objects
Response
application/json
{
  "stored_and_released_code": 13,
  "total_item_count": 2,
  "total_supply_price": 3575.99,
  "total_vat": 424.01,
  "total_amount": 4000,
  "registration_type_code": "M",
  "original_stored_and_released_number": 10,
  "stored_and_released_number": 1,
  "occurred_date": "2023-05-10T00:00:00.000Z",
  "customer_branch_office_id": "00",
  "list": [
    { … }
  ]
}

Adjust stock

Request

Adjust stock

Bodyapplication/jsonrequired
item_idstring
Example: "clk04eudo0001p5qd132yc8s9"
quantityinteger(int32)
Example: 1
actionstring
Example: "add"
typestring
Example: "adjustment"
curl -i -X POST \
  https://docs-etims.churpy.co/_mock/openapi/stock/adjust \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "item_id": "clk04eudo0001p5qd132yc8s9",
    "quantity": 1,
    "action": "add",
    "type": "adjustment"
  }'

Responses

Created

Bodyapplication/json
idstring
Example: "clk5n53vg0001p5ud5wsv3344"
Response
application/json
{
  "id": "clk5n53vg0001p5ud5wsv3344"
}

Transfer stock from branch

Request

Transfer stock from branch

Bodyapplication/jsonrequired
item_idstring
Example: "clk04eudo0001p5qd132yc8s9"
branch_idstring
Example: "clk04eudo0001p5qd132yc8s9"
quantityinteger
Example: 1
curl -i -X POST \
  https://docs-etims.churpy.co/_mock/openapi/stock/transfer \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "item_id": "clk04eudo0001p5qd132yc8s9",
    "branch_id": "clk04eudo0001p5qd132yc8s9",
    "quantity": 1
  }'

Responses

Created

Bodyapplication/json
messagestring
Example: "Stock transfer successful"
Response
application/json
{
  "message": "Stock transfer successful"
}