متد AccountingReport
این متد برای دریافت تراکنش (آرتیکل) های حسابداری مربوط به حساب کاربری شما استفاده می گردد و کاربرد آن برای مغایرت گیری می باشد.
این متد حداکثر 1000 عدد رکورد (تراکنش یا همان آرتیکل) خروجی می دهد. در صورتی که بازه تاریخی درخواست شما بزرگ باشد و سیستم بیش از 1000 عدد رکورد برگشت دهد، می بایست Id آخرین رکورد که این متد خروجی داده است را بدست آورده و مجددا یک درخواست جدید ارسال نمایید که LastRecordId آن، Id آخرین رکورد قبلی باشد.
API Endpoint
https://{SupplierWebsiteUrl}/api/Partners/Generic/AccountingReport/V1 post
Request Parameters
نمونه کلاس Request به زبان سی شارپ در پروژه Partners.Contracts (دانلود) در پوشه زیر موجود است:
\Generic\AccountingReport\V1\RequestModel
Username
string
نام کاربری
Password
string
رمز عبور به صورت MD5 شده
FromDate
string
تاریخ شروع برای فیلتر کردن آرتیکل های حسابداری با فرمت yyyy-MM-dd میلادی.
ToDate
string
تاریخ پایان برای فیلتر کردن آرتیکل های حسابداری با فرمت yyyy-MM-dd میلادی.
LastRecordId
string
این فیلد برای بدست آوردن 1000 عدد رکورد بعدی استفاده می گردد.
بدین صورت که هر عددی را به عنوان مقدر این فیلد ارسال نمایید، سیستم 1000 رکورد بعدی را خروجی میدهد.
برای اولین درخواستی که ارسال میفرمایین، این فیلد باید null باشد و در صورتی که بیش از 1000 رکورد برگشت داده شد، می بایست Id آخرین رکورد جواب قبلی را داخل این فیلد گذاشته و مجددا یک درخواست جدید ارسال نمایید.
{
"Username": "testdev1",
"Password": "25f9e794323b453885f5181f1b624d0b",
"FromDate": "2022-11-25",
"ToDate": "2022-11-28",
"LastRecordId": null
}
Response Data
نمونه کلاس Response به زبان سی شارپ در پروژه Partners.Contracts (دانلود) در پوشه زیر موجود است:
\Generic\AccountingReport\V1\ResponseModel
RemainingBalanceFromPast
Complex type
مانده از قبل
Debit
number
مجموع کل بدهکاری شما تا قبل از تاریخ FromDate که در Request ارسال نموده اید
Credit
number
مجموع کل بستانکاری شما تا قبل از تاریخ FromDate که در Request ارسال نموده اید
Balance
number
مجموع کل بالانس (تفاوت بدهکاری و بستانکاری) شما تا قبل از تاریخ FromDate که در Request ارسال نموده اید
ArticleList
Complex type
لیست تراکنش (آرتیکل) های حسابداری که در حساب شما منظور شده است
Id
number
شناسه یکتا مربوط به یک آرتیکل
در صورتی که تعداد رکوردها بیش از 1000 عدد باشد، از این فیلد برای ارسال یک درخواست جدید و با قرار دادن مقدار آن در فیلد LastRecordId استفاده خواهد شد.
Date
string
تاریخ ثبت تراکنش به صورت میلادی و با فرمت yyyy-MM-dd
Desc
string
شرح تراکنش
لطفا توجه داشته باشید که سپهر ممکن است بدون اطلاع قبلی فرمت شرح تراکنش را تغییر دهد. بنابراین در صورتی که شما قصد Parse کردن این شرح توسط regex یا روش های مشابه را دارید، ریسک این تغییر را در نظر داشته باشید.
Debit
number
مبلغ بدهکاری که بابت این تراکنش در حساب شما منظور شده است.
Credit
number
مبلغ بستانکاری که بابت این تراکنش در حساب شما منظور شده است.
{
"RemainingBalanceFromPast": {
"Debit": 3720501129,
"Credit": 3602875224,
"Balance": 0
},
"ArticleList": [
{
"Id": 638070,
"Date": "2022-11-26",
"Desc": "فروش هتل _ يک تخته پرزيدنت ميراژ _ 2 شب ورود 01/10/05 _ ALI SHABANI _ MARYAM SALAMI _ رفرنس V2N7FV _ واچر 215267",
"Debit": 30352140,
"Credit": 0
},
{
"Id": 638110,
"Date": "2022-11-27",
"Desc": "فروش هتل _ يک تخته پرزيدنت ميراژ _ 2 شب ورود 01/09/25 _ SINA KAZEMI YAZDI _ MARYAM SALAMI _ رفرنس L5Y24Y _ واچر 215278",
"Debit": 30788140,
"Credit": 0
},
{
"Id": 638149,
"Date": "2022-11-27",
"Desc": "فروش هتل _ يک تخته پرزيدنت ميراژ _ 1 شب ورود 01/09/07 _ AKBAR KABIRI _ ASQAR SAQIRI _ رفرنس V325A5 _ واچر 215284",
"Debit": 16350000,
"Credit": 0
},
{
"Id": 638157,
"Date": "2022-11-27",
"Desc": "استرداد استرداد هتل _ يک تخته پرزيدنت ميراژ _ 1 شب ورود 01/09/07 _ AKBAR KABIRI _ ASQAR SAQIRI _ رفرنس V325A5 _ واچر 215284",
"Debit": 0,
"Credit": 11350000
},
{
"Id": 638163,
"Date": "2022-11-27",
"Desc": "واريز اينترنتي توسط درگاه بانک پاسارگاد _ تست ادمين1",
"Debit": 0,
"Credit": 183766185
}
]
}