Skip to content

Query field reference ​

Every list endpoint returns list items of the type ApiListItem. This page shows which fields you can use in $filter, $search and $orderby. How to write the query: Queries and paging.

Each list type (for example CalculationListItem or EmploymentListItem) adds its own fields in data and its own values in status. See the type in the REST API reference.

ApiListItem ​

FieldTypeFilterSearchSortDescription
backOfficeStatusstring✓✓✓The back office status, depending on the type of the object
businessObjectsstring[]✓Ids of related objects, for example the calculations and payrolls in a payment
createdAtdatetime✓✓When the object was created
datadictionary✓✓Business data of the list type. Filterable and searchable, not sortable
endAtdate✓✓End date of the event. Usually the last user update; for a calculation, the payment date
entityTypestring✓✓✓Sub-category of the object
externalIdstring✓✓✓Your id for the object in your own system
feenumber✓✓Estimated fee of the transaction
flagsstring[]✓✓Workflow flags
grossSalarynumber✓✓Gross salary, where relevant
idstring✓✓✓Id of the object
isReadOnlybooleanThe object is read-only for the signed-in account
listTypestringThe list item type
logicalDatedatetime✓✓The date of the period the object is for
messagesstring[]✓✓Workflow messages, as [MessageType]:[Message] ([User] at [UTC time])
otherIdstring✓✓Id of the other party, today always the person id
otherPartyInfoAccountInIndexsee belowThe other party, usually a person (for example the worker of a salary payment)
ownerstring✓✓Owner of the data. Always your own: you cannot query across owners
ownerIdstring✓✓Id of the owner. Nearly always the same as owner
ownerInfoAccountInIndexsee belowThe owner
partnerstring✓✓✓The primary partner. Set automatically
paymentnumber✓✓The payment from the owner's view: total payment for an employer, net salary for a worker
referencestring✓✓✓A reference, for example a payment reference number
salaryDatedate✓✓Calculations only: the expected salary date
shortTextstring✓✓✓A short description, for example "Paid salary"
startAtdate✓✓Start date of the event. Usually the creation date
statusstring✓✓✓The main status. Values depend on the list type
timestampdatetime✓✓Last change by a user or by the system
typestringThe object type
updatedAtdatetime✓✓Last update by a user
uristringSalaxy URI of the object
versionNumbernumberVersion number

AccountInIndex ​

ownerInfo and otherPartyInfo are of this type. Use a path in the query, for example $filter=otherPartyInfo/officialId eq '190372-942M' or $orderby=otherPartyInfo/avatar/sortableName asc.

FieldTypeFilterSearchSortDescription
avatar/displayNamestring✓✓✓For a person, "FirstName LastName"
avatar/sortableNamestring✓✓✓For a person, "LastName, FirstName". Can be lower case
avatar/firstNamestring✓✓✓First name, or the company name
avatar/lastNamestring✓✓✓Last name. Empty for a company
avatar/entityTypestring✓✓✓person, company, personCreatedByEmployer or partner
avatar/descriptionstring✓✓✓Short description
avatar/initialsstring✓✓✓Initials
emailstring✓✓✓Email address
ibanNumberstring✓✓✓Bank account number (IBAN)
officialIdstring✓✓✓Personal identity code or business ID
telephonestring✓✓✓Telephone number

The other fields of AccountInIndex (id, owner, partner, createdAt, updatedAt, isReadOnly and the avatar picture fields) are returned, but you cannot query them.

Every page is also available as Markdown: add .md to its URL — a folder page such as white-label/ is white-label/index.md. Index for LLMs: llms.txt. Questions: Support.