generic

متد CurrentBalance

این متد برای دریافت باقی مانده اعتبار و همچنین مهلت پرداخت کاربرد دارد.

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

API Endpoint

POST https://{SupplierWebsiteUrl}/api/Partners/Generic/CurrentBalance/V3

Request Parameters

Username

string

required

نام کاربری
Password

string

required

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

Sample Request

{
  "Username": "your username",
  "Password": "your MD5 of password"
}

Response Parameters

TotalDebit

number

مجموع کل گردش بدهکاری حساب شما.

کاربرد مقدار این فیلد برای زمانی است که شما سیستم مغایرت گیری بین سایت خود و سایت تامین کننده ایجاد کرده باشید و با استفاده از این فیلد می توانید مغایرت حساب احتمالی بین خود و تامین کننده را متوجه شوید.
TotalCredit

number

مجموع کل گردش بستانکاری حساب شما.

کاربرد مقدار این فیلد برای زمانی است که شما سیستم مغایرت گیری بین سایت خود و سایت تامین کننده ایجاد کرده باشید و با استفاده از این فیلد می توانید مغایرت حساب احتمالی بین خود و تامین کننده را متوجه شوید.
Balance

number

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

کاربرد مقدار این فیلد برای زمانی است که شما سیستم مغایرت گیری بین سایت خود و سایت تامین کننده ایجاد کرده باشید و با استفاده از این فیلد می توانید مغایرت حساب احتمالی بین خود و تامین کننده را متوجه شوید.
AssignedCredit

number

مقدار اعتباری که تامین کننده در ابتدا به حساب کاربری شما اختصاص داده است.

در صورتی که تامین کننده هیچ اعتباری به کاربر شما نداده باشد و برای خرید نیاز باشد که شما اکانت خود را ابتدا شارژ نمایید، مقدار این فیلد صفر خواهد بود
RemainedCredit

number

مقدار اعتبار باقی مانده

هر خریدی که انجام دهید، اعتبار باقی مانده کاهش پیدا می کند. و هر بار که حساب خود را شارژ نمایید اعتبار باقی مانده افزایش پیدا می کند.

میزان اعتبار باقی مانده در زمان رزرو بررسی می شود و در صورتی که مبلغ رزرو شما بیش از اعتبار باقی مانده باشد، سیستم خطا داده و اجازه رزرو نمی دهد. بنابراین پیشنهاد میشود میزان اعتبار باقی مانده را همیشه به کاربر مدیر سایت خود نمایش داده تا در صورتی که میزان آن از حدی کمتر شد، مدیر سایت شما اقدام به شارژ حساب خود نزد تامین کننده نماید.
CurrencyCode

string

این فیلد مشخص می کند که نرخ های برگشتی بر اساس چه ارزی می باشد. مقدار آن بستگی به این دارد که ارز کاربر شما در سایت تامین کننده چه چیزی تعیین شده باشد. مثلا اگر کاربر شما به صورت ریالی باشد مقدار آن IRR و اگر دلاری باشد مقدار آن USD خواهد بود.
PaymentDueMinutes

nullable number

مهلت پرداخت باقی مانده به دقیقه.

در صورتی که تامین کننده برای حساب کاربری شما مهلت پرداخت تعیین کرده باشد (یعنی مقدار آن null نباشد) و در صورتی که مهلت پرداخت به اتمام رسد، سیستم اجازه صدور رزرو به شما نخواهد داد

Sample Response - مهلت پرداخت نامحدود

{
    "TotalDebit": 12256463860.00,
    "TotalCredit": 11043956457.00,
    "Balance": -1212507403.00,
    "AssignedCredit": 500000000000.00,
    "RemainedCredit": 498787492597.00,
    "CurrencyCode": "IRR",
    "PaymentDueMinutes": null
}

Sample Response - دارای مهلت پرداخت

{
    "TotalDebit": 12256463860.00,
    "TotalCredit": 11043956457.00,
    "Balance": -1212507403.00,
    "AssignedCredit": 500000000000.00,
    "RemainedCredit": 498787492597.00,
    "CurrencyCode": "IRR",
    "PaymentDueMinutes": 10080
}