GET Invoices/{ID}/{Offset}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | string |
Required |
|
| Offset | date |
Required |
Body Parameters
None.
Response Information
Resource Description
InvoicePackage| Name | Description | Type | Additional information |
|---|---|---|---|
| CurrentInvoice | Invoice |
None. |
|
| Totals | Collection of TotalDate |
None. |
Response Formats
application/json, text/json
Sample:
{
"CurrentInvoice": {
"ID": "sample string 1",
"Num": 2,
"Date": "2026-01-02T05:56:55.4894847-06:00",
"DateStr": "sample string 4",
"ClientId": "sample string 5",
"ClientName": "sample string 6",
"USAePay": 7,
"MeS": 8,
"MIDS": [
1,
2
],
"Total": 9.0,
"AddedToQB": true,
"SentToQB": true,
"ExportReady": true,
"Calculations": {
"Ach_Client_Count": 1.0,
"Ach_Client_Fee": 2.0,
"Ach_Client_Principal": 3.0,
"Ach_Consumer_Count": 4.0,
"Ach_Consumer_Fee": 5.0,
"Ach_Consumer_Principal": 6.0,
"Ach_Gateway_fee": 7.0,
"Ach_Return_Count": 8.0,
"Ach_Return_Fee": 9.0,
"Ach_Return_Fees": 10.0,
"Ach_Unauthorized_Count": 11.0,
"Ach_Unauthorized_Fee": 12.0,
"Ach_Unauthorized_Fees": 13.0,
"Card_Chargeback_Count": 14.0,
"Card_Chargeback_Fee": 15.0,
"Card_Chargeback_Fees": 16.0,
"Card_Client_Count": 17.0,
"Card_Client_Fee": 18.0,
"Card_Client_Principal": 19.0,
"Card_Consumer_Count": 20.0,
"Card_Consumer_Fee": 21.0,
"Card_Consumer_Principal": 22.0,
"Card_Gateway_fee": 23.0,
"IVR_Minutes": 24.0,
"Ach_Client_Fees": 25.0,
"Ach_Verifications": 26.0,
"Ach_Consumer_Fees": 27.0,
"Ach_Count": 28.0,
"Ach_Fees": 29.0,
"Ach_Principal": 30.0,
"Card_Client_Fees": 31.0,
"Card_Consumer_Fees": 32.0,
"Card_Count": 33.0,
"Card_Fees": 34.0,
"Card_Principal": 35.0,
"Client_Count": 36.0,
"Client_Fees": 37.0,
"Client_Principal": 38.0,
"Consumer_Count": 39.0,
"Consumer_Fees": 40.0,
"Consumer_Principal": 41.0,
"Count": 42.0,
"Fees": 43.0,
"Principal": 44.0,
"Service_Ivr_Count": 45.0,
"Service_Ivr_Fees": 46.0,
"Service_Ivr_Principal": 47.0,
"Service_Phone_Count": 48.0,
"Service_Phone_Fees": 49.0,
"Service_Phone_Principal": 50.0,
"Service_Pos_Count": 51.0,
"Service_Pos_Fees": 52.0,
"Service_Pos_Principal": 53.0,
"Service_Sms_Count": 54.0,
"Service_Sms_Fees": 55.0,
"Service_Sms_Principal": 56.0,
"Service_Web_Count": 57.0,
"Service_Web_Fees": 58.0,
"Service_Web_Principal": 59.0
},
"Transactions": {
"Card": [
{
"AsService": "sample string 1",
"ClientFee": 2.0,
"ConsumerFee": 3.0,
"Location": 4,
"Method": "sample string 5",
"Principal": 6.0,
"Service": "sample string 7",
"Status": "sample string 8",
"Total": 9.0,
"TotalFees": 10.0
},
{
"AsService": "sample string 1",
"ClientFee": 2.0,
"ConsumerFee": 3.0,
"Location": 4,
"Method": "sample string 5",
"Principal": 6.0,
"Service": "sample string 7",
"Status": "sample string 8",
"Total": 9.0,
"TotalFees": 10.0
}
],
"Ach": [
{
"AsService": "sample string 1",
"ClientFee": 2.0,
"ConsumerFee": 3.0,
"Location": 4,
"Method": "sample string 5",
"Principal": 6.0,
"Service": "sample string 7",
"Status": "sample string 8",
"Total": 9.0,
"TotalFees": 10.0
},
{
"AsService": "sample string 1",
"ClientFee": 2.0,
"ConsumerFee": 3.0,
"Location": 4,
"Method": "sample string 5",
"Principal": 6.0,
"Service": "sample string 7",
"Status": "sample string 8",
"Total": 9.0,
"TotalFees": 10.0
}
]
},
"Rows": [
{
"ViewOverride": true,
"Description": "sample string 2",
"ItemCode": "sample string 3",
"Amount": 4.0,
"Quantity": 5,
"View": true,
"Each": 7.0
},
{
"ViewOverride": true,
"Description": "sample string 2",
"ItemCode": "sample string 3",
"Amount": 4.0,
"Quantity": 5,
"View": true,
"Each": 7.0
}
]
},
"Totals": [
{
"Date": "2026-01-02T05:56:55.4894847-06:00",
"Total": 2.0
},
{
"Date": "2026-01-02T05:56:55.4894847-06:00",
"Total": 2.0
}
]
}
application/xml, text/xml
Sample:
<InvoicePackage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PNS_Ext_API.POCOs">
<CurrentInvoice>
<AddedToQB>true</AddedToQB>
<Calculations>
<Ach_Client_Count>1</Ach_Client_Count>
<Ach_Client_Fee>2</Ach_Client_Fee>
<Ach_Client_Fees>25</Ach_Client_Fees>
<Ach_Client_Principal>3</Ach_Client_Principal>
<Ach_Consumer_Count>4</Ach_Consumer_Count>
<Ach_Consumer_Fee>5</Ach_Consumer_Fee>
<Ach_Consumer_Fees>27</Ach_Consumer_Fees>
<Ach_Consumer_Principal>6</Ach_Consumer_Principal>
<Ach_Count>28</Ach_Count>
<Ach_Fees>29</Ach_Fees>
<Ach_Gateway_fee>7</Ach_Gateway_fee>
<Ach_Principal>30</Ach_Principal>
<Ach_Return_Count>8</Ach_Return_Count>
<Ach_Return_Fee>9</Ach_Return_Fee>
<Ach_Return_Fees>10</Ach_Return_Fees>
<Ach_Unauthorized_Count>11</Ach_Unauthorized_Count>
<Ach_Unauthorized_Fee>12</Ach_Unauthorized_Fee>
<Ach_Unauthorized_Fees>13</Ach_Unauthorized_Fees>
<Ach_Verifications>26</Ach_Verifications>
<Card_Chargeback_Count>14</Card_Chargeback_Count>
<Card_Chargeback_Fee>15</Card_Chargeback_Fee>
<Card_Chargeback_Fees>16</Card_Chargeback_Fees>
<Card_Client_Count>17</Card_Client_Count>
<Card_Client_Fee>18</Card_Client_Fee>
<Card_Client_Fees>31</Card_Client_Fees>
<Card_Client_Principal>19</Card_Client_Principal>
<Card_Consumer_Count>20</Card_Consumer_Count>
<Card_Consumer_Fee>21</Card_Consumer_Fee>
<Card_Consumer_Fees>32</Card_Consumer_Fees>
<Card_Consumer_Principal>22</Card_Consumer_Principal>
<Card_Count>33</Card_Count>
<Card_Fees>34</Card_Fees>
<Card_Gateway_fee>23</Card_Gateway_fee>
<Card_Principal>35</Card_Principal>
<Client_Count>36</Client_Count>
<Client_Fees>37</Client_Fees>
<Client_Principal>38</Client_Principal>
<Consumer_Count>39</Consumer_Count>
<Consumer_Fees>40</Consumer_Fees>
<Consumer_Principal>41</Consumer_Principal>
<Count>42</Count>
<Fees>43</Fees>
<IVR_Minutes>24</IVR_Minutes>
<Principal>44</Principal>
<Service_Ivr_Count>45</Service_Ivr_Count>
<Service_Ivr_Fees>46</Service_Ivr_Fees>
<Service_Ivr_Principal>47</Service_Ivr_Principal>
<Service_Phone_Count>48</Service_Phone_Count>
<Service_Phone_Fees>49</Service_Phone_Fees>
<Service_Phone_Principal>50</Service_Phone_Principal>
<Service_Pos_Count>51</Service_Pos_Count>
<Service_Pos_Fees>52</Service_Pos_Fees>
<Service_Pos_Principal>53</Service_Pos_Principal>
<Service_Sms_Count>54</Service_Sms_Count>
<Service_Sms_Fees>55</Service_Sms_Fees>
<Service_Sms_Principal>56</Service_Sms_Principal>
<Service_Web_Count>57</Service_Web_Count>
<Service_Web_Fees>58</Service_Web_Fees>
<Service_Web_Principal>59</Service_Web_Principal>
</Calculations>
<ClientId>sample string 5</ClientId>
<ClientName>sample string 6</ClientName>
<Date xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
<d3p1:DateTime>2026-01-02T11:56:55.4894847Z</d3p1:DateTime>
<d3p1:OffsetMinutes>-360</d3p1:OffsetMinutes>
</Date>
<DateStr>sample string 4</DateStr>
<ExportReady>true</ExportReady>
<ID>sample string 1</ID>
<MIDS xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:int>1</d3p1:int>
<d3p1:int>2</d3p1:int>
</MIDS>
<MeS>8</MeS>
<Num>2</Num>
<Rows>
<Row>
<Amount>4</Amount>
<Description>sample string 2</Description>
<Each>7</Each>
<ItemCode>sample string 3</ItemCode>
<Quantity>5</Quantity>
<View>true</View>
<ViewOverride>true</ViewOverride>
</Row>
<Row>
<Amount>4</Amount>
<Description>sample string 2</Description>
<Each>7</Each>
<ItemCode>sample string 3</ItemCode>
<Quantity>5</Quantity>
<View>true</View>
<ViewOverride>true</ViewOverride>
</Row>
</Rows>
<SentToQB>true</SentToQB>
<Total>9</Total>
<Transactions>
<Ach>
<Transaction>
<AsService>sample string 1</AsService>
<ClientFee>2</ClientFee>
<ConsumerFee>3</ConsumerFee>
<Location>4</Location>
<Method>sample string 5</Method>
<Principal>6</Principal>
<Service>sample string 7</Service>
<Status>sample string 8</Status>
<Total>9</Total>
<TotalFees>10</TotalFees>
</Transaction>
<Transaction>
<AsService>sample string 1</AsService>
<ClientFee>2</ClientFee>
<ConsumerFee>3</ConsumerFee>
<Location>4</Location>
<Method>sample string 5</Method>
<Principal>6</Principal>
<Service>sample string 7</Service>
<Status>sample string 8</Status>
<Total>9</Total>
<TotalFees>10</TotalFees>
</Transaction>
</Ach>
<Card>
<Transaction>
<AsService>sample string 1</AsService>
<ClientFee>2</ClientFee>
<ConsumerFee>3</ConsumerFee>
<Location>4</Location>
<Method>sample string 5</Method>
<Principal>6</Principal>
<Service>sample string 7</Service>
<Status>sample string 8</Status>
<Total>9</Total>
<TotalFees>10</TotalFees>
</Transaction>
<Transaction>
<AsService>sample string 1</AsService>
<ClientFee>2</ClientFee>
<ConsumerFee>3</ConsumerFee>
<Location>4</Location>
<Method>sample string 5</Method>
<Principal>6</Principal>
<Service>sample string 7</Service>
<Status>sample string 8</Status>
<Total>9</Total>
<TotalFees>10</TotalFees>
</Transaction>
</Card>
</Transactions>
<USAePay>7</USAePay>
</CurrentInvoice>
<Totals>
<TotalDate>
<Date xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
<d4p1:DateTime>2026-01-02T11:56:55.4894847Z</d4p1:DateTime>
<d4p1:OffsetMinutes>-360</d4p1:OffsetMinutes>
</Date>
<Total>2</Total>
</TotalDate>
<TotalDate>
<Date xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
<d4p1:DateTime>2026-01-02T11:56:55.4894847Z</d4p1:DateTime>
<d4p1:OffsetMinutes>-360</d4p1:OffsetMinutes>
</Date>
<Total>2</Total>
</TotalDate>
</Totals>
</InvoicePackage>