SolaCount Finance API
SolaCount Finance API سے حساب داری کا ڈیٹا پروگرام کے ذریعے پڑھ اور لکھ سکتے ہیں: کلائنٹس، سپلائرز، انوائسز، بل، ادائیگیاں، روزنامچے کے اندراجات اور مالی رپورٹیں۔ تمام اینڈ پوائنٹس JSON واپس کرتے ہیں۔ API کلید بنائیں →
توثیق
ہر محفوظ اینڈ پوائنٹ کو تین ہیڈرز درکار ہیں:
X-API-Key: solabooks_<prefix>.<secret> X-Organization-Id: 1 X-Client-Id: 4
- X-API-Key — مکمل کلید جو ترتیبات → API رسائی میں تخلیق کے وقت ایک بار دکھائی جاتی ہے
- X-Organization-Id — آپ کی تنظیم کا عددی ID (API رسائی صفحے پر دکھائی دیتا ہے)
- X-Client-Id — آپ کا کلائنٹ ID (API رسائی صفحے پر دکھائی دیتا ہے)
GET /api/v1/health اینڈ پوائنٹ کو تصدیق کی ضرورت نہیں اور اسے کنکٹیویٹی جانچنے کے لیے استعمال کیا جا سکتا ہے۔
جواب کا فارمیٹ
تمام جوابات ایک یکساں JSON لفافے میں ہوتے ہیں۔
واحد آبجیکٹ
{
"success": true,
"data": { ... }
}
صفحہ بندی والی فہرست
{
"success": true,
"data": [ ... ],
"meta": {
"current_page": 1,
"per_page": 25,
"total": 100,
"last_page": 4
}
}
خرابی
{
"success": false,
"error": {
"code": "error_code",
"message": "Human readable message."
}
}
فوری ٹیسٹ
your_key، 1 اور 4 کی جگہ اپنی اصل API کلید، تنظیم کا ID اور کلائنٹ ID رکھیں۔
ہیلتھ چیک (توثیق درکار نہیں)
curl https://solacount.com/api/v1/health
انوائسز کی فہرست
curl https://solacount.com/api/v1/invoices \ -H "X-API-Key: your_key" \ -H "X-Organization-Id: 1" \ -H "X-Client-Id: 4"
گاہک بنائیں
curl -X POST https://solacount.com/api/v1/customers \
-H "X-API-Key: your_key" \
-H "X-Organization-Id: 1" \
-H "X-Client-Id: 4" \
-H "Content-Type: application/json" \
-d '{"name":"Demo Customer","email":"billing@example.com"}'
جرنل انٹری بنائیں
curl -X POST https://solacount.com/api/v1/journal-entries \
-H "X-API-Key: your_key" \
-H "X-Organization-Id: 1" \
-H "X-Client-Id: 4" \
-H "Content-Type: application/json" \
-d '{
"date": "2026-06-07",
"reference": "JE-001",
"description": "Manual accrual",
"lines": [
{"account_id": 101, "debit": 1000, "credit": 0},
{"account_id": 202, "debit": 0, "credit": 1000}
]
}'
تمام اینڈ پوائنٹس
کسی بھی اینڈ پوائنٹ پر کلک کر کے اس کی تفصیلات دیکھیں۔ 8 ریسورس گروپس میں کل 33 اینڈ پوائنٹس ہیں۔
صحت
/api/v1/health
کوئی اجازت نہیں
تصدیق کریں کہ API آن لائن ہے اور جواب دے رہی ہے۔ کسی تصدیق کی ضرورت نہیں۔
جواب HTTP 200
{"success":true,"data":{"service":"finance-api","status":"ok","timestamp":"2026-06-07T12:00:00+00:00"}}
گاہکوں
/api/v1/customers
اسکوپ: customers.get
تمام کسٹمرز کی فہرست۔ سرچ اور پیجینیشن سپورٹ کرتا ہے۔
کوئری پیرامیٹرز
| پیرامیٹر | قسم | تفصیل | |
|---|---|---|---|
search |
string |
اختیاری | نام، ای میل یا فون کے لحاظ سے فلٹر کریں (جزوی مماثلت) |
page |
integer |
اختیاری | صفحہ نمبر (ڈیفالٹ: 1) |
per_page |
integer |
اختیاری | فی صفحہ نتائج (ڈیفالٹ: 25، زیادہ سے زیادہ: 100) |
جواب HTTP 200
{"success":true,"data":[{"id":1,"name":"Demo Customer","email":"billing@example.com","phone":"+1-555-0100","is_active":true}],"meta":{"current_page":1,"per_page":25,"total":3,"last_page":1}}
/api/v1/customers/{id}
اسکوپ: customers.get
ID کے ذریعے ایک کسٹمر حاصل کریں۔
جواب HTTP 200
{"success":true,"data":{"id":1,"name":"Demo Customer","email":"billing@example.com","phone":"+1-555-0100","is_active":true}}
/api/v1/customers
اسکوپ: customers.post
نیا کسٹمر بنائیں۔
درخواست کا متن (JSON)
| فیلڈ | قسم | تفصیل | |
|---|---|---|---|
name |
string |
لازمی | گاہک کا نام |
email |
string |
اختیاری | ای میل ایڈریس (درست ای میل ہونا ضروری ہے) |
phone |
string |
اختیاری | فون نمبر (زیادہ سے زیادہ 50 حروف) |
is_active |
boolean |
اختیاری | فعال حیثیت (ڈیفالٹ: true) |
جواب HTTP 201
{"success":true,"data":{"id":42,"name":"Demo Customer","email":"billing@example.com","phone":null,"is_active":true}}
سپلائرز
/api/v1/suppliers
اسکوپ: suppliers.get
تمام سپلائرز کی فہرست۔ سرچ اور پیجینیشن سپورٹ کرتا ہے۔
کوئری پیرامیٹرز
| پیرامیٹر | قسم | تفصیل | |
|---|---|---|---|
search |
string |
اختیاری | نام کے لحاظ سے فلٹر کریں (جزوی مماثلت) |
page |
integer |
اختیاری | صفحہ نمبر |
per_page |
integer |
اختیاری | فی صفحہ نتائج (زیادہ سے زیادہ 100) |
جواب HTTP 200
{"success":true,"data":[{"id":1,"name":"Demo Supplier","email":"ap@example.com","tax_id":"GB123456789","is_vat_registered":true}],"meta":{"current_page":1,"per_page":25,"total":1,"last_page":1}}
/api/v1/suppliers/{id}
اسکوپ: suppliers.get
ID کے ذریعے ایک سپلائر حاصل کریں۔
جواب HTTP 200
{"success":true,"data":{"id":1,"name":"Demo Supplier","email":"ap@example.com","phone":null,"tax_id":"GB123456789","is_overseas":false,"is_vat_registered":true,"reverse_charge":false}}
/api/v1/suppliers
اسکوپ: suppliers.post
نیا سپلائر بنائیں۔
درخواست کا متن (JSON)
| فیلڈ | قسم | تفصیل | |
|---|---|---|---|
name |
string |
لازمی | سپلائر کا نام |
email |
string |
اختیاری | ای میل ایڈریس |
phone |
string |
اختیاری | فون نمبر |
tax_id |
string |
اختیاری | VAT / ٹیکس رجسٹریشن نمبر |
is_overseas |
boolean |
اختیاری | آیا سپلائر بیرون ملک کا ہے (ڈیفالٹ: false) |
is_vat_registered |
boolean |
اختیاری | VAT رجسٹرڈ (پہلے سے طے شدہ: true) |
reverse_charge |
boolean |
اختیاری | ریورس چارج VAT لاگو ہوتا ہے (ڈیفالٹ: false) |
جواب HTTP 201
{"success":true,"data":{"id":15,"name":"Demo Supplier","email":"ap@example.com","tax_id":"GB123456789","is_vat_registered":true}}
انوائسز (Invoices)
/api/v1/invoices
اسکوپ: invoices.get
کسٹمر ریلیشن کے ساتھ تمام انوائسز کی فہرست۔ اسٹیٹس فلٹر اور پیجینیشن سپورٹ کرتا ہے۔
کوئری پیرامیٹرز
| پیرامیٹر | قسم | تفصیل | |
|---|---|---|---|
status |
string |
اختیاری | فلٹر: draft | unpaid | paid | void | overdue
|
page |
integer |
اختیاری | صفحہ نمبر |
per_page |
integer |
اختیاری | فی صفحہ نتائج (زیادہ سے زیادہ 100) |
جواب HTTP 200
{"success":true,"data":[{"id":101,"number":"INV-00101","date":"2026-06-01","due_date":"2026-07-01","status":"unpaid","total":5000.00,"customer":{"id":1,"name":"Demo Customer"}}],"meta":{"current_page":1,"per_page":25,"total":48,"last_page":2}}
/api/v1/invoices/{id}
اسکوپ: invoices.get
کسٹمر اور لائن آئٹمز کے ساتھ ایک انوائس حاصل کریں۔
جواب HTTP 200
{"success":true,"data":{"id":101,"number":"INV-00101","date":"2026-06-01","due_date":"2026-07-01","status":"unpaid","subtotal":4347.83,"tax_total":652.17,"total":5000.00,"customer":{"id":1,"name":"Demo Customer"},"lines":[{"id":1,"description":"Consulting services","qty":10,"unit_price":434.78,"total":4347.83}]}}
/api/v1/invoices
اسکوپ: invoices.post
نئی انوائس بنائیں۔ status=draft اور خودکار طور پر تیار کردہ نمبر کے ساتھ بنتی ہے۔
درخواست کا متن (JSON)
| فیلڈ | قسم | تفصیل | |
|---|---|---|---|
customer_id |
integer |
لازمی | موجودہ کسٹمر کا ID |
date |
date |
لازمی | انوائس کی تاریخ (YYYY-MM-DD) |
due_date |
date |
اختیاری | ادائیگی کی آخری تاریخ (YYYY-MM-DD) |
notes |
string |
اختیاری | داخلی یا صارف کے لیے نظر آنے والے نوٹس |
subtotal |
decimal |
اختیاری | ٹیکس سے پہلے کا کل (ڈیفالٹ: 0) |
tax_total |
decimal |
اختیاری | ٹیکس کی رقم (پہلے سے طے شدہ: 0) |
discount_total |
decimal |
اختیاری | رعایت کی رقم (ڈیفالٹ: 0) |
total |
decimal |
اختیاری | کل جمع (ڈیفالٹ: 0) |
جواب HTTP 201
{"success":true,"data":{"id":102,"number":"INV-00102","status":"draft","date":"2026-06-07","due_date":"2026-07-07","total":5000.00,"customer_id":1}}
/api/v1/invoices/{id}
اسکوپ: invoices.update
موجودہ ڈرافٹ انوائس کو اپ ڈیٹ کریں۔ تمام فیلڈز اختیاری ہیں۔
درخواست کا متن (JSON)
| فیلڈ | قسم | تفصیل | |
|---|---|---|---|
customer_id |
integer |
اختیاری | نیا کسٹمر ID |
date |
date |
اختیاری | انوائس کی تاریخ (YYYY-MM-DD) |
due_date |
date |
اختیاری | ادائیگی کی آخری تاریخ |
notes |
string |
اختیاری | نوٹس |
subtotal |
decimal |
اختیاری | ٹیکس سے پہلے کا کل |
tax_total |
decimal |
اختیاری | ٹیکس کی رقم |
total |
decimal |
اختیاری | کل جمع |
جواب HTTP 200
{"success":true,"data":{"id":102,"status":"draft","total":6000.00,"customer":{"id":1,"name":"Demo Customer"},"lines":[]}}
/api/v1/invoices/{id}/post
اسکوپ: invoices.post
ایک ڈرافٹ انوائس کو جنرل لیجر میں پوسٹ کریں۔ کل رقم > 0 اور تاریخ درکار ہے۔ حیثیت غیر ادا شدہ میں بدل جاتی ہے۔
جواب HTTP 200
{"success":true,"data":{"id":102,"status":"unpaid","posted_at":"2026-06-07T12:00:00Z","total":5000.00}}
ممکنہ غلطیاں:
invoice_already_posted,
invoice_total_required,
invoice_date_required
/api/v1/invoices/{id}/void
اسکوپ: invoices.void
پوسٹ شدہ انوائس منسوخ کریں۔ تمام لیجر اندراجات واپس ہو جاتے ہیں اور انوائس کو منسوخ شدہ نشان زد کیا جاتا ہے۔
جواب HTTP 200
{"success":true,"data":{"id":102,"status":"void"}}
/api/v1/invoices/{id}/mark-sent
اسکوپ: invoices.send
ڈرافٹ انوائس کو گاہک کو بھیجا گیا نشان زد کریں (حیثیت ڈرافٹ سے غیر ادا شدہ میں بدل جاتی ہے)۔ بار بار کرنے سے کوئی اثر نہیں ہوتا۔
جواب HTTP 200
{"success":true,"data":{"id":102,"status":"unpaid"}}
/api/v1/invoices/{id}
اسکوپ: invoices.delete
ڈرافٹ انوائس اور اس کی تمام قطاروں کو مستقل طور پر حذف کریں۔ پوسٹ شدہ انوائسز یا ادائیگی مختص شدہ انوائسز حذف نہیں ہو سکتیں۔
جواب HTTP 200
{"success":true,"data":{"message":"Invoice deleted."}}
ممکنہ غلطیاں:
posted_invoice_not_deletable,
invoice_has_allocations
خریداری کے بل
/api/v1/bills
اسکوپ: bills.get
تمام سپلائر بلز کی فہرست۔ اسٹیٹس فلٹر اور پیجینیشن سپورٹ کرتا ہے۔
کوئری پیرامیٹرز
| پیرامیٹر | قسم | تفصیل | |
|---|---|---|---|
status |
string |
اختیاری | فلٹر: draft | unpaid | paid | void
|
page |
integer |
اختیاری | صفحہ نمبر |
per_page |
integer |
اختیاری | فی صفحہ نتائج (زیادہ سے زیادہ 100) |
جواب HTTP 200
{"success":true,"data":[{"id":55,"number":"BILL-00055","date":"2026-06-01","status":"draft","total":2000.00,"supplier":{"id":3,"name":"Demo Supplier"}}],"meta":{"current_page":1,"per_page":25,"total":12,"last_page":1}}
/api/v1/bills/{id}
اسکوپ: bills.get
سپلائر اور لائن آئٹمز کے ساتھ ایک بل حاصل کریں۔
جواب HTTP 200
{"success":true,"data":{"id":55,"number":"BILL-00055","date":"2026-06-01","due_date":"2026-07-01","status":"draft","reference":"PO-001","total":2000.00,"supplier":{"id":3,"name":"Demo Supplier"},"lines":[]}}
/api/v1/bills
اسکوپ: bills.post
نیا سپلائر بل بنائیں۔ status=draft کے ساتھ بنایا جاتا ہے اور خودکار طور پر BILL-XXXXX نمبر دیا جاتا ہے۔
درخواست کا متن (JSON)
| فیلڈ | قسم | تفصیل | |
|---|---|---|---|
supplier_id |
integer |
لازمی | موجودہ سپلائر کا ID |
date |
date |
لازمی | بل کی تاریخ (YYYY-MM-DD) |
due_date |
date |
اختیاری | ادائیگی کی آخری تاریخ |
reference |
string |
اختیاری | سپلائر حوالہ / PO نمبر (زیادہ سے زیادہ 120) |
notes |
string |
اختیاری | داخلی نوٹس |
subtotal |
decimal |
اختیاری | ٹیکس سے پہلے کا کل (ڈیفالٹ: 0) |
tax_total |
decimal |
اختیاری | ٹیکس کی رقم (پہلے سے طے شدہ: 0) |
discount_total |
decimal |
اختیاری | رعایت (ڈیفالٹ: 0) |
total |
decimal |
اختیاری | کل جمع (ڈیفالٹ: 0) |
جواب HTTP 201
{"success":true,"data":{"id":56,"number":"BILL-00056","status":"draft","date":"2026-06-07","total":2000.00,"supplier_id":3}}
/api/v1/bills/{id}
اسکوپ: bills.update
موجودہ ڈرافٹ بل کو اپ ڈیٹ کریں۔ تمام فیلڈز اختیاری ہیں۔
درخواست کا متن (JSON)
| فیلڈ | قسم | تفصیل | |
|---|---|---|---|
supplier_id |
integer |
اختیاری | نیا سپلائر ID |
date |
date |
اختیاری | بل کی تاریخ |
due_date |
date |
اختیاری | ادائیگی کی آخری تاریخ |
reference |
string |
اختیاری | سپلائر حوالہ |
total |
decimal |
اختیاری | کل جمع |
جواب HTTP 200
{"success":true,"data":{"id":56,"status":"draft","total":2500.00,"supplier":{"id":3,"name":"Demo Supplier"}}}
/api/v1/bills/{id}/post
اسکوپ: bills.post
ایک ڈرافٹ بل کو جنرل لیجر میں پوسٹ کریں، جس سے واجب الادا رقم درج ہو جائے۔
جواب HTTP 200
{"success":true,"data":{"id":56,"status":"unpaid","posted_at":"2026-06-07T12:00:00Z"}}
ممکنہ غلطیاں:
bill_post_failed
/api/v1/bills/{id}
اسکوپ: bills.delete
ڈرافٹ بل کو مستقل طور پر حذف کریں۔ بل ڈرافٹ اسٹیٹس میں ہونا چاہیے اور اس پر کوئی ادائیگی مختص نہ ہو۔
جواب HTTP 200
{"success":true,"data":{"message":"Bill deleted."}}
ممکنہ غلطیاں:
posted_bill_not_deletable,
bill_has_allocations
ادائیگیاں
/api/v1/payments
اسکوپ: payments.get
تمام ادائیگیوں (رسیدیں اور ادائیگیاں) کی فہرست۔
کوئری پیرامیٹرز
| پیرامیٹر | قسم | تفصیل | |
|---|---|---|---|
type |
string |
اختیاری | فلٹر: receipt | disbursement
|
status |
string |
اختیاری | فلٹر: draft | posted
|
page |
integer |
اختیاری | صفحہ نمبر |
per_page |
integer |
اختیاری | فی صفحہ نتائج (زیادہ سے زیادہ 100) |
جواب HTTP 200
{"success":true,"data":[{"id":20,"type":"receipt","payment_date":"2026-06-07","amount_total":5000.00,"status":"draft","customer_id":1}],"meta":{"current_page":1,"per_page":25,"total":8,"last_page":1}}
/api/v1/payments
اسکوپ: payments.post
ادائیگی کی رسید (گاہک نے ادا کیا) یا ادائیگی (آپ نے سپلائر کو ادا کیا) درج کریں۔ اختیاری طور پر کسی انوائس یا بل کے مقابل مختص کریں۔
درخواست کا متن (JSON)
| فیلڈ | قسم | تفصیل | |
|---|---|---|---|
type |
string |
لازمی | receipt (کسٹمر کی ادائیگی) یا disbursement (سپلائر کی ادائیگی)
|
payment_date |
date |
لازمی | ادائیگی کی تاریخ (YYYY-MM-DD) |
amount_total |
decimal |
لازمی | کل ادا شدہ رقم (0 سے زیادہ ہونی چاہیے) |
method |
string |
اختیاری | ادائیگی کا طریقہ، مثلاً bank_transfer، cash، card |
reference |
string |
اختیاری | بینک ریفرنس یا چیک نمبر (زیادہ سے زیادہ 120) |
description |
string |
اختیاری | تفصیل یا میمو |
customer_id |
integer |
شرط | وصولی کی ادائیگیوں کے لیے درکار ہے (اگر document_type=ar_invoice ہو تو انوائس سے اخذ کیا جاتا ہے) |
supplier_id |
integer |
شرط | ادائیگی کے لیے درکار ہے (اگر document_type=ap_bill ہو تو بل سے اخذ کیا جاتا ہے) |
document_type |
string |
اختیاری | "ar_invoice" یا "ap_bill" — خودکار تخصیص شروع کرتا ہے |
document_id |
integer |
اختیاری | وہ انوائس یا بل کا ID جس کے خلاف مختص کرنا ہے (جب document_type سیٹ ہو تو لازمی) |
allocated_amount |
decimal |
اختیاری | مختص کرنے کی رقم (ڈیفالٹ amount_total) |
جواب HTTP 201
{"success":true,"data":{"id":21,"type":"receipt","payment_date":"2026-06-07","amount_total":5000.00,"status":"draft","allocations":[{"document_type":"ar_invoice","document_id":101,"allocated_amount":5000.00}]}}
ممکنہ خرابیاں:
document_required,
document_type_mismatch,
invoice_not_found,
bill_not_found,
client_required,
supplier_required
جرنل انٹریز
/api/v1/journal-entries
اسکوپ: journal_entries.get
لائنز اور اکاؤنٹس کے ساتھ جرنل اندراجات کی فہرست۔ تاریخ کی حد کا فلٹر سپورٹ کرتا ہے۔
کوئری پیرامیٹرز
| پیرامیٹر | قسم | تفصیل | |
|---|---|---|---|
status |
string |
اختیاری | فلٹر: draft | posted
|
from |
date |
اختیاری | شروع کی تاریخ (YYYY-MM-DD) |
to |
date |
اختیاری | اختتامی تاریخ (YYYY-MM-DD) |
page |
integer |
اختیاری | صفحہ نمبر |
per_page |
integer |
اختیاری | فی صفحہ نتائج (زیادہ سے زیادہ 100) |
جواب HTTP 200
{"success":true,"data":[{"id":5,"entry_date":"2026-06-07","reference":"JE-001","status":"posted","lines_count":2}],"meta":{"current_page":1,"per_page":25,"total":5,"last_page":1}}
/api/v1/journal-entries
اسکوپ: journal_entries.post
متوازن جرنل انٹری بنائیں اور فوراً پوسٹ کریں۔ کل ڈیبٹ اور کل کریڈٹ برابر ہونے چاہییں (رواداری ±0.01)۔
درخواست کا متن (JSON)
| فیلڈ | قسم | تفصیل | |
|---|---|---|---|
date |
date |
لازمی | اندراج کی تاریخ (YYYY-MM-DD) |
reference |
string |
اختیاری | حوالہ کوڈ مثلاً JE-001 (زیادہ سے زیادہ 120) |
description |
string |
اختیاری | میمو / تفصیل (زیادہ سے زیادہ 2000) |
lines |
array |
لازمی | کم از کم 2 قطاریں۔ ہر قطار: account_id (لازمی)، debit (اعشاریہ)، credit (اعشاریہ)، description (سٹرنگ) |
جواب HTTP 201
{"success":true,"data":{"id":6,"entry_date":"2026-06-07","reference":"JE-001","status":"posted","posted_at":"2026-06-07T12:00:00Z","lines":[{"account_id":101,"account":{"code":"1100","name":"Cash"},"debit":1000,"credit":0},{"account_id":202,"account":{"code":"3000","name":"Equity"},"debit":0,"credit":1000}]}}
ممکنہ غلطیاں:
journal_not_balanced
/api/v1/journal-entries/{id}
اسکوپ: journal_entries.delete
غیر پوسٹ شدہ جرنل اندراج حذف کریں۔ پوسٹ شدہ اندراجات API کے ذریعے حذف نہیں ہو سکتے۔
جواب HTTP 200
{"success":true,"data":{"message":"Journal entry deleted."}}
ممکنہ غلطیاں:
posted_journal_not_deletable
رپورٹس
تمام رپورٹ اینڈ پوائنٹس ?from=YYYY-MM-DD&to=YYYY-MM-DD قبول کرتے ہیں۔ بیلنس شیٹ، ٹرائل بیلنس اور ایجنگ رپورٹس ?as_of=YYYY-MM-DD بھی قبول کرتی ہیں (جو to کے برابر ہے)۔
/api/v1/reports/income-statement
اسکوپ: reports.income_statement
نفع و نقصان کی رپورٹ۔ مخصوص مدت کے لیے آمدنی، اخراجات اور خالص آمدنی دکھاتی ہے۔
کوئری پیرامیٹرز
| پیرامیٹر | قسم | تفصیل | |
|---|---|---|---|
from |
date |
اختیاری | مدت کا آغاز (YYYY-MM-DD) |
to |
date |
اختیاری | مدت کا اختتام (YYYY-MM-DD) |
جواب HTTP 200
{"success":true,"data":{"revenue":150000,"expenses":85000,"net_income":65000}}
/api/v1/reports/balance-sheet
اسکوپ: reports.balance_sheet
بیلنس شیٹ کا اسنیپ شاٹ۔ مخصوص تاریخ تک اثاثے، واجبات اور ایکویٹی واپس کرتا ہے۔
کوئری پیرامیٹرز
| پیرامیٹر | قسم | تفصیل | |
|---|---|---|---|
to |
date |
اختیاری | کا تاریخی دن (YYYY-MM-DD)۔ ?as_of= کے طور پر بھی قبول ہے |
جواب HTTP 200
{"success":true,"data":{"assets":{"total":250000},"liabilities":{"total":80000},"equity":{"total":170000}}}
/api/v1/reports/cash-flow
اسکوپ: reports.cash_flow
مخصوص مدت کے لیے کیش فلو اسٹیٹمنٹ (ڈائریکٹ طریقہ)۔
کوئری پیرامیٹرز
| پیرامیٹر | قسم | تفصیل | |
|---|---|---|---|
from |
date |
اختیاری | مدت کا آغاز |
to |
date |
اختیاری | مدت کا اختتام |
جواب HTTP 200
{"success":true,"data":{"operating":45000,"investing":-12000,"financing":-8000,"net_change":25000}}
/api/v1/reports/trial-balance
اسکوپ: reports.trial_balance
ٹرائل بیلنس جس میں تاریخ کے مطابق تمام اکاؤنٹس کے ڈیبٹ اور کریڈٹ کل دکھائے جاتے ہیں۔
کوئری پیرامیٹرز
| پیرامیٹر | قسم | تفصیل | |
|---|---|---|---|
to |
date |
اختیاری | کا تاریخی دن (YYYY-MM-DD) |
جواب HTTP 200
{"success":true,"data":[{"account_code":"1100","account_name":"Cash","debit":50000,"credit":0},{"account_code":"2000","account_name":"Accounts Payable","debit":0,"credit":15000}]}
/api/v1/reports/ar-aging
اسکوپ: reports.ar_aging
قابلِ وصول کھاتوں کی عمر بندی۔ بقایا کسٹمر انوائسز ان کی تاخیر کے لحاظ سے درجہ بند۔
کوئری پیرامیٹرز
| پیرامیٹر | قسم | تفصیل | |
|---|---|---|---|
to |
date |
اختیاری | عمر کی گنتی کی as-of تاریخ (YYYY-MM-DD) |
جواب HTTP 200
{"success":true,"data":{"current":12000,"1_30":3500,"31_60":800,"61_90":0,"over_90":500,"total":16800}}
/api/v1/reports/ap-aging
اسکوپ: reports.ap_aging
قابلِ ادائیگی کھاتوں کی عمر بندی۔ بقایا سپلائر بلز ان کی تاخیر کے لحاظ سے درجہ بند۔
کوئری پیرامیٹرز
| پیرامیٹر | قسم | تفصیل | |
|---|---|---|---|
to |
date |
اختیاری | عمر کی گنتی کی as-of تاریخ (YYYY-MM-DD) |
جواب HTTP 200
{"success":true,"data":{"current":8000,"1_30":1200,"31_60":0,"61_90":0,"over_90":0,"total":9200}}
/api/v1/reports/tax
اسکوپ: reports.tax
VAT / ٹیکس کا خلاصہ۔ مدت کے لیے فروخت پر وصول کیا گیا ٹیکس اور خریداری پر ادا کیا گیا ٹیکس دکھاتا ہے۔
کوئری پیرامیٹرز
| پیرامیٹر | قسم | تفصیل | |
|---|---|---|---|
from |
date |
اختیاری | مدت کا آغاز |
to |
date |
اختیاری | مدت کا اختتام |
جواب HTTP 200
{"success":true,"data":{"tax_collected":15000,"tax_paid":4200,"net_vat_payable":10800}}
خرابی کا حوالہ
| خرابی کا کوڈ | HTTP | معنی |
|---|---|---|
invoice_already_posted |
422 | انوائس پہلے ہی لیجر میں پوسٹ ہو چکی ہے |
invoice_total_required |
422 | صفر یا منفی کل رقم والا انوائس پوسٹ نہیں کیا جا سکتا |
invoice_date_required |
422 | پوسٹ کرنے سے پہلے دستاویز کی تاریخ لازمی ہے |
posted_invoice_not_deletable |
422 | انوائس حذف کرنے سے پہلے اسے منسوخ یا ان پوسٹ کریں |
invoice_has_allocations |
422 | حذف کرنے سے پہلے ادائیگی کی تخصیصات ہٹائیں |
posted_bill_not_deletable |
422 | پوسٹ شدہ یا غیر مسودہ بل حذف نہیں ہو سکتا |
bill_has_allocations |
422 | حذف کرنے سے پہلے ادائیگی کی تخصیصات ہٹائیں |
bill_post_failed |
422 | بل اندرونی پوسٹ کی توثیق میں ناکام رہا |
journal_not_balanced |
422 | کل ڈیبٹس کل کریڈٹس کے برابر نہیں |
posted_journal_not_deletable |
422 | صرف ڈرافٹ (غیر پوسٹ شدہ) اندراجات حذف کیے جا سکتے ہیں |
document_required |
422 | جب document_type مقرر ہو تو document_id لازمی ہے
|
document_type_mismatch |
422 | ar_invoice کے لیے receipt درکار ہے؛ ap_bill کے لیے disbursement درکار ہے
|
invoice_not_found |
404 | اس ID والی انوائس موجود نہیں ہے |
bill_not_found |
404 | اس ID کا بل موجود نہیں ہے |
client_required |
422 | receipt ادائیگیوں کے لیے customer_id لازمی ہے
|
supplier_required |
422 | disbursement ادائیگیوں کے لیے supplier_id لازمی ہے
|
صفحہ بندی
تمام لسٹ اینڈ پوائنٹس صفحہ بندی شدہ نتائج واپس کرتے ہیں۔ صفحہ بندی کو کوئری پیرامیٹرز سے کنٹرول کریں:
| پیرامیٹر | طے شدہ | زیادہ سے زیادہ | تفصیل |
|---|---|---|---|
page | 1 | — | حاصل کرنے کے لیے صفحہ نمبر |
per_page | 25 | 100 | فی صفحہ نتائج کی تعداد |
ہر فہرست کے جواب میں meta آبجیکٹ میں current_page، per_page، total اور last_page شامل ہوتے ہیں۔