POST api/EstoreUtility/InquireBillRequestAsync

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
serviceId	integer	None.
serviceName	string	None.
serviceNumber	string	None.
nationalId	string	None.

Request Formats

application/json, text/json

Sample:

{
  "serviceId": 1,
  "serviceName": "sample string 2",
  "serviceNumber": "sample string 3",
  "nationalId": "sample string 4"
}

application/xml, text/xml

Sample:

<UtilityModel.InquireBillModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Features.SDK.Models">
  <nationalId>sample string 4</nationalId>
  <serviceId>1</serviceId>
  <serviceName>sample string 2</serviceName>
  <serviceNumber>sample string 3</serviceNumber>
</UtilityModel.InquireBillModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BillModelResponse

Name	Type	Additional information
bill	decimal number	None.
accountNumber	string	None.
totalOutstandingAmount	string	None.
paymentDueDate	string	None.
CustomerName	string	None.
CustomerNo	string	None.
inquiryNumber	string	None.
partialPayment	string	None.
amount	decimal number	None.
unbilledAmount	decimal number	None.
parentNumber	string	None.
customerNumber	string	None.
registerType	string	None.
minAmount	string	None.
kmReferenceNumber	string	None.
poBOX	string	None.
customerName	string	None.
qpReferenceID	string	None.
lastPaymentDate	date	None.
status	string	None.
currentAmountDue	decimal number	None.
unbilledUsage	decimal number	None.
success	boolean	None.
code	string	None.
message	string	None.
errors	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "bill": 1.0,
  "accountNumber": "sample string 2",
  "totalOutstandingAmount": "sample string 3",
  "paymentDueDate": "sample string 4",
  "CustomerName": "sample string 5",
  "CustomerNo": "sample string 6",
  "inquiryNumber": "sample string 7",
  "partialPayment": "sample string 8",
  "amount": 9.0,
  "unbilledAmount": 10.0,
  "parentNumber": "sample string 11",
  "customerNumber": "sample string 12",
  "registerType": "sample string 13",
  "minAmount": "sample string 14",
  "kmReferenceNumber": "sample string 15",
  "poBOX": "sample string 16",
  "customerName": "sample string 17",
  "qpReferenceID": "sample string 18",
  "lastPaymentDate": "2025-06-15T06:45:13.6542624+03:00",
  "status": "sample string 19",
  "currentAmountDue": 20.0,
  "unbilledUsage": 21.0,
  "success": true,
  "code": "sample string 23",
  "message": "sample string 24",
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<UtilityModel.BillModelResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Features.SDK.Models">
  <code xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">sample string 23</code>
  <errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </errors>
  <message xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">sample string 24</message>
  <success xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">true</success>
  <CustomerName>sample string 5</CustomerName>
  <CustomerNo>sample string 6</CustomerNo>
  <accountNumber>sample string 2</accountNumber>
  <amount>9</amount>
  <bill>1</bill>
  <currentAmountDue>20</currentAmountDue>
  <customerName>sample string 17</customerName>
  <customerNumber>sample string 12</customerNumber>
  <inquiryNumber>sample string 7</inquiryNumber>
  <kmReferenceNumber>sample string 15</kmReferenceNumber>
  <lastPaymentDate>2025-06-15T06:45:13.6542624+03:00</lastPaymentDate>
  <minAmount>sample string 14</minAmount>
  <parentNumber>sample string 11</parentNumber>
  <partialPayment>sample string 8</partialPayment>
  <paymentDueDate>sample string 4</paymentDueDate>
  <poBOX>sample string 16</poBOX>
  <qpReferenceID>sample string 18</qpReferenceID>
  <registerType>sample string 13</registerType>
  <status>sample string 19</status>
  <totalOutstandingAmount>sample string 3</totalOutstandingAmount>
  <unbilledAmount>10</unbilledAmount>
  <unbilledUsage>21</unbilledUsage>
</UtilityModel.BillModelResponse>