GET Invoices/SalesStatsSummary

Returns invoices statistics/summary for a date period

Request Information

URI Parameters

Name	Description	Type	Additional information
WsAccessKey	The Web Service access key for this user and file which allows access to the API for the associated file (found in File - Settings). Using OAuth authentication mechanism is the preferred method to allow API access.	string	Optional. Legacy authentication method and only required if not using OAuth. OAuth is preferred.
FileId	Specifies the file id of the file to perform the operation upon.	integer	Required
InvoiceFromDate	Filter records with Date greater than or equal to a date (must also specifiy ToDate).	string	None.
InvoiceToDate	Filter records with Date less than or equal to a date (must also specifiy FromDate).	string	None.

Body Parameters

None.

Response Information

Resource Description

InvoicesStatsSummaryModel

Name	Description	Type	Additional information
Total	No documentation available.	decimal number	None.
TotalOwed	No documentation available.	decimal number	None.
Paid	No documentation available.	decimal number	None.
Unpaid	No documentation available.	decimal number	None.
Overdue	No documentation available.	decimal number	None.
NotDueYet	No documentation available.	decimal number	None.
Deposited	No documentation available.	decimal number	None.
NotDeposited	No documentation available.	decimal number	None.
FromDate	No documentation available.	date	None.
ToDate	No documentation available.	date	None.
TotalCount	No documentation available.	integer	None.
TotalPaidCount	No documentation available.	integer	None.
TotalUnpaidCount	No documentation available.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Total": 1.0,
  "TotalOwed": 2.0,
  "Paid": 3.0,
  "Unpaid": 4.0,
  "Overdue": 5.0,
  "NotDueYet": 6.0,
  "Deposited": 7.0,
  "NotDeposited": 8.0,
  "FromDate": "2024-11-21T17:37:25.4725234+11:00",
  "ToDate": "2024-11-21T17:37:25.4725234+11:00",
  "TotalCount": 11,
  "TotalPaidCount": 12,
  "TotalUnpaidCount": 13
}

application/xml, text/xml

Sample:

<InvoicesStatsSummaryModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Total>1</Total>
  <TotalOwed>2</TotalOwed>
  <Paid>3</Paid>
  <Unpaid>4</Unpaid>
  <Overdue>5</Overdue>
  <NotDueYet>6</NotDueYet>
  <Deposited>7</Deposited>
  <NotDeposited>8</NotDeposited>
  <FromDate>2024-11-21T17:37:25.4725234+11:00</FromDate>
  <ToDate>2024-11-21T17:37:25.4725234+11:00</ToDate>
  <TotalCount>11</TotalCount>
  <TotalPaidCount>12</TotalPaidCount>
  <TotalUnpaidCount>13</TotalUnpaidCount>
</InvoicesStatsSummaryModel>