POST 17.0/database/invoices/list

Description

Retrieve a list of Invoices

URI Parameters

None.

ListOptions
Name Description Type Additional information
Fields

Collection of string

None.
Filters

Collection of DatabaseFilter

None.
Order

string

None.

application/json, text/json
Sample: 
{
  "fields": [
    "sample string 1",
    "sample string 2"
  ],
  "filters": [
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    },
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    }
  ],
  "order": "sample string 1"
}

application/xml, text/xml
Sample: 
<ListOptions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Fields>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Fields>
  <Filters>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
  </Filters>
  <Order>sample string 1</Order>
</ListOptions>

application/x-www-form-urlencoded
Sample:

Sample not available.

Collection of InvoicesUpdate
Name Description Type Additional information
ID

integer

None.
CompanyID

integer

None.
ContactID

integer

None.
PropertyID

integer

None.
TenancyID

integer

None.
AddedDate

date

None.
Status

byte

None.
UserID

integer

None.
SiteID

integer

None.
StatementID

integer

None.
FooterText

string

None.
SendRequired

byte

None.
PropertyOfferID

integer

None.
Type

byte

None.
PurchaseOrder

string

String length: inclusive between 0 and 25

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "companyID": 1,
    "contactID": 1,
    "propertyID": 1,
    "tenancyID": 1,
    "addedDate": "2025-01-09T20:47",
    "status": 64,
    "userID": 1,
    "siteID": 1,
    "statementID": 1,
    "footerText": "sample string 1",
    "sendRequired": 64,
    "propertyOfferID": 1,
    "type": 64,
    "purchaseOrder": "sample string 2"
  },
  {
    "id": 1,
    "companyID": 1,
    "contactID": 1,
    "propertyID": 1,
    "tenancyID": 1,
    "addedDate": "2025-01-09T20:47",
    "status": 64,
    "userID": 1,
    "siteID": 1,
    "statementID": 1,
    "footerText": "sample string 1",
    "sendRequired": 64,
    "propertyOfferID": 1,
    "type": 64,
    "purchaseOrder": "sample string 2"
  }
]

application/xml, text/xml
Sample: 
<ArrayOfInvoicesUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <InvoicesUpdate>
    <ID>1</ID>
    <CompanyID>1</CompanyID>
    <ContactID>1</ContactID>
    <PropertyID>1</PropertyID>
    <TenancyID>1</TenancyID>
    <AddedDate>2025-01-09T20:47:33.8350632+00:00</AddedDate>
    <Status>64</Status>
    <UserID>1</UserID>
    <SiteID>1</SiteID>
    <StatementID>1</StatementID>
    <FooterText>sample string 1</FooterText>
    <SendRequired>64</SendRequired>
    <PropertyOfferID>1</PropertyOfferID>
    <Type>64</Type>
    <PurchaseOrder>sample string 2</PurchaseOrder>
  </InvoicesUpdate>
  <InvoicesUpdate>
    <ID>1</ID>
    <CompanyID>1</CompanyID>
    <ContactID>1</ContactID>
    <PropertyID>1</PropertyID>
    <TenancyID>1</TenancyID>
    <AddedDate>2025-01-09T20:47:33.8350632+00:00</AddedDate>
    <Status>64</Status>
    <UserID>1</UserID>
    <SiteID>1</SiteID>
    <StatementID>1</StatementID>
    <FooterText>sample string 1</FooterText>
    <SendRequired>64</SendRequired>
    <PropertyOfferID>1</PropertyOfferID>
    <Type>64</Type>
    <PurchaseOrder>sample string 2</PurchaseOrder>
  </InvoicesUpdate>
</ArrayOfInvoicesUpdate>