POST 17.0/database/bills/list

Description

Retrieve a list of Bills

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 BillsUpdate
Name Description Type Additional information
ID

integer

None.
ContactID

integer

None.
PropertyID

integer

None.
WorkOrderID

integer

None.
AddedDate

date

None.
RaisedDate

date

None.
DueDate

date

None.
Status

byte

None.
StatusDate

date

None.
Reference

string

String length: inclusive between 0 and 20
Amount

decimal number

None.
CommissionEarnedContractor

decimal number

None.
CommissionEarnedPayer

decimal number

None.
UserID

integer

None.
SiteID

integer

None.
CompanyID

integer

None.
PaymentCleared

byte

None.
TransferFees

byte

None.
TransactionGroupID

integer

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "contactID": 1,
    "propertyID": 1,
    "workOrderID": 1,
    "addedDate": "2025-01-09T20:42",
    "raisedDate": "2025-01-09T20:42",
    "dueDate": "2025-01-09T20:42",
    "status": 64,
    "statusDate": "2025-01-09T20:42",
    "reference": "sample string 1",
    "amount": 1.0,
    "commissionEarnedContractor": 1.0,
    "commissionEarnedPayer": 1.0,
    "userID": 1,
    "siteID": 1,
    "companyID": 1,
    "paymentCleared": 64,
    "transferFees": 64,
    "transactionGroupID": 1
  },
  {
    "id": 1,
    "contactID": 1,
    "propertyID": 1,
    "workOrderID": 1,
    "addedDate": "2025-01-09T20:42",
    "raisedDate": "2025-01-09T20:42",
    "dueDate": "2025-01-09T20:42",
    "status": 64,
    "statusDate": "2025-01-09T20:42",
    "reference": "sample string 1",
    "amount": 1.0,
    "commissionEarnedContractor": 1.0,
    "commissionEarnedPayer": 1.0,
    "userID": 1,
    "siteID": 1,
    "companyID": 1,
    "paymentCleared": 64,
    "transferFees": 64,
    "transactionGroupID": 1
  }
]

application/xml, text/xml
Sample: 
<ArrayOfBillsUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <BillsUpdate>
    <ID>1</ID>
    <ContactID>1</ContactID>
    <PropertyID>1</PropertyID>
    <WorkOrderID>1</WorkOrderID>
    <AddedDate>2025-01-09T20:42:16.5144641+00:00</AddedDate>
    <RaisedDate>2025-01-09T20:42:16.5144641+00:00</RaisedDate>
    <DueDate>2025-01-09T20:42:16.5144641+00:00</DueDate>
    <Status>64</Status>
    <StatusDate>2025-01-09T20:42:16.5144641+00:00</StatusDate>
    <Reference>sample string 1</Reference>
    <Amount>1</Amount>
    <CommissionEarnedContractor>1</CommissionEarnedContractor>
    <CommissionEarnedPayer>1</CommissionEarnedPayer>
    <UserID>1</UserID>
    <SiteID>1</SiteID>
    <CompanyID>1</CompanyID>
    <PaymentCleared>64</PaymentCleared>
    <TransferFees>64</TransferFees>
    <TransactionGroupID>1</TransactionGroupID>
  </BillsUpdate>
  <BillsUpdate>
    <ID>1</ID>
    <ContactID>1</ContactID>
    <PropertyID>1</PropertyID>
    <WorkOrderID>1</WorkOrderID>
    <AddedDate>2025-01-09T20:42:16.5144641+00:00</AddedDate>
    <RaisedDate>2025-01-09T20:42:16.5144641+00:00</RaisedDate>
    <DueDate>2025-01-09T20:42:16.5144641+00:00</DueDate>
    <Status>64</Status>
    <StatusDate>2025-01-09T20:42:16.5144641+00:00</StatusDate>
    <Reference>sample string 1</Reference>
    <Amount>1</Amount>
    <CommissionEarnedContractor>1</CommissionEarnedContractor>
    <CommissionEarnedPayer>1</CommissionEarnedPayer>
    <UserID>1</UserID>
    <SiteID>1</SiteID>
    <CompanyID>1</CompanyID>
    <PaymentCleared>64</PaymentCleared>
    <TransferFees>64</TransferFees>
    <TransactionGroupID>1</TransactionGroupID>
  </BillsUpdate>
</ArrayOfBillsUpdate>