GET v1/InvoiceSummaries

Documentation for 'Get'.

Request Information

Parameters

NameDescriptionAdditional information
queryOptions 
Documentation for 'queryOptions'.

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
Click to beautify! 
[
  {
    "customerId": 1,
    "reference": "sample string 2",
    "companyName": "sample string 3",
    "customerParentId": 1,
    "customerName": "sample string 4",
    "effectiveTimestamp": "2024-05-03T05:55:18.6991385+00:00",
    "postedTimestamp": "2024-05-03T05:55:18.6991385+00:00",
    "dueDate": "2024-05-03T05:55:18.6991385+00:00",
    "modifiedTimestamp": "2024-05-03T05:55:18.6991385+00:00",
    "invoiceStatus": "sample string 9",
    "invoiceNumber": "sample string 10",
    "poNumber": "sample string 11",
    "invoiceAmount": 12.0,
    "sumOfCharges": 13.0,
    "totalPayments": 14.0,
    "totalCreditNotes": 15.0,
    "writeoffs": 16.0,
    "outstandingBalance": 17.0,
    "currency": "sample string 18",
    "avalaraId": "sample string 19",
    "unsettled": true,
    "firstName": "sample string 23",
    "middleName": "sample string 24",
    "lastName": "sample string 25",
    "customerIsParent": true,
    "accountingStatus": "sample string 27",
    "customerStatus": "sample string 28",
    "customerSalesTrackingCode1Id": 1,
    "customerSalesTrackingCode2Id": 1,
    "customerSalesTrackingCode3Id": 1,
    "customerSalesTrackingCode4Id": 1,
    "customerSalesTrackingCode5Id": 1,
    "id": 29,
    "uri": "sample string 30"
  },
  {
    "customerId": 1,
    "reference": "sample string 2",
    "companyName": "sample string 3",
    "customerParentId": 1,
    "customerName": "sample string 4",
    "effectiveTimestamp": "2024-05-03T05:55:18.6991385+00:00",
    "postedTimestamp": "2024-05-03T05:55:18.6991385+00:00",
    "dueDate": "2024-05-03T05:55:18.6991385+00:00",
    "modifiedTimestamp": "2024-05-03T05:55:18.6991385+00:00",
    "invoiceStatus": "sample string 9",
    "invoiceNumber": "sample string 10",
    "poNumber": "sample string 11",
    "invoiceAmount": 12.0,
    "sumOfCharges": 13.0,
    "totalPayments": 14.0,
    "totalCreditNotes": 15.0,
    "writeoffs": 16.0,
    "outstandingBalance": 17.0,
    "currency": "sample string 18",
    "avalaraId": "sample string 19",
    "unsettled": true,
    "firstName": "sample string 23",
    "middleName": "sample string 24",
    "lastName": "sample string 25",
    "customerIsParent": true,
    "accountingStatus": "sample string 27",
    "customerStatus": "sample string 28",
    "customerSalesTrackingCode1Id": 1,
    "customerSalesTrackingCode2Id": 1,
    "customerSalesTrackingCode3Id": 1,
    "customerSalesTrackingCode4Id": 1,
    "customerSalesTrackingCode5Id": 1,
    "id": 29,
    "uri": "sample string 30"
  },
  {
    "customerId": 1,
    "reference": "sample string 2",
    "companyName": "sample string 3",
    "customerParentId": 1,
    "customerName": "sample string 4",
    "effectiveTimestamp": "2024-05-03T05:55:18.6991385+00:00",
    "postedTimestamp": "2024-05-03T05:55:18.6991385+00:00",
    "dueDate": "2024-05-03T05:55:18.6991385+00:00",
    "modifiedTimestamp": "2024-05-03T05:55:18.6991385+00:00",
    "invoiceStatus": "sample string 9",
    "invoiceNumber": "sample string 10",
    "poNumber": "sample string 11",
    "invoiceAmount": 12.0,
    "sumOfCharges": 13.0,
    "totalPayments": 14.0,
    "totalCreditNotes": 15.0,
    "writeoffs": 16.0,
    "outstandingBalance": 17.0,
    "currency": "sample string 18",
    "avalaraId": "sample string 19",
    "unsettled": true,
    "firstName": "sample string 23",
    "middleName": "sample string 24",
    "lastName": "sample string 25",
    "customerIsParent": true,
    "accountingStatus": "sample string 27",
    "customerStatus": "sample string 28",
    "customerSalesTrackingCode1Id": 1,
    "customerSalesTrackingCode2Id": 1,
    "customerSalesTrackingCode3Id": 1,
    "customerSalesTrackingCode4Id": 1,
    "customerSalesTrackingCode5Id": 1,
    "id": 29,
    "uri": "sample string 30"
  }
]

application/xml, text/xml

Sample:
Click to beautify! 
<ArrayOfInvoiceSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Get">
  <InvoiceSummary>
    <Id>29</Id>
    <Uri>sample string 30</Uri>
    <AccountingStatus>sample string 27</AccountingStatus>
    <AvalaraId>sample string 19</AvalaraId>
    <Charges>13</Charges>
    <CompanyName>sample string 3</CompanyName>
    <Currency>sample string 18</Currency>
    <CustomerId>1</CustomerId>
    <CustomerIsParent>true</CustomerIsParent>
    <CustomerName>sample string 4</CustomerName>
    <CustomerParentId>1</CustomerParentId>
    <CustomerSalesTrackingCode1Id>1</CustomerSalesTrackingCode1Id>
    <CustomerSalesTrackingCode2Id>1</CustomerSalesTrackingCode2Id>
    <CustomerSalesTrackingCode3Id>1</CustomerSalesTrackingCode3Id>
    <CustomerSalesTrackingCode4Id>1</CustomerSalesTrackingCode4Id>
    <CustomerSalesTrackingCode5Id>1</CustomerSalesTrackingCode5Id>
    <CustomerStatus>sample string 28</CustomerStatus>
    <DueTimestamp>2024-05-03T05:55:18.6991385+00:00</DueTimestamp>
    <EffectiveTimestamp>2024-05-03T05:55:18.6991385+00:00</EffectiveTimestamp>
    <FirstName>sample string 23</FirstName>
    <InvoiceAmount>12</InvoiceAmount>
    <InvoiceNumber>sample string 10</InvoiceNumber>
    <LastName>sample string 25</LastName>
    <MiddleName>sample string 24</MiddleName>
    <ModifiedTimestamp>2024-05-03T05:55:18.6991385+00:00</ModifiedTimestamp>
    <OutstandingBalance>17</OutstandingBalance>
    <PoNumber>sample string 11</PoNumber>
    <PostedTimestamp>2024-05-03T05:55:18.6991385+00:00</PostedTimestamp>
    <QuickBooksAttemptNumber>21</QuickBooksAttemptNumber>
    <QuickBooksId>sample string 20</QuickBooksId>
    <Reference>sample string 2</Reference>
    <Status>sample string 9</Status>
    <TotalCreditNotes>15</TotalCreditNotes>
    <TotalPayments>14</TotalPayments>
    <Unsettled>true</Unsettled>
    <Writeoffs>16</Writeoffs>
  </InvoiceSummary>
  <InvoiceSummary>
    <Id>29</Id>
    <Uri>sample string 30</Uri>
    <AccountingStatus>sample string 27</AccountingStatus>
    <AvalaraId>sample string 19</AvalaraId>
    <Charges>13</Charges>
    <CompanyName>sample string 3</CompanyName>
    <Currency>sample string 18</Currency>
    <CustomerId>1</CustomerId>
    <CustomerIsParent>true</CustomerIsParent>
    <CustomerName>sample string 4</CustomerName>
    <CustomerParentId>1</CustomerParentId>
    <CustomerSalesTrackingCode1Id>1</CustomerSalesTrackingCode1Id>
    <CustomerSalesTrackingCode2Id>1</CustomerSalesTrackingCode2Id>
    <CustomerSalesTrackingCode3Id>1</CustomerSalesTrackingCode3Id>
    <CustomerSalesTrackingCode4Id>1</CustomerSalesTrackingCode4Id>
    <CustomerSalesTrackingCode5Id>1</CustomerSalesTrackingCode5Id>
    <CustomerStatus>sample string 28</CustomerStatus>
    <DueTimestamp>2024-05-03T05:55:18.6991385+00:00</DueTimestamp>
    <EffectiveTimestamp>2024-05-03T05:55:18.6991385+00:00</EffectiveTimestamp>
    <FirstName>sample string 23</FirstName>
    <InvoiceAmount>12</InvoiceAmount>
    <InvoiceNumber>sample string 10</InvoiceNumber>
    <LastName>sample string 25</LastName>
    <MiddleName>sample string 24</MiddleName>
    <ModifiedTimestamp>2024-05-03T05:55:18.6991385+00:00</ModifiedTimestamp>
    <OutstandingBalance>17</OutstandingBalance>
    <PoNumber>sample string 11</PoNumber>
    <PostedTimestamp>2024-05-03T05:55:18.6991385+00:00</PostedTimestamp>
    <QuickBooksAttemptNumber>21</QuickBooksAttemptNumber>
    <QuickBooksId>sample string 20</QuickBooksId>
    <Reference>sample string 2</Reference>
    <Status>sample string 9</Status>
    <TotalCreditNotes>15</TotalCreditNotes>
    <TotalPayments>14</TotalPayments>
    <Unsettled>true</Unsettled>
    <Writeoffs>16</Writeoffs>
  </InvoiceSummary>
  <InvoiceSummary>
    <Id>29</Id>
    <Uri>sample string 30</Uri>
    <AccountingStatus>sample string 27</AccountingStatus>
    <AvalaraId>sample string 19</AvalaraId>
    <Charges>13</Charges>
    <CompanyName>sample string 3</CompanyName>
    <Currency>sample string 18</Currency>
    <CustomerId>1</CustomerId>
    <CustomerIsParent>true</CustomerIsParent>
    <CustomerName>sample string 4</CustomerName>
    <CustomerParentId>1</CustomerParentId>
    <CustomerSalesTrackingCode1Id>1</CustomerSalesTrackingCode1Id>
    <CustomerSalesTrackingCode2Id>1</CustomerSalesTrackingCode2Id>
    <CustomerSalesTrackingCode3Id>1</CustomerSalesTrackingCode3Id>
    <CustomerSalesTrackingCode4Id>1</CustomerSalesTrackingCode4Id>
    <CustomerSalesTrackingCode5Id>1</CustomerSalesTrackingCode5Id>
    <CustomerStatus>sample string 28</CustomerStatus>
    <DueTimestamp>2024-05-03T05:55:18.6991385+00:00</DueTimestamp>
    <EffectiveTimestamp>2024-05-03T05:55:18.6991385+00:00</EffectiveTimestamp>
    <FirstName>sample string 23</FirstName>
    <InvoiceAmount>12</InvoiceAmount>
    <InvoiceNumber>sample string 10</InvoiceNumber>
    <LastName>sample string 25</LastName>
    <MiddleName>sample string 24</MiddleName>
    <ModifiedTimestamp>2024-05-03T05:55:18.6991385+00:00</ModifiedTimestamp>
    <OutstandingBalance>17</OutstandingBalance>
    <PoNumber>sample string 11</PoNumber>
    <PostedTimestamp>2024-05-03T05:55:18.6991385+00:00</PostedTimestamp>
    <QuickBooksAttemptNumber>21</QuickBooksAttemptNumber>
    <QuickBooksId>sample string 20</QuickBooksId>
    <Reference>sample string 2</Reference>
    <Status>sample string 9</Status>
    <TotalCreditNotes>15</TotalCreditNotes>
    <TotalPayments>14</TotalPayments>
    <Unsettled>true</Unsettled>
    <Writeoffs>16</Writeoffs>
  </InvoiceSummary>
</ArrayOfInvoiceSummary>

text/csv

Sample:
Click to beautify! 
sep=,
Stax Bill ID,Customer ID,Company Name,CustomerParentId,Customer Name,Effective Timestamp,Posted Timestamp,Due Timestamp,Modified Timestamp,Status,Invoice Number,PO Number,Amount,SumOfCharges,Total Payments,Total Credit Notes,Write offs,Balance,Currency,Avalara Id,Is any payment unsettled?,FirstName,MiddleName,LastName,CustomerIsParent,AccountingStatus,CustomerStatus,CustomerSalesTrackingCode1Id,CustomerSalesTrackingCode2Id,CustomerSalesTrackingCode3Id,CustomerSalesTrackingCode4Id,CustomerSalesTrackingCode5Id,Id
1,sample string 2,sample string 3,1,sample string 4,5/3/2024 5:55:18 AM,5/3/2024 5:55:18 AM,5/3/2024 5:55:18 AM,5/3/2024 5:55:18 AM,sample string 9,sample string 10,sample string 11,12,13,14,15,16,17,sample string 18,sample string 19,True,sample string 23,sample string 24,sample string 25,True,sample string 27,sample string 28,1,1,1,1,1,29
1,sample string 2,sample string 3,1,sample string 4,5/3/2024 5:55:18 AM,5/3/2024 5:55:18 AM,5/3/2024 5:55:18 AM,5/3/2024 5:55:18 AM,sample string 9,sample string 10,sample string 11,12,13,14,15,16,17,sample string 18,sample string 19,True,sample string 23,sample string 24,sample string 25,True,sample string 27,sample string 28,1,1,1,1,1,29
1,sample string 2,sample string 3,1,sample string 4,5/3/2024 5:55:18 AM,5/3/2024 5:55:18 AM,5/3/2024 5:55:18 AM,5/3/2024 5:55:18 AM,sample string 9,sample string 10,sample string 11,12,13,14,15,16,17,sample string 18,sample string 19,True,sample string 23,sample string 24,sample string 25,True,sample string 27,sample string 28,1,1,1,1,1,29