استعلام قبوض
خدمت‌دهنده
عصر داده
مقدمه
با استفاده از سرویس های قبض عصر داده میتوانید قبض های خود را به صورت تکی یا گروهی دسته بندی کرده و استعلام کنید.
پیش از شروع
- URL فراخوانی سرویس ها: https://api.pod.ir/srv/sc/nzh/doServiceCall
- تمامی درخواست ها با متد POST ارسال میشوند.
- Header درخواست:
پارامترهای زیر در Header تمام درخواست ها ثابت است:
| پارامتر | توضیحات |
|---|---|
| _token_ | API token دریافتی از پنل کسب و کاری |
| _token_issuer_ | این پارامتر دارای مقدار ثابت "1" است. |
| Content-Type | application/x-www-form-urlencoded |
| Authorization | دریافتی از سرویس دریافت توکن |
- بدنه درخواست:
پارامترهای زیر در بدنه تمام درخواست ها ثابت است:
| پارامتر | توضیحات |
|---|---|
| scProductId | شناسه سرویس در حال استفاده |
| scApiKey | API Key دریافتی برای سرویس مورد نظر از پنل کسب و کاری |
- json Object ها در پارامتری به نام body ارسال میشوند.
- ساختار پاسخ دریافتی پس از فراخوانی سرویس به صورت زیر است که پاسخ دریافتی از endpoint مورد نظر در پارامتر result قرار دارد.
دریافت توکن
برای استفاده از تمامی سرویس ها می بایست ابتدا با استفاده از این سرویس توکن را دریافت نموده و در پارامتر Authorization در هدر درخواست ارسال کنید.
-
شناسه سرویس: 46742
-
پارامترهای ورودی
ندارد.
پاسخ برگشتی: Json با پارامترهای زیر:
| پارامتر | نوع | توضیحات |
|---|---|---|
| token_type | String | نوع توکن |
| access_token | String | توکن دسترسی |
توجه : فرمت ارسال توکن در پارامتر Authorization به صورت زیر است:
Authorization: [token_type] [access_token]
استعلام قبوض
از این سرویس برای استعلام انواع قبض استفاده میشود.
-
شناسه سرویس: 55265
-
پارامترهای ورودی
یک json با ساختار و پارامترهای زیر:
| پارامتر | توضیحات |
|---|---|
| Type | نوع قبض: قبض آب - Water قبض برق - Electricity قبض گاز با شماره اشتراک - Gas قبض گاز با شناسه قبض - GasByBillId تلفن ثابت (پایان دوره) - Tel تلفن ثابت (میان دوره) - TelNow قبوض تلفن ثابت - TelBills تلفن همراه (پایان دوره) - Mobile تلفن همراه (میان دوره) - MobileNow قبوض تلفن همراه - MobileBills دیتا مخابرات - TCLData |
| Parameter | مقدار مورد استعلام: شناسه قبض: برای Water و Electricity و GasByBillId برای Gas: شماره اشتراک برای Tel و TelNow و TelBills: شماره تلفن همراه برای TCIData : شماره پرونده دیتای مخابرات |
| SecondParameter (اختیاری) | مقدار دوم استعلام: در استعلام قبوض تلفن همراه، نام اپراتور می تواند به عنوان پارامتر دوم ارسال شود. اگر خط تلفن همراه ترابرد شده باشد ارسال این پارامتر الزامی است. (همراه اول: MCI ، رایتل: Rightel ، ایرانسل: Irancell)
|
| Info (اختیاری) | جزئیات قبض (مقدار: "0" برای غیرفعال بودن Info و "1" برای فعال بودن Info) نکته: برای نوع قبض "تلفن همراه", |
نمونه json ارسالی:
| مقدار | پارامتر |
|---|---|
| کد | Status |
| پیام | Message |
| برای قبوض آب، برق،گاز، تلفن و موبایل (پایان دوره و میان دوره مجزا) شی اطلاعات قبض شامل Amount – مبلغ قبض BillId – شناسه قبض PayId – شناسه پرداخت Date – مهلت پرداخت Info( شی حاوی سایر اطلاعات قبض مانند جدول 1) | Data |
در غیر اینصورت:
| مقدار | کلید |
|---|---|
| کد خطا | Status |
| پیام خطا | Message |
از آنجا که خطوط اعتباری، پیش پرداخت هستند قبضی برای آنها صادر نمی شود
استعلام دسته ای
با استفاده از این سرویس میتوان یک آرایه (دسته) قبض را استعلام نمود.
-
شناسه سرویس: 43962
-
پارامترهای ورودی
یک json با ساختار و پارامترهای زیر:
| توضیحات | نام پارامتر |
|---|---|
| آرایه ای از قبوض شامل: Type : نوع پارامتر Parameter: مقدار پارامتر SecondParameter: مقدار پارامتر دوم Info: جزئیات قبض | Bills |
- پاسخ برگشتی:
در صورت استعلام موفق فیلدهای خروجی به صورت Json:
| مقدار | پارامتر |
|---|---|
| کد | Status |
| پیام | Message |
| Result : شامل آرایه ای از جواب ها برای هر پارامتر شامل: Status: کد Message : پیام Data: برای قبوض آب، برق،گاز، تلفن و موبایل شی اطلاعات قبض شامل: Amount – مبلغ قبض BillId – شناسه قبض PayId – شناسه پرداخت Date – مهلت پرداخت Info ( شی حاوی سایر اطلاعات قبض مانند جدول 1) | Data |
در غیر اینصورت :
| مقدار | پارامتر |
|---|---|
| کد خطا | Status |
| پیام خطا | Message |
دریافت تاریخچه قبوض
با استفاده از این سرویس میتوان تاریخچه قبوض یک دستهبندی خاص را دریافت کرد.
-
شناسه سرویس: 44093
-
پارامترهای ورودی
یک json با ساختار و پارامترهای زیر:
| توضیحات | نام پارامتر |
|---|---|
| نوع قبض قبض آب – Water قبض برق – Electricity قبض گاز – Gas | Type |
| مقدار مورد استعلام قبض آب : شناسه قبض قبض برق: شناسه قبض قبض گاز: شماره اشتراک | Parameter |
- پاسخ برگشتی:
در صورت استعلام موفق فیلدهای خروجی به صورت Json:
| مقدار | پارامتر |
|---|---|
| کد | Status |
| پیام | Message |
| Amount – مبلغ قبض BillId – شناسه قبض PayId – شناسه پرداخت Date – مهلت پرداخت | Data |
در غیر اینصورت :
| مقدار | پارامتر |
|---|---|
| کد خطا | Status |
| پیام خطا | Message |
جداول
شرح جزئیات قبوض
| شرح | پارامتر | نوع قبض |
|---|---|---|
| شماره پرونده | FileNumber | آب |
| نام | OwnerName | آب |
| شهر | City | آب |
| آدرس | Address | آب |
| کد پستی | PostalCode | آب |
| نوع کاربری | AccountType | آب |
| تعداد واحد | UnitsNumber | آب |
| سریال قبض | BillSerial | آب |
| شماره بدنه کنتور | MeterBodyNumber | آب |
| وضعیت کنتور | MeterStatus | آب |
| قطر انشعاب آب | BranchDiameter | آب |
| قطر سیفون | WasteWaterDiameter | آب |
| ظرفیت قراردادی | ContractCapacity | آب |
| تاریخ قبلی | PreviousDate | آب |
| تاریخ فعلی | CurrentDate | آب |
| شماره قبلی | PreviousNumber | آب |
| شماره فعلی | CurrentNumber | آب |
| مصرف دوره | TotalConsumption | آب |
| بدهی گذشته | PreviousDebt | آب |
| میانگین مصرف | AverageConsumption | آب |
| تعداد روز دوره | TotalDay | آب |
| آب بهای مصرفی | WaterPrice | آب |
| تبصره ۲ | Note2 | آب |
| تبصره ۳ | Note3 | آب |
| مالیات بر ارزش افزوده | Tax | آب |
| تکالیف قانون بودجه | VillageAbfaPortion | آب |
| بهای دفع فاضلاب | WasteWaterFee | آب |
| مصرف مازاد | ExtraConsumption | آب |
| تاریخ صدور قبض | BillExportationDate | آب |
| مجموع صورتحساب | TotalBilling | آب |
| کسر هزارریال | DeductionAmount1000Rial | آب |
| روستا | Village | آب |
| منطقه | Area | آب |
| تاریخ صدور | BillExportationDate | برق |
| تاریخ قرائت قبلی | PreviousReadingDate | برق |
| تاریخ عدم قبول | RejectDate | برق |
| تاریخ قرائت فعلی | CurrentReadingDate | برق |
| مصرف میان باری | NormalConsumption | برق |
| مصرف اوج بار | PeakConsumption | برق |
| مصرف کم باری | LowConsumption | برق |
| مصرف روز جمعه | FridayConsumption | برق |
| مصرف راکتیو | ReactiveConsumption | برق |
| تقاضای قرائت | DemandRead | برق |
| میانگین مصرف | AverageConsumption | برق |
| مبلغ قابل پرداخت | BillPayableAmount | برق |
| مبلغ دوره | PeriodAmount | برق |
| مبلغ بیمه | InsuranceAmount | برق |
| مبلغ مالیات (در سهم ارزش افزوده) | TaxAmount | برق |
| مبلغ عوارض | PaytollAmount | برق |
| مبلغ عوارض برق | ElectricityTaxAmount | برق |
| بدهی پیشین | PreviousDebt | برق |
| مبلغ انرژی | EnergyAmount | برق |
| مبلغ راکتیو | ReactiveAmount | برق |
| مبلغ تقاضا | DemandAmount | برق |
| آبونمان | SubscriptionAmount | برق |
| مبلغ فصل | SeasonAmount | برق |
| مبلغ رایگان | FreeAmount | برق |
| مبلغ تخفیف گاز | GasDiscountAmount | برق |
| مبلغ تخفیف | DiscountAmount | برق |
| تعداد روز گرم | WarmDaysCount | برق |
| تعداد روز سرد | ColdDaysCount | برق |
| تعداد روز | TotalDaysCount | برق |
| نام شرکت توزیع | CompanyName | برق |
| فاز | Phase | برق |
| نوع ولتاژ | VoltageType | برق |
| آمپراژ | Amper | برق |
| قدرت | ContractDemand | برق |
| نوع تعرفه | TariffType | برق |
| نوع مشترک | CustomerType | برق |
| نام مشترک | CustomerName | برق |
| نام خانوادگی مشترک | CustomerFamily | برق |
| آدرس | Address | برق |
| کدپستی | PostalCode | برق |
| مبلغ بدهی مصرف | ConsumptionDebtAmount | برق |
| مبلغ بدهی سایر خدمات | OtherDebtAmount | برق |
| مبلغ بدهی انشعاب | BranchDebtAmount | برق |
| شماره شناسایی | IdentificationNumber | برق |
| شماره پرونده | FileNumber | برق |
| رمز رایانه | ComputerPassword | برق |
| دوره | Period | برق |
| سال | Year | برق |
| نام مشترک | OwnerName | گاز |
| نوع مصرف | UseType | گاز |
| شماره اشتراک | SubscriptionNumber | گاز |
| کد آدرس | AddressCode | گاز |
| شهر | City | گاز |
| کد حوزه | AreaCode | گاز |
| سریال کنتور | MeterSerial | گاز |
| شماره پرونده | FileNumber | گاز |
| تعداد واحد | UnitCount | گاز |
| گروه | Group | گاز |
| ظرفیت | Capacity | گاز |
| تاریخ قرائت پیشین | PreviousReadingDate | گاز |
| تاریخ قرائت فعلی | CurrentReadingDate | گاز |
| رقم شمارشگر پیشین | PreviousCounterDigit | گاز |
| رقم شمارشگر فعلی | CurrentCounterDigit | گاز |
| کارکرد شمارشگر | CounterActivity | گاز |
| مصرف استاندارد | StandardConsumption | گاز |
| بهای گاز مصرفی | GasConsumptionAmount | گاز |
| آبونمان | Subscription | گاز |
| عوارض | Taxes | گاز |
| بیمه | Insurance | گاز |
| بدهی متفرقه | OtherDebt | گاز |
| مانده بدهی | RemainingDebt | گاز |
| مانده صورتحساب قبلی | RemainingPreviousInvoice | گاز |
| تعداد بدهی | DebtCount | گاز |
| شماره سری | SerialNumber | گاز |
| مانده مبلغ هزار ریال | RemainingAmount1000Rial | گاز |
| کسر مبلغ هزار ریال | DeductionAmount1000Rial | گاز |
| عوارض گازرسانی به روستا | VillageGasTaxes | گاز |
| مهلت پرداخت | PaymentDeadLine | تلفن |
| هزینه بین شهری | InterCityCost | تلفن |
| هزینه شهری | CityCost | تلفن |
| هزینه تلفن همراه | MobileCost | تلفن |
| آبونمان | Subscription | تلفن |
| مالیات | Taxes | تلفن |
| عوارض | Charges | تلفن |
| بدهی | Debt | تلفن |
| وضعیت خط | Status | تلفن |
| تاریخ آغاز صورتحساب | StartBillingDate | تلفن |
| تاریخ پایان صورتحساب | EndBillingDate | تلفن |
| مبلغ قابل پرداخت | TotalBilling | تلفن |
خطاها
| شرح | پیام پاسخ | کد پاسخ |
|---|---|---|
| موفق | Success | 0 |
| اجازه دسترسی ندارید | No Access | 101 |
| نوع قبض ارسال نشده است | Bill Type is Empty | 102 |
| پارامتر استعلام ارسال نشده است | Bill Parameter is Empty | 103 |
| مقدار ورودی نامعتبر است | Wrong parameter | 104 |
| قبض پرداخت شده است | Bill Paid | 105 |
| قبضی یافت نشد | No Bill | 106 |
| نوع قبض اشتباه است | Bill Wrong Type | 107 |
| ستعلام فعال نمی باشد | Service Disable | 108 |
| استعلام مورد نظر برای شما فعال نمی باشد | Service Disabled | 109 |
| استعلام فعال نمی باشد | Service Disabled | 110 |
| استعلام فعال نمی باشد | Service Disabled | 111 |
| استعلام فعال نمی باشد | Service Disabled | 112 |
| آرایه قبوض ارسال نشده است | Bills is Empty | 113 |
| مقدار آرایه قبوض نامعتبر است | Invalid Bills Data | 114 |
| نام گروه ارسال نشده است | Please Enter Group Name | 115 |
| نوع گروه ارسال نشده است | Please Enter Group Type | 116 |
| نوع گروه اشتباه است | Wrong Group Type | 117 |
| شناسه گروه ارسال نشده است | Please Enter Group Id | 118 |
| شناسه گروه اشتباه است | Wrong gGroup Id | 119 |
| گروه موجود نیست | Group Not Exists | 120 |
| نوع پارامتر ارسال نشده است | Empty Parameter Type | 121 |
| پارامتر ارسال نشده است | Empty Parameter | 122 |
| پارامتر در گروه موجود است | Parameter Exist In This Group | 123 |
| شناسه پارامتر ارسال نشده است | Empty Parameter Id | 124 |
| شناسه پارامتر موجود نیست | Parameter Id Not Exist | 125 |
| پارامتر موجود نیست | Parameter Not Exists | 126 |
| خطا در درخواست فعالسازی تلفن | Tel Activation Error | 131 |
| شماره تلفن ارسال نشده است | TelNumber is Empty | 132 |
| شماره تلفن نامعتبر است | TelNumber is Wrong | 133 |
| کد فعالسازی ارسال نشده است | ActivationCode is Empty | 134 |
| شماره تلفن نیاز به فعالسازی ندارد | This Tel Does Not Require Verification | 135 |
| شماره تلفن ابتدا نیاز به درخواست فعالسازی دارد | Tel Request ActivationCode Required | 136 |
| شماره گواهینامه ارسال نشده است | License Number Is Empty | 301 |
| شماره گواهینامه نادرست است | License Number Is Invalid | 302 |
| اطلاعات یافت نشد | Information Not Found | 303 |
| شماره پلاک ارسال نشده است | Plate Number Is Empty | 304 |
| شماره پلاک نادرست است | Plate Number Is Invalid | 305 |
| کد ملی ارسال نشده است | National Id Is Empty | 306 |
| کد ملی نادرست است | National Id Is Invalid | 307 |
| توکن نامعتبر است | No HTTP resource was found (401 Unauthorized) | 16 |
