Field Names

To determine which field names can be used for filtering and sorting, examine the collection's response object. Properties on the root level can be used as-is.

• $filter=status eq 'Pending'
• $orderBy=startdate asc

  To reference fields within a contained object, use the dot.symbol in notation.

• $orderBy=taxpayer.code desc

 To reference customer and certificate custom fields, use the dot.symbol in combination with array notation.

• $orderBy=customFields.[n].value asc (where n is 1-10)

Array type fields require the ct or nct operators.

• $filter=transactionTypes ct 'Sale'
• $filter=transactionTypes ct 'Sale' and transactionTypes ct 'Lease'
• $filter=transactionTypes nct 'Rental'

Treat UUIDs like strings. UUIDs are reference identifiers, so you typically only use the eq operator.

• $filter=(uuid eq '34555978-9bfe-d25a-fbff-d486a0cf62cb' or uuid eq 'a1d87766-fad7-fb1b-b78d-dc71ec7eb20e' or … )

  For date values, use the format: 'YYYY-MM-DD'.

• $filter=datefield gt '2025-02-10'

Date-Time values are in UTC time-zone. Use the format: 'YYYY-MM-DDTHH:mm:ssZ'.

Boolean values are true or false.

• $filter=fieldName eq 'true'