$Filter Options

This page is continued from Filtering Collections ($filter) and contains the $filter parameters.

Accounts ($filter)

The following table provides the search criteria that could be used for constructing a $filter expression for GET /api/accounts

PropertyTypeExample
idint/api/accounts?$filter=Id eq 234
namestring/api/accounts?$filter=name eq ‘My Account’
codestring/api/accounts?$filter=code eq ‘ICP1’
phonestring/api/accounts?$filter=phone eq ‘+306980495483’
faxstring/api/accounts?$filter=phone eq ‘+306980495484’
websitestring/api/accounts?$filter=website eq ‘+306980495484’
emailstring/api/accounts?$filter=contains(email, ‘@interworks.cloud’)
folderstring/api/accounts?$filter=folder eq ‘myfiles’
orderingEnabledboolean/api/accounts?$filter=orderingEnabled eq true
billToAccountIdnumeric/api/accounts?$filter=billToAccountId eq 3540
billToAccountName string/api/accounts?$filter=billToAccountName eq ‘My Account’
separateInvoicesboolean/api/accounts?$filter=seperateInvoices eq true
isBackOrderingboolean/api/accounts?$filter=isBackOrdering eq true
isNetworkResellerboolean/api/accounts?$filter=isNetworkReseller eq true
currencystring/api/accounts?$filter=currency eq ‘EUR’
transactionCurrencystring/api/accounts?$filter=transactionCurrency eq ‘EUR’
taxableboolean/api/accounts?$filter=taxable eq true
creditLimitnumeric/api/accounts?$filter=creditLimit gt 5000
paymentMethodstring/api/accounts?$filter=paymentMethod eq ‘Paypal’
registrationNumberstring/api/accounts?$filter=registrationNumber eq ‘120039484’
autoInvoiceNotificationboolean/api/accounts?$filter=autoInvoiceNotification eq true
resellingEnabledboolean/api/accounts?$filter=resellingEnabled eq true
typeIdnumeric/api/accounts?$filter=typeId eq 6
industryIdnumeric/api/accounts?$filter=industryId eq 3
leadSourceIdnumeric/api/accounts?$filter=leadSourceId eq 8
tradingNamestring/api/accounts?$filter=tradingName eq ‘Company, Ltd.’
businessActivitystring/api/accounts?$filter=businessActivity eq ‘SaaS’
taxAuthorityIdnumeric/api/accounts?$filter=taxAuthorityId eq 20
noteTypestring/api/accounts?$filter=noteType eq ‘Invoice’
createdAtdate/api/accounts?$filter=createdAt gt datetime’2020-02-01′
updatedAtdate/api/accounts?$filter=updatedAt gt datetime’2020-02-01′

Assets ($filter)

The following table provides the search criteria that could be used for constructing a $filter expression for GET /api/assets

PropertyTypeExample
idGuid/api/assets?$filter=id eq ‘910F799A-80DE-4202-A4FA-88691C4667EE’
namestring/api/assets?$filter=name eq ‘My Account’
customerNamestring/api/assets?$filter=customerName eq ‘My Customer’
customerIdnumeric/api/assets?$filter=customerId  eq 7489
billingToNamestring/api/assets?$filter=billingToName eq ‘My Account’
billingToIdnumeric/api/assets?$filter=billingToId eq 7480
statusstring/api/assets?$filter=status eq ‘Active’
productName string/api/assets?$filter=productName eq ‘Simple Product’
productCodestring/api/assets?$filter=productCode eq ‘simple’
productId string/api/assets?$filter=productId eq ‘FA2A4845-E4B4-4CC6-98B1-550B6EB669EF’
isBackOrdering boolean/api/assets?$filter=isBackOrdering eq true
createdAtdate/api/assets?$filter=createdAt gt datetime’2020-02-01′
updatedAtdate/api/assets?$filter=updatedAt gt datetime’2020-02- 01′

Bundles ($filter)

The following table provides the search criteria that could be used for constructing a $filter expression for GET /api/bundles

PropertyTypeExample
idGuid/api/bundles?$filter=id eq ‘117991E7-8610-45AE-80F4-00009D0248C7’
namestring/api/bundles?$filter=name eq ‘Lite Azure Bundle’
codestring/api/bundles?$filter=code eq ‘LAB’
categorystring/api/bundles?$filter=category eq ‘2021 Bundles’
industrystring/api/bundles?$filter=industry eq ‘Logistics’
isActiveboolean/api/bundles?$filter=isActive eq true
isDeletedboolean/api/bundles?$filter=isDeleted eq true
isStorefrontEnabledboolean/api/bundles?$filter=isStorefrontEnabled eq true
createdAtdateTime/api/bundles?$filter=createdAt eq datetime’2021-01-01′
updatedAtdateTime/api/bundles?$filter=updatedAt eq datetime’2021-01-01′

Bundle Child Subscriptions ($filter)

The following table provides the search criteria that could be used for constructing a $filter expression for GET /api/bundleChildSubscriptions

PropertyTypeExample
idGuid/api/bundleChildSubscriptions?$filter=Id eq ‘6650B4D9-2892-4732-9F2F-5349A12299C9’
namestring/api/bundleChildSubscriptions?$filter=name eq ‘test’
typeIdnumeric/api/bundleChildSubscriptions?$filter=typeId eq 5
typeNamestring/api/bundleChildSubscriptions?$filter=typeName eq ‘test’
currencystring/api/bundleChildSubscriptions?$filter=currency eq ‘EUR’
orderIdstring/api/bundleChildSubscriptions?$filter=orderId eq ‘6650B4D9-2892-4732-9F2F-5349A12299C9’
orderCodestring/api/bundleChildSubscriptions?$filter=orderCode eq ‘test’
accountIdnumeric/api/bundleChildSubscriptions?$filter=accountId eq 5
accountNamestring/api/bundleChildSubscriptions?$filter=accountName eq ‘test’
billingToIdnumeric/api/bundleChildSubscriptions?$filter=billingToId eq 5
billingToNamestring/api/bundleChildSubscriptions?$filter=billingToName eq ‘test’
billToContactIdnumeric/api/bundleChildSubscriptions?$filter=billToContactId eq 5
billToContactFirstNamestring/api/bundleChildSubscriptions?$filter=billToContactFirstName eq ‘test’
billToContactLastNamestring/api/bundleChildSubscriptions?$filter=billToContactLastName eq ‘test’
startDatedate/api/bundleChildSubscriptions?$filter=startDate eq dateTime’2021-01-01′
endDatedate/api/bundleChildSubscriptions?$filter=endDate eq dateTime’2021-01-31′
activationDatedate/api/bundleChildSubscriptions?$filter=activationDate eq dateTime’2021-01-01′
automaticRenewalboolean/api/bundleChildSubscriptions?$filter=autmaticRenewal eq true
isBackorderingboolean/api/bundleChildSubscriptions?$filter=isBackordering eq true
productIdstring/api/bundleChildSubscriptions?$filter=productId eq ‘6650B4D9-2892-4732-9F2F-5349A12299C9’
productNamestring/api/bundleChildSubscriptions?$filter=productName eq ‘test’
productCodestring/api/bundleChildSubscriptions?$filter=productCode eq ‘test’
quantitynumeric/api/bundleChildSubscriptions?$filter=quantity eq 5
bundleSubscriptionIdstring/api/bundleChildSubscriptions?$filter=bundleSubscriptionId eq ‘6650B4D9-2892-4732-9F2F-5349A12299C9’
createdAtdate/api/bundleChildSubscriptions?$filter=createdAt eq dateTime’2021-01-01′
updatedAtdate/api/bundleChildSubscriptions?$filter=updatedAt eq dateTime’2021-01-01′

Contacts ($filter)

The following table provides the search criteria that could be used for constructing a $filter expression for GET /api/contacts

PropertyTypeExample
idint/api/contacts?$filter=Id eq 123
firstNamestring/api/contacts?$filter=firstName eq ‘My Contact First Name’
lastNamestring/api/contacts?$filter=lastName eq ‘My Contact Last Name’
emailstring/api/contacts?$filter=email eq ‘[email protected]
accountNamestring/api/contacts?$filter=accountName eq ‘My Account’
accountIdnumeric/api/contacts?$filter=accountId eq 8739
storefrontUserEnabledboolean/api/contacts?$filter=storefrontUserEnabled eq true
billToContactboolean/api/contacts?$filter=billToContact eq true
primaryContact boolean/api/contacts?$filter=primaryContact  eq true
createdAtdate/api/contacts?$filter=createdAt gt datetime’2020-02-01′
updatedAtdate/api/contacts?$filter=updatedAt gt datetime’2020-02-01′

Documents ($filter)

The following table provides the search criteria that could be used for constructing a $filter expression for GET/api/files/folders

PropertyTypeDescriptionAccepted OperationsExample
IdintFilters the request response by the Id field.eq, ne, gt, ge, lt, le/api/files/folders?$filter=Id eq 1
NamestringFilters the request response by the Name field.eq, contains, starts with, ends with/api/files/folders?$filter=name eq ‘test-folder’

Invoices ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/invoices.

PropertyTypeExample
idGuid/api/invoices?$filter=id eq ‘4A65A256-328D-44B1-AB2D-B6A648C5217C’
code string/api/invoices?$filter=code eq ‘INV0339’
statusstring/api/invoices?$filter=status eq ‘Unpaid’
invoiceDatedate/api/invoices?$filter=invoiceDate gt datetime’2020-10-01′
dueDatedate/api/invoices?$filter=dueDate gt datetime’2020-10-01′
billingToId numeric/api/invoices?$filter=billingToId eq 8739
billingToNamestring/api/invoices?$filter=billingToName eq ‘My Account’
paymentMethodstring/api/invoices?$filter=paymentMethod eq ‘Paypal’
transactionCurrencystring/api/invoices?$filter=transactionCurrency eq ‘EUR’
createdAtdate/api/invoices?$filter=createdAt gt datetime’2020-02-01′
updatedAtdate/api/invoices?$filter=updatedAt gt datetime’2020-02-01′

Payments ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/payments

PropertyTypeExample
idGuid/api/payments?$filter=id eq ‘DE6557A9-5A55-46AE-B628-951769D2A1FA’
statusstring/api/payments?$filter=status eq ‘completed’
paymentDatedate/api/payments?$filter=paymentDate eq datetime’2021-01-01′
accountIdnumeric/api/payments?$filter=accountId eq 123
accountNamestring/api/payments?$filter=accountName eq ‘test’
paymentMethodIdGuid/api/payments?$filter=paymentMethodId eq ‘DE6557A9-5A55-46AE-B628-951769D2A1FA’
paymentMethodNamestring/api/payments?$filter=paymentMethodName eq ‘Stripe’
paymentMethodTypestring/api/payments?$filter=paymentMethodType eq ‘creditcard’
currencystring/api/payments?$filter=currency eq ‘eur’
transactionCurrencystring/api/payments?$filter=transactionCurrency eq ‘usd’
createdAtdate/api/payments?$filter=createdAt eq datetime’2021-01-01′
updatedAtdate/api/payments?$filter=updatedAt eq datetime’2021-01-01′

Orders ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/orders.

PropertyTypeExample
idGuid/api/orders?$filter=id eq ‘117991E7-8610-45AE-80F4-00009D0248C7’
code string/api/orders?$filter=code eq ‘Order3937’
namestring/api/orders?$filter=name eq ‘My Account’
statusstring/api/orders?$filter=status eq ‘Submitted’
accountIdnumeric/api/orders?$filter=accountId eq 7489
accountNamestring/api/orders?$filter=accountName eq ‘My Account’
billingToIdnumeric/api/orders?$filter=billingToId eq 7480
billingToNamestring/api/orders?$filter=billingToName eq ‘My Account’
paymentMethodstring/api/orders?$filter=paymentMethod eq ‘Paypal’
createdAtdate/api/orders?$filter=createdAt gt datetime’2020-02-01′
updatedAtdate/api/orders?$filter=updatedAt gt datetime’2020-02-01′

Products ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/products.

PropertyTypeExample
idGuid/api/products?$filter=id eq ‘117991E7-8610-45AE-80F4-00009D0248C7’
code string/api/products?$filter=code eq ‘simple’
namestring/api/products?$filter=name eq ‘Simple Product’
isActiveboolean/api/products?$filter=isActive eq true
isDeleted boolean/api/products?$filter=isDeleted eq false
isAddonboolean/api/products?$filter=isAddon eq false
categorystring/api/products?$filter=category eq ‘SaaS’
industrystring/api/products?$filter=industry eq ‘Telecommunications’
productTypestring/api/products?$filter=productType eq ‘Example Product Type’
productTypeIdstring/api/products?$filter=productTypeId eq ‘B52B0398-D71A-4E20-887B-898F4EE5480C’
isStorefrontPublishedboolean/api/products?$filter=isStorefrontPublished eq true
createdAtdate/api/products?$filter=createdAt gt datetime’2020-02-01′
updatedAtdate/api/products?$filter=updatedAt gt datetime’2020-02-01′

Pricelists ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/pricelists.

PropertyTypeExample
idint/api/pricelists?$filter=id eq 123
namestring/api/pricelists?$filter=name eq ‘My List’
isActivebool/api/pricelists?$filter=isActive eq true
fromdate/api/pricelists?$filter=from eq datetime’2020-02-01′
todate/api/pricelists?$filter=to eq datetime’2020-02-01′
currency string/api/pricelists?$filter=currency eq ‘EUR’
createdAtdate/api/pricelists?$filter=createdAt eq datetime’2020-02-01′
updatedAtdate/api/pricelists?$filter=updatedAt eq datetime’2020-02-01′

Pricelist Items ($filter)

The following table provides the search criteria that could be used for constructing a $filter expression for GET /api/pricelists/{pricelistId}/items

PropertyTypeExample
idint/api/pricelists?$filter=id eq 123
productIdstring/api/pricelists/{pricelistId}/items?$filter=productId eq ‘BF90368E-A84C-4697-8709-7827D61D6D6D’
productNamestring/api/pricelists/{pricelistId}/items?$filter=productName eq ‘test’
productCodestring/api/pricelists/{pricelistId}/items?$filter=productCode eq ‘test’
unitIdstring/api/pricelists/{pricelistId}/items?$filter=unitId eq ‘BF90368E-A84C-4697-8709-7827D61D6D6D’
unitNamestring/api/pricelists/{pricelistId}/items?$filter=unitName eq ‘test’
volumeDiscountIdnumeric/api/pricelists/{pricelistId}/items?$filter=volumeDiscountId eq ‘7’
volumeDisnountNamestring/api/pricelists/{pricelistId}/items?$filter=volumeDiscountName eq ‘test’
priceGroupIdstring/api/pricelists/{pricelistId}/items?$filter=priceGroupId eq ‘BF90368E-A84C-4697-8709-7827D61D6D6D’
priceGroupNamestring/api/pricelists/{pricelistId}/items?$filter=priceGroupName eq ‘test’
pricingMethodstring/api/pricelists/{pricelistId}/items?$filter=pricingMethod eq ‘Currency Amount’
amountnumeric/api/pricelists/{pricelistId}/items?$filter=amount eq 27

PriceGroup Items ($filter)

The following table provides the search criteria that could be used for constructing a $filter expression for GET /api/pricelists/{pricelistId}/pricegroups/{pricegroupId}

PropertyTypeExample
unitIdstring/api/pricelists/{pricelistId}/pricegroups/{pricegroupId}?$filter=unitId eq ‘BF90368E-A84C-4697-8709-7827D61D6D6D’
unitNamestring/api/pricelists/{pricelistId}/pricegroups/{pricegroupId}?$filter=unitName eq ‘test’
volumeDiscountIdnumeric/api/pricelists/{pricelistId}/pricegroups/{pricegroupId}?$filter=volumeDiscountId eq ‘7’
volumeDisnountNamestring/api/pricelists/{pricelistId}/pricegroups/{pricegroupId}?$filter=volumeDiscountName eq ‘test’
pricingMethodstring/api/pricelists/{pricelistId}/pricegroups/{pricegroupId}?$filter=pricingMethod eq ‘Currency Amount’
amountnumeric/api/pricelists/{pricelistId}/pricegroups/{pricegroupId}?$filter=amount eq 27

Leads ($filter)

PropertyTypeExample
idint/api/leads?$filter=Id eq 213
firstName string/api/leads?$filter=firstName eq ‘My name’
lastNamestring/api/leads?$filter=lastName eq ‘last’
middleNamestring/api/leads?$filter=middleName eq ‘doe’
compellation string/api/leads?$filter=compellation eq ‘johny’
company string/api/leads?$filter=company eq ‘interworks’
jobTitle string/api/leads?$filter=jobTitle eq ‘Developer’
emailstring/api/leads?$filter=contains(email, ‘@interworks.cloud’)
currency  string/api/leads?$filter=currency eq ‘EUR’
titlestring/api/leads?$filter=title eq ‘Mr’
leadSourcenumeric/api/leads?$filter=leadSource eq 22
industrynumeric/api/leads?$filter=industry eq 52
statusnumeric/api/leads?$filter=status eq 5
ratingnumeric/api/leads?$filter=rating eq 5
accountIdnumeric/api/leads?$filter=accountId eq 20555
contactIdnumeric/api/leads?$filter=contactId eq 9999
phonestring/api/leads?$filter=phone eq ‘29999999’
mobilePhonestring/api/leads?$filter=mobilePhone eq ‘6999999’
fax string/api/leads?$filter=fax eq ‘21099999’
websitestring/api/leads?$filter=website eq ‘www.google.com
annualRevenuenumeric/api/leads?$filter=annualRevenue gt 500
employeesnumeric/api/leads?$filter=employees eq 5
enableMassEmailboolean/api/leads?$filter=enableMassMail eq true
countryIdnumeric/api/leads?$filter=countryId eq 6
stateIdnumeric/api/leads?$filter=stateId eq 3
citystring/api/leads?$filter=city eq ‘Thessaloniki’
postCodestring/api/leads?$filter=postCode eq ‘58000’
isConvertedboolean/api/leads?$filter=isConverted eq true
createdAtdate/api/leads?$filter=createdAt gt datetime’2020-02-01′
updatedAtdate/api/leads?$filter=updatedAt gt datetime’2020-02-01′

Subscriptions ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/leads

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/subscriptions

PropertyTypeExample
idGuid/api/subscriptions?$filter=id eq ‘6650B4D9-2892-4732-9F2F-5349A12299C9’
namestring/api/subscriptions?$filter=name eq ‘test’
typeIdnumeric/api/subscriptions?$filter=typeId eq 5
typeNamestring/api/subscriptions?$filter=typeName eq ‘test’
currencystring/api/subscriptions?$filter=currency eq ‘EUR’
orderIdstring/api/subscriptions?$filter=orderId eq ‘6650B4D9-2892-4732-9F2F-5349A12299C9’
orderCodestring/api/subscriptions?$filter=orderCode eq ‘test’
accountIdnumeric/api/subscriptions?$filter=accountId eq 5
accountNamestring/api/subscriptions?$filter=accountName eq ‘test’
billingToIdnumeric/api/subscriptions?$filter=billingToId eq 5
billingToNamestring/api/subscriptions?$filter=billingToName eq ‘test’
billToContactIdnumeric/api/subscriptions?$filter=billToContactId eq 5
billToContactFirstNamestring/api/subscriptions?$filter=billToContactFirstName eq ‘test’
billToContactLastNamestring/api/subscriptions?$filter=billToContactLastName eq ‘test’
startDatedate/api/subscriptions?$filter=startDate eq dateTime’2021-01-01′
endDatedate/api/subscriptions?$filter=endDate eq dateTime’2021-01-31′
activationDatedate/api/subscriptions?$filter=activationDate eq dateTime’2021-01-01′
automaticRenewalboolean/api/subscriptions?$filter=autmaticRenewal eq true
isBackorderingboolean/api/subscriptions?$filter=isBackordering eq true
isTrialboolean/api/subscriptions?$filter=isTrial eq true
productIdstring/api/subscriptions?$filter=productId eq ‘6650B4D9-2892-4732-9F2F-5349A12299C9’
productNamestring/api/subscriptions?$filter=productName eq ‘test’
productCodestring/api/subscriptions?$filter=productCode eq ‘test’
isBundleboolean/api/subscriptions?$filter=isBundle eq true
quantitynumeric/api/subscriptions?$filter=quantity eq 5
subscriptionAmountnumeric/api/subscriptions?$filter=subscriptionAmount eq 5
createdAtdate/api/subscriptions?$filter=createdAt eq dateTime’2021-01-01′
updatedAtdate/api/subscriptions?$filter=updatedAt eq dateTime’2021-01-01′

FutureActions ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/futureactions

NameTypeExample
idGuid/api/futureActions?$filter=Id eq ‘6650B4D9-2892-4732-9F2F-5349A12299C9’
subscriptionIdstring/api/futureActions?$filter=subscriptionId eq ‘6650B4D9-2892-4732-9F2F-5349A12299C9’
addonIdstring/api/futureActions?$filter=addonId eq ‘6650B4D9-2892-4732-9F2F-5349A12299C9’
actionstring/api/futureActions?$filter=action eq ‘CancellationOnEnd’
requestDatedate/api/futureActions?$filter=requestDate eq dateTime’2021-01-01′
effectiveDatedate/api/futureActions?$filter=effectiveDate eq dateTime’2021-01-01′
createdAtdate/api/futureActions?$filter=createdAt eq dateTime’2021-01-01′
updatedAtdate/api/futureActions?$filter=updatedAt eq dateTime’2021-01-01′

Organization

Organization/Countries ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/organization/countries

PropertyTypeExample
idint/api/organization/countries?$filter=id eq 123
namestring/api/organization/countries?$filter=name eq ‘Greece’
codestring/api/organization/countries?$filter=code eq ‘GR’

Organization/Languages ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/organization/languages

PropertyTypeExample
idGuid/api/organization/languages?$filter=id eq ‘117991E7-8610-45AE-80F4-00009D0248C7’
codestring/api/organization/languages?$filter=code eq ‘English’
isDefaultboolean/api/organization/languages?$filter=isDefault eq true

Organization/Currencies ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/organization/currencies

PropertyTypeExample
idGuid/api/organization/currencies?$filter=id eq ‘117991E7-8610-45AE-80F4-00009D0248C7’
namestring/api/organization/currencies?$filter=name eq ‘Euro’
mnemonicstring/api/organization/currencies?$filter=mnemonic eq ‘EUR’
codestring/api/organization/currencies?$filter=code eq ‘051’
isActiveboolean/api/organization/currencies?$filter=isActive eq true
isDefaultboolean/api/organization/currencies?$filter=isDefault eq true

Organization/Payment Methods ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/organization/paymentmethods

PropertyTypeExample
idstring/api/organization/paymentMethods?$filter=id eq ‘8DE31F26-3694-48CF-94DE-9D185AD1FD07’
namestring/api/organization/paymentMethods?$filter=name eq ‘MyMasterCard’
typestring/api/organization/paymentMethods?$filter=type eq ‘CreditCard’
isActiveboolean/api/organization/paymentMethods?$filter=isActive eq true
isDefaultboolean/api/organization/paymentMethods?$filter=isDefault eq true
isStorefrontUseboolean/api/organization/paymentMethods?$filter=isStorefrontUse eq true
gatewayNamestring/api/organization/paymentMethods?$filter=gatewayName eq ‘NationalBank’

Organization/Taxes ($filter)

PropertyTypeExample
idint/api/organization/taxes?$filter=id eq 10
namestring/api/organization/taxes?$filter=name eq ‘VAT 23’
displayNamestring/api/organization/taxes?$filter=displayName eq ‘VAT’
isActiveboolean/api/organization/taxes?$filter=isActive eq true
isExcludedEUboolean/api/organization/taxes?$filter=isExcludedEU eq true

Organization/Tax Authorities ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/organization/taxes

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/organization/taxauthorities

PropertyTypeExample
idint/api/organization/taxAuthorities?$filter=id eq 10
namestring/api/organization/taxAuthorities?$filter=name eq ‘test’
codestring/api/organization/taxAuthorities?$filter=code eq ‘test’

Organization/Account Types ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/organization/accounts/types

PropertyTypeExample
idint/api/organization/accounts/types?$filter=id eq 123
namestring/api/organization/accounts/types?$filter=name eq ‘Partner’
isDefaultboolean/api/organization/accounts/types?$filter=isDefault eq true

Organization/Invoice Statuses ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/organization/invoices/statuses

PropertyTypeExample
idint/api/organization/invoices/statuses?$filter=id eq 123
namestring/api/organization/invoices/statuses?$filter=name eq ‘in 2021’
typestring/api/organization/invoices/statuses?$filter=type eq ‘Paid’

Organization/Invoice Types ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/organization/invoices/types

PropertyTypeExample
idint/api/organization/invoices/types?$filter=id eq 123
namestring/api/organization/invoices/types?$filter=name eq ‘Partner Debit’
typestring/api/organization/invoices/types?$filter=type eq ‘Debit’

Organization/Lead Statuses ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/organization/leads/statuses

PropertyTypeExample
idint/api/organization/leads/statuses?$filter=id eq 123
namestring/api/organization/leads/statuses?$filter=name eq ‘Active’
typestring/api/organization/leads/statuses?$filter=type eq ‘Open’
isActiveboolean/api/organization/leads/statuses?$filter=isActivet eq true
isDefaultboolean/api/organization/leads/statuses?$filter=isDefault eq true

Organization/Lead Sources ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/organization/leads/sources

PropertyTypeExample
idint/api/organization/leads/sources?$filter=id eq 123
namestring/api/organization/leads/sources?$filter=name eq ‘Marketing’
isActiveboolean/api/organization/leads/sources?$filter=isActivet eq true
isDefaultboolean/api/organization/leads/sources?$filter=isDefault eq true

Organization/Lead Ratings ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/organization/leads/ratings

PropertyTypeExample
idint/api/organization/leads/ratings?$filter=id eq 123
namestring/api/organization/leads/ratings?$filter=name eq ‘Five Star’
isDefaultboolean/api/organization/leads/ratings?$filter=isDefault eq true

Organization/Titles ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/organization/titles

PropertyTypeExample
idint/api/organization/titles?$filter=id eq 123
namestring/api/organization/titles?$filter=name eq ‘Mister’
mnemonicstring/api/organization/titles?$filter=mnemonic eq ‘Mr.’

Organization/Product Types ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/organization/producttypes

PropertyTypeExample
idGuid/api/organization/productTypes?$filter=id eq ‘117991E7-8610-45AE-80F4-00009D0248C7’
namestring/api/organization/productTypes?$filter=name eq ‘Office 365’
basicTypeNamestring/api/organization/productTypes?$filter=basicTypeName eq ‘Microsoft Office’
vendorstring/api/organization/productTypes?$filter=vendor eq ‘Microsoft’
assetTypestring/api/organization/productTypes?$filter=assetType eq ‘License’

Organization/Unit Groups ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/organization/unitgroups

PropertyTypeExample
idint/api/organization/unitGroups?$filter=id eq 123
namestring/api/organization/unitGroups?$filter=name eq ‘Recurring Charges’

Organization/Volume Discounts ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/organization/volumediscounts

PropertyTypeExample
idint/api/organization/volumeDiscounts?$filter=id eq 123
namestring/api/organization/volumeDiscounts?$filter=name eq ‘TenPlus’
isScalableboolean/api/organization/volumeDiscounts?$filter=isScalable eq true
isActiveboolean/api/organization/volumeDiscounts?$filter=isActive eq true

Organization/Units of Measure ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/organization/unitsofmeasure

PropertyTypeExample
idGuid/api/organization/unitsOfMeasure?$filter=id eq ‘117991E7-8610-45AE-80F4-00009D0248C7’
namestring/api/organization/unitsOfMeasure?$filter=name eq ‘Instance’
isActiveboolean/api/organization/unitsOfMeasure?$filter=isActive eq true
isDefaultboolean/api/organization/unitsOfMeasure?$filter=isDefault eq true

Organization/Price Groups ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/organization/pricegroups

PropertyTypeExample
idGuid/api/organization/priceGroups?$filter=id eq ‘117991E7-8610-45AE-80F4-00009D0248C7’
namestring/api/organization/priceGroups?$filter=name eq ‘Europe Resellers’

Organization/Product Industries ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/organization/products/industries

PropertyTypeExample
idint/api/organization/products/industries?$filter=id eq 123
namestring/api/organization/products/industries?$filter=name eq ‘Information Technologies’
isActiveboolean/api/organization/products/industries?$filter=isActive eq true
isDefaultboolean/api/organization/products/industries?$filter=isDefault eq true

Organization/Industries ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/organization/industries

PropertyTypeExample
idint/api/organization/industries?$filter=id eq 123
namestring/api/organization/industries?$filter=name eq ‘Health-Care’
isDefaultboolean/api/organization/industries?$filter=isDefault eq true

Organization/Custom Fields ($filter)

The following table provides the search criteria that could be used for constructing an $filter 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
PropertyTypeExample
idint/api/organization/{module}/customfields?$filter=id eq 123
namestring/api/organization/{module}/customfields?$filter=name eq ‘Package Number’
groupIdnumeric/api/organization/{module}/customfields?$filter=groupId eq 5
groupNamestring/api/organization/{module}/customfields?$filter=groupName eq ‘test’
typestring/api/organization/{module}/customfields?$filter=type eq ‘SimpleValue’
isCompulsoryboolean/api/organization/{module}/customfields?$filter=isCompulsory eq true
isReadOnlyboolean/api/organization/{module}/customfields?$filter=isReadyOnly eq true

Synchronization

Synchronization/Accounts ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET api/synchronization/{systemId}/accounts are:

NameTypeDescriptionAccepted OperationsExample
syncStatusstringFilters the request response by the Status field.eq, contains, starts with, ends with/api/synchronization/{systemId}/accounts?$filter=SyncStatus eq ‘Failed’
objectstringFilters the request response by the Account.Id field.eq, contains, starts with, ends with/api/synchronization/{systemId}/accounts?$filter=Object eq ‘5’

Synchronization/Assets ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET api/synchronization/{systemId}/assets are:

NameTypeDescriptionAccepted OperationsExample
syncStatusstringFilters the request response by the Status field.eq, contains, starts with, ends with/api/synchronization/{systemId}/assets?$filter=SyncStatus eq ‘Failed’
objectstringFilters the request response by the Asset.Id field.eq, contains, starts with, ends with/api/synchronization/{systemId}/assets?$filter=Object eq ‘GUID’

Synchronization/ProductTypes($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET api/synchronization/{systemId}/productTypes are:

NameTypeDescriptionAccepted OperationsExample
syncStatusstringFilters the request response by the Status field.eq, contains, starts with, ends with/api/synchronization/{systemId}/productTypes?$filter=SyncStatus eq ‘Failed’
objectstringFilters the request response by the ProductType.Id field.eq, contains, starts with, ends with/api/synchronization/{systemId}/productTypes?$filter=Object eq ‘GUID’

Synchronization/Products($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET api/synchronization/{systemId}/products are:

NameTypeDescriptionAccepted OperationsExample
syncStatusstringFilters the request response by the Status field.eq, contains, starts with, ends with/api/synchronization/{systemId}/products?$filter=SyncStatus eq ‘Failed’
productIdGuidFilters the request response by the Product.Id field.eq, ne/api/synchronization/{systemId}/products?$filter=productId eq ‘D89FC8BD-FACF-4FAC-AFBE-97917C2319EE’

System

System/Countries ($filter)

The following table provides the search criteria that could be used for constructing an $filter expression for GET /api/system/countries

PropertyTypeExample
namestring/api/system/countries?$filter=name eq ‘Greece’
codestring/api/system/countries?$filter=code eq ‘GR’