GET api/SendPayAPI/GetBillByKeyField?token={token}

Request Information

URI Parameters

Name	Description	Type	Additional information
token		string	Required

Body Parameters

BillByKeyFieldReq

Name	Type	Additional information
payeeCode	string	None.
bcustCodes	Collection of string	None.
startPosition	integer	None.
count	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "payeeCode": "sample string 1",
  "bcustCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "startPosition": 2,
  "count": 3
}

application/xml, text/xml

Sample:

<BillByKeyFieldReq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sendmn.Inbound.Models">
  <bcustCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </bcustCodes>
  <count>3</count>
  <payeeCode>sample string 1</payeeCode>
  <startPosition>2</startPosition>
</BillByKeyFieldReq>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BillByKeyFieldRes

Name	Type	Additional information
responseCode	string	None.
responseDesc	string	None.
responseData	Collection of Bill	None.
currentDataSize	integer	None.
pageNumber	integer	None.
totalRecordCount	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "responseCode": "sample string 1",
  "responseDesc": "sample string 2",
  "responseData": [
    {
      "billId": 1,
      "payeeType": "sample string 2",
      "payeeTypeName": "sample string 3",
      "payeeCode": "sample string 4",
      "payeeName": "sample string 5",
      "catId": 6,
      "catName": "sample string 7",
      "note": {},
      "note2": {},
      "isNeedKeyField": 10,
      "keyFieldType": "sample string 11",
      "keyFieldTypeName": {},
      "isNeedTxnDesc": {},
      "txnDescCaption": {},
      "txnDescCaption2": {},
      "hasInvoice": 16,
      "payPartial": 17,
      "payWout": 18,
      "payMore": 19,
      "hasVatSlip": 20,
      "bcustCode": "sample string 21",
      "isOrg": 22,
      "orgName": {},
      "bcustName": "sample string 24",
      "registerCode": {},
      "firstName": "sample string 26",
      "lastName": "sample string 27",
      "billCode": "sample string 28",
      "receiveDate": "2025-12-06T12:03:12.1357148+08:00",
      "startDate": "2025-12-06T12:03:12.1357148+08:00",
      "endDate": "2025-12-06T12:03:12.1357148+08:00",
      "amt": 32,
      "cur": "sample string 33",
      "bal": 34,
      "prevBal": 35,
      "penalty": 36,
      "vatAmt": 37,
      "payAmt": 38,
      "dsc": "sample string 39",
      "status": "sample string 40",
      "statusName": "sample string 41",
      "tmp1": {},
      "tmp2": {},
      "tmp3": {},
      "tmp4": {},
      "tmp5": {},
      "tmp6": {}
    },
    {
      "billId": 1,
      "payeeType": "sample string 2",
      "payeeTypeName": "sample string 3",
      "payeeCode": "sample string 4",
      "payeeName": "sample string 5",
      "catId": 6,
      "catName": "sample string 7",
      "note": {},
      "note2": {},
      "isNeedKeyField": 10,
      "keyFieldType": "sample string 11",
      "keyFieldTypeName": {},
      "isNeedTxnDesc": {},
      "txnDescCaption": {},
      "txnDescCaption2": {},
      "hasInvoice": 16,
      "payPartial": 17,
      "payWout": 18,
      "payMore": 19,
      "hasVatSlip": 20,
      "bcustCode": "sample string 21",
      "isOrg": 22,
      "orgName": {},
      "bcustName": "sample string 24",
      "registerCode": {},
      "firstName": "sample string 26",
      "lastName": "sample string 27",
      "billCode": "sample string 28",
      "receiveDate": "2025-12-06T12:03:12.1357148+08:00",
      "startDate": "2025-12-06T12:03:12.1357148+08:00",
      "endDate": "2025-12-06T12:03:12.1357148+08:00",
      "amt": 32,
      "cur": "sample string 33",
      "bal": 34,
      "prevBal": 35,
      "penalty": 36,
      "vatAmt": 37,
      "payAmt": 38,
      "dsc": "sample string 39",
      "status": "sample string 40",
      "statusName": "sample string 41",
      "tmp1": {},
      "tmp2": {},
      "tmp3": {},
      "tmp4": {},
      "tmp5": {},
      "tmp6": {}
    }
  ],
  "currentDataSize": 3,
  "pageNumber": 4,
  "totalRecordCount": 5
}

application/xml, text/xml

Sample:

<BillByKeyFieldRes xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sendmn.Inbound.Models">
  <currentDataSize>3</currentDataSize>
  <pageNumber>4</pageNumber>
  <responseCode>sample string 1</responseCode>
  <responseData>
    <Bill>
      <amt>32</amt>
      <bal>34</bal>
      <bcustCode>sample string 21</bcustCode>
      <bcustName>sample string 24</bcustName>
      <billCode>sample string 28</billCode>
      <billId>1</billId>
      <catId>6</catId>
      <catName>sample string 7</catName>
      <cur>sample string 33</cur>
      <dsc>sample string 39</dsc>
      <endDate>2025-12-06T12:03:12.1357148+08:00</endDate>
      <firstName>sample string 26</firstName>
      <hasInvoice>16</hasInvoice>
      <hasVatSlip>20</hasVatSlip>
      <isNeedKeyField>10</isNeedKeyField>
      <isNeedTxnDesc />
      <isOrg>22</isOrg>
      <keyFieldType>sample string 11</keyFieldType>
      <keyFieldTypeName />
      <lastName>sample string 27</lastName>
      <note />
      <note2 />
      <orgName />
      <payAmt>38</payAmt>
      <payMore>19</payMore>
      <payPartial>17</payPartial>
      <payWout>18</payWout>
      <payeeCode>sample string 4</payeeCode>
      <payeeName>sample string 5</payeeName>
      <payeeType>sample string 2</payeeType>
      <payeeTypeName>sample string 3</payeeTypeName>
      <penalty>36</penalty>
      <prevBal>35</prevBal>
      <receiveDate>2025-12-06T12:03:12.1357148+08:00</receiveDate>
      <registerCode />
      <startDate>2025-12-06T12:03:12.1357148+08:00</startDate>
      <status>sample string 40</status>
      <statusName>sample string 41</statusName>
      <tmp1 />
      <tmp2 />
      <tmp3 />
      <tmp4 />
      <tmp5 />
      <tmp6 />
      <txnDescCaption />
      <txnDescCaption2 />
      <vatAmt>37</vatAmt>
    </Bill>
    <Bill>
      <amt>32</amt>
      <bal>34</bal>
      <bcustCode>sample string 21</bcustCode>
      <bcustName>sample string 24</bcustName>
      <billCode>sample string 28</billCode>
      <billId>1</billId>
      <catId>6</catId>
      <catName>sample string 7</catName>
      <cur>sample string 33</cur>
      <dsc>sample string 39</dsc>
      <endDate>2025-12-06T12:03:12.1357148+08:00</endDate>
      <firstName>sample string 26</firstName>
      <hasInvoice>16</hasInvoice>
      <hasVatSlip>20</hasVatSlip>
      <isNeedKeyField>10</isNeedKeyField>
      <isNeedTxnDesc />
      <isOrg>22</isOrg>
      <keyFieldType>sample string 11</keyFieldType>
      <keyFieldTypeName />
      <lastName>sample string 27</lastName>
      <note />
      <note2 />
      <orgName />
      <payAmt>38</payAmt>
      <payMore>19</payMore>
      <payPartial>17</payPartial>
      <payWout>18</payWout>
      <payeeCode>sample string 4</payeeCode>
      <payeeName>sample string 5</payeeName>
      <payeeType>sample string 2</payeeType>
      <payeeTypeName>sample string 3</payeeTypeName>
      <penalty>36</penalty>
      <prevBal>35</prevBal>
      <receiveDate>2025-12-06T12:03:12.1357148+08:00</receiveDate>
      <registerCode />
      <startDate>2025-12-06T12:03:12.1357148+08:00</startDate>
      <status>sample string 40</status>
      <statusName>sample string 41</statusName>
      <tmp1 />
      <tmp2 />
      <tmp3 />
      <tmp4 />
      <tmp5 />
      <tmp6 />
      <txnDescCaption />
      <txnDescCaption2 />
      <vatAmt>37</vatAmt>
    </Bill>
  </responseData>
  <responseDesc>sample string 2</responseDesc>
  <totalRecordCount>5</totalRecordCount>
</BillByKeyFieldRes>