Authentication
All API requests require a Bearer token in the Authorization header. Generate API keys from Settings → API Access.
HTTP
Authorization: Bearer biltax_live_xxxxxxxxxxxxxxxxxxxxxxxx
⚠ Never expose your API key in client-side code. Use environment variables or a server-side proxy.
Base URL
URL
https://api.biltax.com/v1
Rate Limits
| Plan |
Requests/Min |
Requests/Day |
| Starter |
60 |
10,000 |
| Business |
300 |
100,000 |
| Enterprise |
Unlimited |
Unlimited |
Error Codes
JSON
{"error":{"code":"ITEM_NOT_FOUND","message":"No item found with that ID","status":404}}
200
OK
Request successful
201
Created
Resource created
400
Bad Request
Invalid parameters
401
Unauthorized
Invalid or missing API key
404
Not Found
Resource not found
429
Too Many Requests
Rate limit exceeded
500
Server Error
Internal server error
API Endpoints
Complete reference for all available endpoints.
GET
/v1/inventory
List inventory items
Parameters
location_id
category
low_stock
limit
offset
Example Response
JSON
{"data":[{"id":"itm_1a2b","sku":"TOM-KG","name":"Tomatoes","quantity":4.5,"unit":"kg","location":"Main Kitchen","reorder_point":5,"status":"low"}],"total":1,"limit":50,"offset":0}
POST
/v1/inventory
Create an inventory item
Parameters
sku (required)
name (required)
quantity (required)
unit (required)
location_id (required)
reorder_point
Example Response
JSON
{"data":{"id":"itm_4d5e","sku":"CHK-KG","name":"Chicken Breast","quantity":20,"unit":"kg","status":"ok"},"message":"Item created"}
PATCH
/v1/inventory/{id}
Update an item
Parameters
quantity
reorder_point
name
notes
Example Response
JSON
{"data":{"id":"itm_1a2b","quantity":12.5,"updated_at":"2025-04-06T10:32:00Z"},"message":"Item updated"}
GET
/v1/locations
List all locations
Parameters
active (boolean)
Example Response
JSON
{"data":[{"id":"loc_abc","name":"Main Branch","city":"Karachi","type":"retail","active":true}]}
POST
/v1/purchase-orders
Create a purchase order
Parameters
supplier_id (required)
items (array, required)
expected_delivery
notes
Example Response
JSON
{"data":{"id":"po_x9y8","status":"draft","supplier":"Al-Amin Traders","total_items":3},"message":"Purchase order created"}
GET
/v1/reports/stock-summary
Get a stock summary report
Parameters
location_id
date_from
date_to
format (json|csv)
Example Response
JSON
{"data":{"total_skus":4821,"low_stock_count":47,"total_value":2400000,"currency":"PKR"}}
SDKs & Libraries
🐘
PHP
composer require biltax/sdk