Table of Contents
- 1 Ordering Criteria
- 1.1 Accounts ($orderby)
- 1.2 Assets ($orderby)
- 1.3 Contacts ($orderby)
- 1.4 Documents ($orderby)
- 1.5 Invoices ($orderby)
- 1.6 Orders ($orderby)
- 1.7 Pricelists ($orderby)
- 1.8 Products ($orderby)
- 1.9 Leads ($orderby)
- 1.10 Subscriptions ($orderby)
- 1.11 FutureActions ($orderby)
- 1.12 Organization
- 1.12.1 Organization/Countries ($orderby)
- 1.12.2 Organization/Languages ($orderby)
- 1.12.3 Organization/Currencies ($orderby)
- 1.12.4 Organization/PaymentMethods ($orderby)
- 1.12.5 Organization/Taxes ($orderby)
- 1.12.6 Organization/Tax Authorities ($orderby)
- 1.12.7 Organization/Account Types ($orderby)
- 1.12.8 Organization/Invoice Statuses ($orderby)
- 1.12.9 Organization/Invoice Types ($orderby)
- 1.12.10 Organization/Lead Statuses ($orderby)
- 1.12.11 Organization/Lead Sources ($orderby)
- 1.12.12 Organization/Lead Ratings ($orderby)
- 1.12.13 Organization/Titles ($orderby)
- 1.12.14 Organization/Product Types ($orderby)
- 1.12.15 Organization/Unit Groups ($orderby)
- 1.12.16 Organization/Volume Discounts ($orderby)
- 1.12.17 Organization/Units of Measure ($orderby)
- 1.12.18 Organization/Price Groups ($orderby)
- 1.12.19 Organization/Product Industries ($orderby)
- 1.12.20 Organization/Industries ($orderby)
- 1.12.21 Organization Custom Fields ($orderby)
- 1.13 Synchronization
- 1.14 System
The interworks.cloud Platform API provides ordering options on all basic methods that return a collection of resources using the $orderby parameter. The Ordering of Collections enables sorting of resources in a collection given certain criteria and priorities.
The value of the $orderby
parameter contains a comma-separated list of property names to sort by.
The property name may include the suffix asc for ascending or desc for descending order, separated from the property name by one or more spaces.
If asc or desc is not specified, the service will order by the specified property in ascending order.
The following table contains some common use cases of $orderby parameter
Query Description | Example |
Get accounts ordered by created date | /api/accounts?$orderby=createdAt |
Get accounts ordered by created date in descending order | /api/accounts?$orderby=createdAt desc |
Get products ordered by last update date in descending order | /api/products?$orderby=updatedAt desc |
Get contacts order by account name, then last name and first name | /api/contacts?$orderBy=accountname,lastname,firstname |
Get contacts order by account name in descending order, then last name and first name | /api/contacts?$orderBy=accountname desc,lastname,firstname |
Ordering Criteria
Accounts ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/accounts are:
Property | Description |
---|---|
name | Account’s name |
code | Account’s code |
Account’s email | |
creditLimit | Account’s credit limit |
createdAt | Account’s created date |
updatedAt | Account’s updated date |
Assets ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/assets are:
Property | Description |
---|---|
billingToName | Asset’s bill to account name |
createdAt | Asset’s created date |
customerName | Asset’s customer name |
name | Asset’s name |
productName | Asset’s product name |
updatedAt | Asset’s updated date |
Contacts ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/contacts are:
Property | Description |
---|---|
firstName | Contact’s first name |
lastName | Contact’s last name |
createdAt | Contact’s created date |
updatedAt | Contact’s updated date |
Documents ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET/api/files/folders are:
Name | Type | Description | Example |
---|---|---|---|
id | int | Sorts the request response by the Id field. | /api/files/folders?$orderby=id |
Name | string | Sorts the request response by the Name field. | /api/files/folders?$orderby=name |
Invoices ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/invoices are:
Property | Description |
---|---|
code | Invoice’s code |
status | Invoice’s status |
billingToName | Invoice’s bill to account name |
invoiceDate | Invoice’s date |
dueDate | Invoice’s due date |
createdAt | Invoice creation date |
updatedAt | Invoice update date |
Orders ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/orders are:
Property | Description |
---|---|
code | Order’s code |
name | Order’s name |
accountName | Order’s account name |
billingToName | Order’s bill to account name |
createdAt | Order’s created date |
updatedAt | Order’s updated date |
Pricelists ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/pricelists are:
Property | Description |
---|---|
name | Pricelist’s name |
isActive | Pricelist’s status |
from | Pricelist’s from date |
to | Pricelist’s to date |
createdAt | Pricelist’s created date |
updatedAt | Pricelist’s updated date |
Products ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/products are:
Property | Description |
---|---|
name | Product’s name |
createdAt | Product’s created date |
updatedAt | Product’s updated date |
Leads ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/leads are:
Property | Description |
---|---|
firstName | Lead’s firstName |
lastName | Lead’s lastName |
Lead’s email | |
annualRevenue | Lead’s annualRevenue value |
employees | Lead’s employees number |
createdAt | Lead’s created date |
updatedAt | Lead’s updated date |
Subscriptions ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/subscriptions are:
Name | Description |
---|---|
name | Subscription’s name |
startDate | Subscription’s start date |
endDate | Subscription’s end date |
activationDate | Subscription’s activation date |
quantity | Subscription’s quantity |
subscriptionAmount | Subscription’s amount |
createdAt | Subscription’s created date |
updatedAt | Subscription’s updated date |
FutureActions ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/futureactions are:
Property | Description |
---|---|
requestDate | Future action’s request date |
effectiveDate | Future action’s effective date |
createdAt | Future action’s created date |
updatedAt | Future action’s updated date |
Organization
Organization/Countries ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/organization/countries are:
Property | Description |
---|---|
name | The country’s name |
code | The country’s code |
Organization/Languages ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/organization/languages are:
Property | Description |
---|---|
code | Language’s code |
Organization/Currencies ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/organization/currencies are:
Property | Description |
---|---|
name | Currency’s name |
mnemonic | Currency’s mnemonic |
code | Currency’s code |
Organization/PaymentMethods ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/organization/paymentmethods are:
Property | Description |
---|---|
name | Payment method’s name |
gatewayName | Payment method’s gateway name |
Organization/Taxes ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/organization/taxes are:
Property | Description |
---|---|
id | Tax’s ID |
name | Tax’s name |
displayName | Tax’s display name |
isActive | Tax ‘s activity status |
isExcludedEU | Tax’s status of EU exclusion |
Organization/Tax Authorities ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/organization/taxauthorities are:
Property | Description |
---|---|
name | Tax authority’s name |
code | Tax authority’s code |
Organization/Account Types ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/organization/accounts/types are:
Property | Description |
---|---|
name | Account type’s name |
Organization/Invoice Statuses ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/organization/invoices/statuses are:
Property | Description |
---|---|
name | Invoice status’s name |
Organization/Invoice Types ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/organization/invoices/types are:
Property | Description |
---|---|
name | Invoice type’s name |
Organization/Lead Statuses ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/organization/leads/statuses are:
Property | Description |
---|---|
name | Lead status’s name |
Organization/Lead Sources ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/organization/leads/sources are:
Property | Description |
---|---|
name | Lead source’s name |
Organization/Lead Ratings ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/organization/leads/ratings are:
Property | Description |
---|---|
name | Lead rating’s name |
Organization/Titles ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/organization/titles are:
Property | Description |
---|---|
name | Title’s name |
mnemonic | Title’s mnemonic |
Organization/Product Types ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/organization/producttypes are:
Property | Description |
---|---|
name | Product type ‘s name |
basicTypeName | Product type ‘s basic type name |
Organization/Unit Groups ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/organization/unitgroups are:
Property | Description |
---|---|
name | Unit group’s name |
Organization/Volume Discounts ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/organization/volumediscounts are:
Property | Description |
---|---|
name | Volume discount’s name |
Organization/Units of Measure ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/organization/unitsofmeasure are:
Property | Description |
---|---|
name | Unit’s of measure name |
Organization/Price Groups ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/organization/pricegroups are:
Property | Description |
---|---|
name | Price group’s name |
Organization/Product Industries ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/organization/products/industries are:
Property | Description |
---|---|
name | Product industry’s name |
Organization/Industries ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/organization/industries are:
Property | Description |
---|---|
name | Industry’s name |
Organization Custom Fields ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for the following end-points:
- GET /api/organization/accounts/customfields
- GET /api/organization/assets/customfields
- GET /api/organization/contacts/customfields
- GET /api/organization/invoices/customfields
- GET /api/organization/leads/customfields
- GET /api/organization/orders/customfields
- GET /api/organization/pricelists/customfields
- GET /api/organization/products/customfields
- GET /api/organization/subscriptions/customfields
Property | Description |
---|---|
name | Custom field’s name |
Synchronization
Synchronization/Accounts ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET api/synchronization/{systemId}/accounts are:
Name | Type | Description | Example |
---|---|---|---|
syncStatus | string | Sorts the request response by the Status field. | /api/synchronization/{systemId}/accounts?$orderby=SyncStatus |
Note: Ordering can be either ascending (asc) or descending (desc). Default is ascending.
Synchronization/Assets ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET api/synchronization/{systemId}/assets are:
Name | Type | Description | Example |
---|---|---|---|
syncStatus | string | Sorts the request response by the Status field. | /api/synchronization/{systemId}/assets?$orderby=syncStatus |
Synchronization/ProductTypes ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET api/synchronization/{systemId}/accounts are:
Name | Type | Description | Example |
---|---|---|---|
syncStatus | string | Sorts the request response by the Status field. | /api/synchronization/{systemId}/productTypes?$orderby=syncStatus |
Synchronization/Products ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET api/synchronization/{systemId}/products are:
Name | Type | Description | Example |
---|---|---|---|
syncStatus | string | Sorts the request response by the Status field. | /api/synchronization/{systemId}/products?$orderby=SyncStatus |
System
System/Countries ($orderby)
The ordering criteria that could be used for constructing an $orderby expression for GET /api/system/countries are:
Property | Description |
---|---|
name | The country’s name |
code | The country’s code |