Short Description
...
| Operator | Description | API Version | Example |
|---|---|---|---|
(EQ) | Equals Exact Value, case sensitive | Get a Document with document number 2707374: Document?filter=documentNo(EQ)2707374 | |
(NE) | Not Equal | Get all Documents not in company 1000: Document?filter=company.companyCode(NE)1000 | |
(GT) | Greater Than ONLY numeric and date values | Get all Voyages modified since 2014-01-01 00:00:00, not including 2014-01-01 00:00:00: Voyage?filter=modifiedDate(GT)2014-01-01T00:00:00 | |
(GTE) | Greater Than or Equal ONLY numeric and date values | Get all Voyages modified since 2014-01-01 00:00:00, including 2014-01-01 00:00:00: Voyage?filter=modifiedDate(GTE)2014-01-01T00:00:00
| |
(LT) | Lesser Than ONLY numeric and date values | Get all Documents that has document amount less than 100000: Document?filter=documentAmount(LT)100000
| |
(LTE) | Lesser Than or Equal ONLY numeric and date values | Get all Documents that has document amount less than 100000, including 100000: Document?filter=documentAmount(LT)100000
| |
(IN) | Equals One of the Elements in a Given List | Get all Documents that are ready for posting and has status type INI, INO, CRI or CRO: Document?filter=invoicingStatus.statusTypeCode(EQ)RFP&filter=invoicingStatus.statusTypeCode(IN)(INI,INO,CRI,CRO) | |
(NULL) | Filter for NULL values | 2.10 | Get all Documents without business partner: Document?filter=businessPartner.key(NULL) |
(NOTNULL) | Filter for NOT NULL values | 2.10 | Get all Voyages with vessel: Voyage?filter=vessel.key(NOTNULL) |
| (LK) | Like operator | 3.3 | Get all BunkerOrder with externalReferenceNo containing exactly the string "test": BunkerOrder?filter=externalReferenceNo(LK)test |
| (LKIC) | Like ignore case operator | 3.3 | Get all BunkerOrder with externalReferenceNo containing the string "test" regardless upper or lower case: BunkerOrder?filter=externalReferenceNo(LKIC)tEsT |
...
The following properties are currently not possible for filtering:
- self
- remarks
A few other properties are unsupported, these are documented for each resource.
Examples
Cargo
Get Cargo with freight more than 1000000 and freightCurrency USD or EUR:
...