#P1382
POST /api/v2/colleagues/billing
Route Info
این متد برای دریافت اطلاعات مالی کلی یک همکار (Colleague) یا پرسنل (Personnel) استفاده میشود. مسیر (Route) و میانافزارهای امنیتی آن به شرح زیر است:
| HTTP Method | Route | Controller | Function | Middleware |
|---|---|---|---|---|
| POST | /api/v2/colleagues/billing | ColleaguesController | general_billingV2 | domainAccess, ipTrust |
Request Parameters
این متد یک پارامتر ورودی اصلی با نام id را از بدنهی درخواست دریافت میکند.
| نام پارامتر | نوع داده | الزامی | توضیحات |
|---|---|---|---|
| id | string | بله | شناسه مربوط به همکار یا پرسنل. اگر مقدار شامل - باشد، نوع از مقدار استخراج میگردد، در غیر این صورت مقدار نوع برابر colleague فرض میشود. |
Processing Logic
منطق عملکرد متد بر اساس کد موجود در کنترلر به شرح زیر میباشد:
- ابتدا مقدار $request->id بررسی میشود.
- اگر این مقدار شامل خط تیره (
-) باشد، نوع (type) و شناسه (id) از آن استخراج میشود؛ در غیر این صورت نوع پیشفرض colleague در نظر گرفته میشود. - در صورتی که نوع برابر با colleague باشد، تابع CronController::colleaguesGeneralBilling($id) فراخوانی شده تا مانده سال جاری حساب محاسبه گردد.
- خروجی برای نوع
colleagueبهصورت زیر است:
{
"CreditLimit": {credit_amount},
"CreditBalance": {credit_amount - balance}
}
در صورتی که
type = personnel باشد:{
"CreditLimit": false,
"CreditBalance": false
}
Error Handling
در صورتی که شرکت (همکار) یافت نشود یا اطلاعات نادرست باشد، پاسخ زیر بازگردانده میشود:
HTTP 200 OK
{
"status": false,
"message": "اطلاعات شرکت بدرستی ارسال نشده است."
}
Response Example
| نوع درخواست | کد وضعیت | نمونه پاسخ |
|---|---|---|
| موفق (Colleague) | 200 OK |
{
"CreditLimit": 5000000,
"CreditBalance": 2750000
}
|
| پرسنل | 200 OK |
{
"CreditLimit": false,
"CreditBalance": false
}
|
Notes
- پاسخ همواره با وضعیت HTTP 200 بازگردانده میشود، حتی در حالت خطا.
- این متد صرفاً جهت خواندن وضعیت مالی کل سال جاری طراحی شده است و هیچ تغییری در دادههای اصلی ایجاد نمیکند.
- محاسبه مانده و سقف اعتبار بر مبنای اطلاعات ثبتشده در حسابداری داخلی سیستم انجام میشود.
- این متد صرفاً جهت خواندن وضعیت مالی کل سال جاری طراحی شده است و هیچ تغییری در دادههای اصلی ایجاد نمیکند.
- محاسبه مانده و سقف اعتبار بر مبنای اطلاعات ثبتشده در حسابداری داخلی سیستم انجام میشود.