مستندات وب سرویس

متد AccountingReport

Download Markdown for LLM

این متد برای دریافت تراکنش (آرتیکل) های حسابداری مربوط به حساب کاربری شما استفاده می گردد و کاربرد آن برای مغایرت گیری می باشد.

این متد حداکثر 1000 عدد رکورد (تراکنش یا همان آرتیکل) خروجی می دهد. در صورتی که بازه تاریخی درخواست شما بزرگ باشد و سیستم بیش از 1000 عدد رکورد برگشت دهد، می بایست Id آخرین رکورد که این متد خروجی داده است را بدست آورده و مجددا یک درخواست جدید ارسال نمایید که LastRecordId آن، Id آخرین رکورد قبلی باشد.

تفاوت ورژن فعلی با ورژن قبلی این متد این است که در خروجی response model فیلد YourLocalInventoryPnr اضافه شده است.

هشدار

اطلاعات ارائه‌شده توسط این متد، بر اساس اطلاعات موجود در سیستم حسابداری تأمین‌کننده است. با توجه به اینکه ممکن است این اطلاعات توسط تأمین‌کننده تغییر کند (برای مثال، یک سند حسابداری حذف، اصلاح یا سند جدیدی به حساب اضافه شود)، توصیه می‌شود اطلاعات دریافتی از این متد را همواره با اطلاعات ثبت‌شده در سیستم حسابداری داخلی خود مطابقت دهید.

بنابراین، برای تعیین میزان بدهکاری یا بستانکاری خود به تأمین‌کننده، صرفاً به اطلاعات خروجی این متد اتکا نکنید و پیش از انجام هرگونه واریز وجه به حساب تأمین‌کننده، حتماً وضعیت حساب را در سیستم حسابداری داخلی خود بررسی و با اطلاعات تأمین‌کننده تطبیق دهید.

مثال: ممکن است یک سند مربوط به واریز وجه شما، به‌صورت سهوی یا عمدی توسط تأمین‌کننده از سیستم حسابداری حذف شود. در این حالت، اگر وضعیت حساب را با سیستم حسابداری داخلی خود تطبیق نداده باشید و صرفاً بر اساس اطلاعات خروجی این متد اقدام کنید، ممکن است در حالی که واقعاً بدهکاری به تأمین‌کننده ندارید، مجدداً وجهی به حساب تأمین‌کننده واریز کنید.


API Endpoint

POST https://{SupplierWebsiteUrl}/api/Partners/Generic/AccountingReport/V2

Request Parameters

  • Username

    string

    required

    نام کاربری

  • Password

    string

    required

    رمز عبور به صورت MD5 شده

  • FromDate

    string

    required

    تاریخ شروع برای فیلتر کردن آرتیکل های حسابداری با فرمت yyyy-MM-dd میلادی.

  • ToDate

    string

    required

    تاریخ پایان برای فیلتر کردن آرتیکل های حسابداری با فرمت yyyy-MM-dd میلادی.

  • LastRecordId

    string

    optional

    این فیلد برای بدست آوردن 1000 عدد رکورد بعدی استفاده می گردد.

    بدین صورت که هر عددی را به عنوان مقدر این فیلد ارسال نمایید، سیستم 1000 رکورد بعدی را خروجی میدهد.

    برای اولین درخواستی که ارسال میفرمایین، این فیلد باید null باشد و در صورتی که بیش از 1000 رکورد برگشت داده شد، می بایست Id آخرین رکورد جواب قبلی را داخل این فیلد گذاشته و مجددا یک درخواست جدید ارسال نمایید.


Sample Request

curl -X POST https://SepehrApiTest.ir/api/Partners/Generic/AccountingReport/V2 \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "Accept: application/json" \
  -H "Accept-Encoding: gzip, deflate" \
  -d '{
  "Username": "testdev1",
  "Password": "25f9e794323b453885f5181f1b624d0b",
  "FromDate": "2022-11-25",
  "ToDate": "2022-11-28",
  "LastRecordId": null
}'

Response Parameters

  • RemainingBalanceFromPast

    Complex type

    مانده از قبل

    + نمایش ویژگی‌های زیرمجموعه

    • RemainingBalanceFromPast.Debit

      number

      مجموع کل بدهکاری شما تا قبل از تاریخ FromDate که در Request ارسال نموده اید

    • RemainingBalanceFromPast.Credit

      number

      مجموع کل بستانکاری شما تا قبل از تاریخ FromDate که در Request ارسال نموده اید

    • RemainingBalanceFromPast.Balance

      number

      مجموع کل بالانس (تفاوت بدهکاری و بستانکاری) شما تا قبل از تاریخ FromDate که در Request ارسال نموده اید

  • ArticleList

    Complex type

    لیست تراکنش (آرتیکل) های حسابداری که در حساب شما منظور شده است

    + نمایش ویژگی‌های زیرمجموعه

    • ArticleList.Id

      number

      شناسه یکتا مربوط به یک آرتیکل

      در صورتی که تعداد رکوردها بیش از 1000 عدد باشد، از این فیلد برای ارسال یک درخواست جدید و با قرار دادن مقدار آن در فیلد LastRecordId استفاده خواهد شد.

    • ArticleList.Date

      string

      تاریخ ثبت تراکنش به صورت میلادی و با فرمت yyyy-MM-dd

    • ArticleList.Desc

      string

      شرح تراکنش

      لطفا توجه داشته باشید که سپهر ممکن است بدون اطلاع قبلی فرمت شرح تراکنش را تغییر دهد. بنابراین در صورتی که شما قصد Parse کردن این شرح توسط regex یا روش های مشابه را دارید، ریسک این تغییر را در نظر داشته باشید.

    • ArticleList.Debit

      number

      مبلغ بدهکاری که بابت این تراکنش در حساب شما منظور شده است.

    • ArticleList.Credit

      number

      مبلغ بستانکاری که بابت این تراکنش در حساب شما منظور شده است.

    • ArticleList.YourLocalInventoryPnr

      string

      رفرنس سیستم داخلی شما در زمان فراخوانی متد Book آن را به سیستم تامین کننده ارسال کرده اید.


Sample Response

{
  "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,
      "YourLocalInventoryPnr": "954a1632-7c5a-4bbc-9d1b-16533610e674"
    },
    {
      "Id": 638110,
      "Date": "2022-11-27",
      "Desc": "فروش هتل _ يک تخته پرزيدنت ميراژ _ 2 شب ورود 01/09/25 _ SINA KAZEMI YAZDI  _ MARYAM SALAMI  _ رفرنس L5Y24Y _ واچر 215278",
      "Debit": 30788140,
      "Credit": 0,
      "YourLocalInventoryPnr": "e4c302c6-b15b-421f-8aa2-86b97b3ef2ce"
    },
    {
      "Id": 638149,
      "Date": "2022-11-27",
      "Desc": "فروش هتل _ يک تخته پرزيدنت ميراژ _ 1 شب ورود 01/09/07 _ AKBAR KABIRI  _ ASQAR SAQIRI  _ رفرنس V325A5 _ واچر 215284",
      "Debit": 16350000,
      "Credit": 0,
      "YourLocalInventoryPnr": "84fb0ad5-87a1-4c02-bcf7-00d0fbff7cb5"
    },
    {
      "Id": 638157,
      "Date": "2022-11-27",
      "Desc": "استرداد استرداد هتل _ يک تخته پرزيدنت ميراژ _ 1 شب ورود 01/09/07 _ AKBAR KABIRI  _ ASQAR SAQIRI  _ رفرنس V325A5 _ واچر 215284",
      "Debit": 0,
      "Credit": 11350000,
      "YourLocalInventoryPnr": null
    },
    {
      "Id": 638163,
      "Date": "2022-11-27",
      "Desc": "واريز اينترنتي توسط درگاه  بانک پاسارگاد _ تست ادمين1",
      "Debit": 0,
      "Credit": 183766185,
      "YourLocalInventoryPnr": null
    }
  ]
}