$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

Property	Type	Example
id	int	/api/accounts?$filter=Id eq 234
name	string	/api/accounts?$filter=name eq ‘My Account’
code	string	/api/accounts?$filter=code eq ‘ICP1’
phone	string	/api/accounts?$filter=phone eq ‘+306980495483’
fax	string	/api/accounts?$filter=phone eq ‘+306980495484’
website	string	/api/accounts?$filter=website eq ‘+306980495484’
email	string	/api/accounts?$filter=contains(email, ‘@interworks.cloud’)
folder	string	/api/accounts?$filter=folder eq ‘myfiles’
orderingEnabled	boolean	/api/accounts?$filter=orderingEnabled eq true
billToAccountId	numeric	/api/accounts?$filter=billToAccountId eq 3540
billToAccountName	string	/api/accounts?$filter=billToAccountName eq ‘My Account’
separateInvoices	boolean	/api/accounts?$filter=seperateInvoices eq true
isBackOrdering	boolean	/api/accounts?$filter=isBackOrdering eq true
isNetworkReseller	boolean	/api/accounts?$filter=isNetworkReseller eq true
currency	string	/api/accounts?$filter=currency eq ‘EUR’
transactionCurrency	string	/api/accounts?$filter=transactionCurrency eq ‘EUR’
taxable	boolean	/api/accounts?$filter=taxable eq true
creditLimit	numeric	/api/accounts?$filter=creditLimit gt 5000
paymentMethod	string	/api/accounts?$filter=paymentMethod eq ‘Paypal’
registrationNumber	string	/api/accounts?$filter=registrationNumber eq ‘120039484’
autoInvoiceNotification	boolean	/api/accounts?$filter=autoInvoiceNotification eq true
resellingEnabled	boolean	/api/accounts?$filter=resellingEnabled eq true
typeId	numeric	/api/accounts?$filter=typeId eq 6
industryId	numeric	/api/accounts?$filter=industryId eq 3
leadSourceId	numeric	/api/accounts?$filter=leadSourceId eq 8
tradingName	string	/api/accounts?$filter=tradingName eq ‘Company, Ltd.’
businessActivity	string	/api/accounts?$filter=businessActivity eq ‘SaaS’
taxAuthorityId	numeric	/api/accounts?$filter=taxAuthorityId eq 20
noteType	string	/api/accounts?$filter=noteType eq ‘Invoice’
createdAt	date	/api/accounts?$filter=createdAt gt datetime’2020-02-01′
updatedAt	date	/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

Property	Type	Example
id	Guid	/api/assets?$filter=id eq ‘910F799A-80DE-4202-A4FA-88691C4667EE’
name	string	/api/assets?$filter=name eq ‘My Account’
customerName	string	/api/assets?$filter=customerName eq ‘My Customer’
customerId	numeric	/api/assets?$filter=customerId  eq 7489
billingToName	string	/api/assets?$filter=billingToName eq ‘My Account’
billingToId	numeric	/api/assets?$filter=billingToId eq 7480
status	string	/api/assets?$filter=status eq ‘Active’
productName	string	/api/assets?$filter=productName eq ‘Simple Product’
productCode	string	/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
createdAt	date	/api/assets?$filter=createdAt gt datetime’2020-02-01′
updatedAt	date	/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

Property	Type	Example
id	Guid	/api/bundles?$filter=id eq ‘117991E7-8610-45AE-80F4-00009D0248C7’
name	string	/api/bundles?$filter=name eq ‘Lite Azure Bundle’
code	string	/api/bundles?$filter=code eq ‘LAB’
category	string	/api/bundles?$filter=category eq ‘2021 Bundles’
industry	string	/api/bundles?$filter=industry eq ‘Logistics’
isActive	boolean	/api/bundles?$filter=isActive eq true
isDeleted	boolean	/api/bundles?$filter=isDeleted eq true
isStorefrontEnabled	boolean	/api/bundles?$filter=isStorefrontEnabled eq true
createdAt	dateTime	/api/bundles?$filter=createdAt eq datetime’2021-01-01′
updatedAt	dateTime	/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

Property	Type	Example
id	Guid	/api/bundleChildSubscriptions?$filter=Id eq ‘6650B4D9-2892-4732-9F2F-5349A12299C9’
name	string	/api/bundleChildSubscriptions?$filter=name eq ‘test’
typeId	numeric	/api/bundleChildSubscriptions?$filter=typeId eq 5
typeName	string	/api/bundleChildSubscriptions?$filter=typeName eq ‘test’
currency	string	/api/bundleChildSubscriptions?$filter=currency eq ‘EUR’
orderId	string	/api/bundleChildSubscriptions?$filter=orderId eq ‘6650B4D9-2892-4732-9F2F-5349A12299C9’
orderCode	string	/api/bundleChildSubscriptions?$filter=orderCode eq ‘test’
accountId	numeric	/api/bundleChildSubscriptions?$filter=accountId eq 5
accountName	string	/api/bundleChildSubscriptions?$filter=accountName eq ‘test’
billingToId	numeric	/api/bundleChildSubscriptions?$filter=billingToId eq 5
billingToName	string	/api/bundleChildSubscriptions?$filter=billingToName eq ‘test’
billToContactId	numeric	/api/bundleChildSubscriptions?$filter=billToContactId eq 5
billToContactFirstName	string	/api/bundleChildSubscriptions?$filter=billToContactFirstName eq ‘test’
billToContactLastName	string	/api/bundleChildSubscriptions?$filter=billToContactLastName eq ‘test’
startDate	date	/api/bundleChildSubscriptions?$filter=startDate eq dateTime’2021-01-01′
endDate	date	/api/bundleChildSubscriptions?$filter=endDate eq dateTime’2021-01-31′
activationDate	date	/api/bundleChildSubscriptions?$filter=activationDate eq dateTime’2021-01-01′
automaticRenewal	boolean	/api/bundleChildSubscriptions?$filter=autmaticRenewal eq true
isBackordering	boolean	/api/bundleChildSubscriptions?$filter=isBackordering eq true
productId	string	/api/bundleChildSubscriptions?$filter=productId eq ‘6650B4D9-2892-4732-9F2F-5349A12299C9’
productName	string	/api/bundleChildSubscriptions?$filter=productName eq ‘test’
productCode	string	/api/bundleChildSubscriptions?$filter=productCode eq ‘test’
quantity	numeric	/api/bundleChildSubscriptions?$filter=quantity eq 5
bundleSubscriptionId	string	/api/bundleChildSubscriptions?$filter=bundleSubscriptionId eq ‘6650B4D9-2892-4732-9F2F-5349A12299C9’
createdAt	date	/api/bundleChildSubscriptions?$filter=createdAt eq dateTime’2021-01-01′
updatedAt	date	/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

Property	Type	Example
id	int	/api/contacts?$filter=Id eq 123
firstName	string	/api/contacts?$filter=firstName eq ‘My Contact First Name’
lastName	string	/api/contacts?$filter=lastName eq ‘My Contact Last Name’
email	string	/api/contacts?$filter=email eq ‘[email protected]’
accountName	string	/api/contacts?$filter=accountName eq ‘My Account’
accountId	numeric	/api/contacts?$filter=accountId eq 8739
storefrontUserEnabled	boolean	/api/contacts?$filter=storefrontUserEnabled eq true
billToContact	boolean	/api/contacts?$filter=billToContact eq true
primaryContact	boolean	/api/contacts?$filter=primaryContact  eq true
createdAt	date	/api/contacts?$filter=createdAt gt datetime’2020-02-01′
updatedAt	date	/api/contacts?$filter=updatedAt gt datetime’2020-02-01′

Invoices ($filter)

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

Property	Type	Example
id	Guid	/api/invoices?$filter=id eq ‘4A65A256-328D-44B1-AB2D-B6A648C5217C’
code	string	/api/invoices?$filter=code eq ‘INV0339’
status	string	/api/invoices?$filter=status eq ‘Unpaid’
invoiceDate	date	/api/invoices?$filter=invoiceDate gt datetime’2020-10-01′
dueDate	date	/api/invoices?$filter=dueDate gt datetime’2020-10-01′
billingToId	numeric	/api/invoices?$filter=billingToId eq 8739
billingToName	string	/api/invoices?$filter=billingToName eq ‘My Account’
paymentMethod	string	/api/invoices?$filter=paymentMethod eq ‘Paypal’
transactionCurrency	string	/api/invoices?$filter=transactionCurrency eq ‘EUR’
createdAt	date	/api/invoices?$filter=createdAt gt datetime’2020-02-01′
updatedAt	date	/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

Property	Type	Example
id	Guid	/api/payments?$filter=id eq ‘DE6557A9-5A55-46AE-B628-951769D2A1FA’
status	string	/api/payments?$filter=status eq ‘completed’
paymentDate	date	/api/payments?$filter=paymentDate eq datetime’2021-01-01′
accountId	numeric	/api/payments?$filter=accountId eq 123
accountName	string	/api/payments?$filter=accountName eq ‘test’
paymentMethodId	Guid	/api/payments?$filter=paymentMethodId eq ‘DE6557A9-5A55-46AE-B628-951769D2A1FA’
paymentMethodName	string	/api/payments?$filter=paymentMethodName eq ‘Stripe’
paymentMethodType	string	/api/payments?$filter=paymentMethodType eq ‘creditcard’
currency	string	/api/payments?$filter=currency eq ‘eur’
transactionCurrency	string	/api/payments?$filter=transactionCurrency eq ‘usd’
createdAt	date	/api/payments?$filter=createdAt eq datetime’2021-01-01′
updatedAt	date	/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.

Property	Type	Example
id	Guid	/api/orders?$filter=id eq ‘117991E7-8610-45AE-80F4-00009D0248C7’
code	string	/api/orders?$filter=code eq ‘Order3937’
name	string	/api/orders?$filter=name eq ‘My Account’
status	string	/api/orders?$filter=status eq ‘Submitted’
accountId	numeric	/api/orders?$filter=accountId eq 7489
accountName	string	/api/orders?$filter=accountName eq ‘My Account’
billingToId	numeric	/api/orders?$filter=billingToId eq 7480
billingToName	string	/api/orders?$filter=billingToName eq ‘My Account’
paymentMethod	string	/api/orders?$filter=paymentMethod eq ‘Paypal’
createdAt	date	/api/orders?$filter=createdAt gt datetime’2020-02-01′
updatedAt	date	/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.

Property	Type	Example
id	Guid	/api/products?$filter=id eq ‘117991E7-8610-45AE-80F4-00009D0248C7’
code	string	/api/products?$filter=code eq ‘simple’
name	string	/api/products?$filter=name eq ‘Simple Product’
isActive	boolean	/api/products?$filter=isActive eq true
isDeleted	boolean	/api/products?$filter=isDeleted eq false
isAddon	boolean	/api/products?$filter=isAddon eq false
category	string	/api/products?$filter=category eq ‘SaaS’
industry	string	/api/products?$filter=industry eq ‘Telecommunications’
productType	string	/api/products?$filter=productType eq ‘Example Product Type’
productTypeId	string	/api/products?$filter=productTypeId eq ‘B52B0398-D71A-4E20-887B-898F4EE5480C’
isStorefrontPublished	boolean	/api/products?$filter=isStorefrontPublished eq true
createdAt	date	/api/products?$filter=createdAt gt datetime’2020-02-01′
updatedAt	date	/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.

Property	Type	Example
id	int	/api/pricelists?$filter=id eq 123
name	string	/api/pricelists?$filter=name eq ‘My List’
isActive	bool	/api/pricelists?$filter=isActive eq true
from	date	/api/pricelists?$filter=from eq datetime’2020-02-01′
to	date	/api/pricelists?$filter=to eq datetime’2020-02-01′
currency	string	/api/pricelists?$filter=currency eq ‘EUR’
createdAt	date	/api/pricelists?$filter=createdAt eq datetime’2020-02-01′
updatedAt	date	/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

Property	Type	Example
id	int	/api/pricelists?$filter=id eq 123
productId	string	/api/pricelists/{pricelistId}/items?$filter=productId eq ‘BF90368E-A84C-4697-8709-7827D61D6D6D’
productName	string	/api/pricelists/{pricelistId}/items?$filter=productName eq ‘test’
productCode	string	/api/pricelists/{pricelistId}/items?$filter=productCode eq ‘test’
unitId	string	/api/pricelists/{pricelistId}/items?$filter=unitId eq ‘BF90368E-A84C-4697-8709-7827D61D6D6D’
unitName	string	/api/pricelists/{pricelistId}/items?$filter=unitName eq ‘test’
volumeDiscountId	numeric	/api/pricelists/{pricelistId}/items?$filter=volumeDiscountId eq ‘7’
volumeDisnountName	string	/api/pricelists/{pricelistId}/items?$filter=volumeDiscountName eq ‘test’
priceGroupId	string	/api/pricelists/{pricelistId}/items?$filter=priceGroupId eq ‘BF90368E-A84C-4697-8709-7827D61D6D6D’
priceGroupName	string	/api/pricelists/{pricelistId}/items?$filter=priceGroupName eq ‘test’
pricingMethod	string	/api/pricelists/{pricelistId}/items?$filter=pricingMethod eq ‘Currency Amount’
amount	numeric	/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}

Property	Type	Example
unitId	string	/api/pricelists/{pricelistId}/pricegroups/{pricegroupId}?$filter=unitId eq ‘BF90368E-A84C-4697-8709-7827D61D6D6D’
unitName	string	/api/pricelists/{pricelistId}/pricegroups/{pricegroupId}?$filter=unitName eq ‘test’
volumeDiscountId	numeric	/api/pricelists/{pricelistId}/pricegroups/{pricegroupId}?$filter=volumeDiscountId eq ‘7’
volumeDisnountName	string	/api/pricelists/{pricelistId}/pricegroups/{pricegroupId}?$filter=volumeDiscountName eq ‘test’
pricingMethod	string	/api/pricelists/{pricelistId}/pricegroups/{pricegroupId}?$filter=pricingMethod eq ‘Currency Amount’
amount	numeric	/api/pricelists/{pricelistId}/pricegroups/{pricegroupId}?$filter=amount eq 27

Leads ($filter)

Property	Type	Example
id	int	/api/leads?$filter=Id eq 213
firstName	string	/api/leads?$filter=firstName eq ‘My name’
lastName	string	/api/leads?$filter=lastName eq ‘last’
middleName	string	/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’
email	string	/api/leads?$filter=contains(email, ‘@interworks.cloud’)
currency	string	/api/leads?$filter=currency eq ‘EUR’
title	string	/api/leads?$filter=title eq ‘Mr’
leadSource	numeric	/api/leads?$filter=leadSource eq 22
industry	numeric	/api/leads?$filter=industry eq 52
status	numeric	/api/leads?$filter=status eq 5
rating	numeric	/api/leads?$filter=rating eq 5
accountId	numeric	/api/leads?$filter=accountId eq 20555
contactId	numeric	/api/leads?$filter=contactId eq 9999
phone	string	/api/leads?$filter=phone eq ‘29999999’
mobilePhone	string	/api/leads?$filter=mobilePhone eq ‘6999999’
fax	string	/api/leads?$filter=fax eq ‘21099999’
website	string	/api/leads?$filter=website eq ‘www.google.com‘
annualRevenue	numeric	/api/leads?$filter=annualRevenue gt 500
employees	numeric	/api/leads?$filter=employees eq 5
enableMassEmail	boolean	/api/leads?$filter=enableMassMail eq true
countryId	numeric	/api/leads?$filter=countryId eq 6
stateId	numeric	/api/leads?$filter=stateId eq 3
city	string	/api/leads?$filter=city eq ‘Thessaloniki’
postCode	string	/api/leads?$filter=postCode eq ‘58000’
isConverted	boolean	/api/leads?$filter=isConverted eq true
createdAt	date	/api/leads?$filter=createdAt gt datetime’2020-02-01′
updatedAt	date	/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

Property	Type	Example
id	Guid	/api/subscriptions?$filter=id eq ‘6650B4D9-2892-4732-9F2F-5349A12299C9’
name	string	/api/subscriptions?$filter=name eq ‘test’
typeId	numeric	/api/subscriptions?$filter=typeId eq 5
typeName	string	/api/subscriptions?$filter=typeName eq ‘test’
currency	string	/api/subscriptions?$filter=currency eq ‘EUR’
orderId	string	/api/subscriptions?$filter=orderId eq ‘6650B4D9-2892-4732-9F2F-5349A12299C9’
orderCode	string	/api/subscriptions?$filter=orderCode eq ‘test’
accountId	numeric	/api/subscriptions?$filter=accountId eq 5
accountName	string	/api/subscriptions?$filter=accountName eq ‘test’
billingToId	numeric	/api/subscriptions?$filter=billingToId eq 5
billingToName	string	/api/subscriptions?$filter=billingToName eq ‘test’
billToContactId	numeric	/api/subscriptions?$filter=billToContactId eq 5
billToContactFirstName	string	/api/subscriptions?$filter=billToContactFirstName eq ‘test’
billToContactLastName	string	/api/subscriptions?$filter=billToContactLastName eq ‘test’
startDate	date	/api/subscriptions?$filter=startDate eq dateTime’2021-01-01′
endDate	date	/api/subscriptions?$filter=endDate eq dateTime’2021-01-31′
activationDate	date	/api/subscriptions?$filter=activationDate eq dateTime’2021-01-01′
automaticRenewal	boolean	/api/subscriptions?$filter=autmaticRenewal eq true
isBackordering	boolean	/api/subscriptions?$filter=isBackordering eq true
isTrial	boolean	/api/subscriptions?$filter=isTrial eq true
productId	string	/api/subscriptions?$filter=productId eq ‘6650B4D9-2892-4732-9F2F-5349A12299C9’
productName	string	/api/subscriptions?$filter=productName eq ‘test’
productCode	string	/api/subscriptions?$filter=productCode eq ‘test’
isBundle	boolean	/api/subscriptions?$filter=isBundle eq true
quantity	numeric	/api/subscriptions?$filter=quantity eq 5
subscriptionAmount	numeric	/api/subscriptions?$filter=subscriptionAmount eq 5
createdAt	date	/api/subscriptions?$filter=createdAt eq dateTime’2021-01-01′
updatedAt	date	/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

Name	Type	Example
id	Guid	/api/futureActions?$filter=Id eq ‘6650B4D9-2892-4732-9F2F-5349A12299C9’
subscriptionId	string	/api/futureActions?$filter=subscriptionId eq ‘6650B4D9-2892-4732-9F2F-5349A12299C9’
addonId	string	/api/futureActions?$filter=addonId eq ‘6650B4D9-2892-4732-9F2F-5349A12299C9’
action	string	/api/futureActions?$filter=action eq ‘CancellationOnEnd’
requestDate	date	/api/futureActions?$filter=requestDate eq dateTime’2021-01-01′
effectiveDate	date	/api/futureActions?$filter=effectiveDate eq dateTime’2021-01-01′
createdAt	date	/api/futureActions?$filter=createdAt eq dateTime’2021-01-01′
updatedAt	date	/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

Property	Type	Example
id	int	/api/organization/countries?$filter=id eq 123
name	string	/api/organization/countries?$filter=name eq ‘Greece’
code	string	/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

Property	Type	Example
id	Guid	/api/organization/languages?$filter=id eq ‘117991E7-8610-45AE-80F4-00009D0248C7’
code	string	/api/organization/languages?$filter=code eq ‘English’
isDefault	boolean	/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

Property	Type	Example
id	Guid	/api/organization/currencies?$filter=id eq ‘117991E7-8610-45AE-80F4-00009D0248C7’
name	string	/api/organization/currencies?$filter=name eq ‘Euro’
mnemonic	string	/api/organization/currencies?$filter=mnemonic eq ‘EUR’
code	string	/api/organization/currencies?$filter=code eq ‘051’
isActive	boolean	/api/organization/currencies?$filter=isActive eq true
isDefault	boolean	/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

Property	Type	Example
id	string	/api/organization/paymentMethods?$filter=id eq ‘8DE31F26-3694-48CF-94DE-9D185AD1FD07’
name	string	/api/organization/paymentMethods?$filter=name eq ‘MyMasterCard’
type	string	/api/organization/paymentMethods?$filter=type eq ‘CreditCard’
isActive	boolean	/api/organization/paymentMethods?$filter=isActive eq true
isDefault	boolean	/api/organization/paymentMethods?$filter=isDefault eq true
isStorefrontUse	boolean	/api/organization/paymentMethods?$filter=isStorefrontUse eq true
gatewayName	string	/api/organization/paymentMethods?$filter=gatewayName eq ‘NationalBank’

Organization/Taxes ($filter)

Property	Type	Example
id	int	/api/organization/taxes?$filter=id eq 10
name	string	/api/organization/taxes?$filter=name eq ‘VAT 23’
displayName	string	/api/organization/taxes?$filter=displayName eq ‘VAT’
isActive	boolean	/api/organization/taxes?$filter=isActive eq true
isExcludedEU	boolean	/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

Property	Type	Example
id	int	/api/organization/taxAuthorities?$filter=id eq 10
name	string	/api/organization/taxAuthorities?$filter=name eq ‘test’
code	string	/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

Property	Type	Example
id	int	/api/organization/accounts/types?$filter=id eq 123
name	string	/api/organization/accounts/types?$filter=name eq ‘Partner’
isDefault	boolean	/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

Property	Type	Example
id	int	/api/organization/invoices/statuses?$filter=id eq 123
name	string	/api/organization/invoices/statuses?$filter=name eq ‘in 2021’
type	string	/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

Property	Type	Example
id	int	/api/organization/invoices/types?$filter=id eq 123
name	string	/api/organization/invoices/types?$filter=name eq ‘Partner Debit’
type	string	/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

Property	Type	Example
id	int	/api/organization/leads/statuses?$filter=id eq 123
name	string	/api/organization/leads/statuses?$filter=name eq ‘Active’
type	string	/api/organization/leads/statuses?$filter=type eq ‘Open’
isActive	boolean	/api/organization/leads/statuses?$filter=isActivet eq true
isDefault	boolean	/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

Property	Type	Example
id	int	/api/organization/leads/sources?$filter=id eq 123
name	string	/api/organization/leads/sources?$filter=name eq ‘Marketing’
isActive	boolean	/api/organization/leads/sources?$filter=isActivet eq true
isDefault	boolean	/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

Property	Type	Example
id	int	/api/organization/leads/ratings?$filter=id eq 123
name	string	/api/organization/leads/ratings?$filter=name eq ‘Five Star’
isDefault	boolean	/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

Property	Type	Example
id	int	/api/organization/titles?$filter=id eq 123
name	string	/api/organization/titles?$filter=name eq ‘Mister’
mnemonic	string	/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

Property	Type	Example
id	Guid	/api/organization/productTypes?$filter=id eq ‘117991E7-8610-45AE-80F4-00009D0248C7’
name	string	/api/organization/productTypes?$filter=name eq ‘Office 365’
basicTypeName	string	/api/organization/productTypes?$filter=basicTypeName eq ‘Microsoft Office’
vendor	string	/api/organization/productTypes?$filter=vendor eq ‘Microsoft’
assetType	string	/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

Property	Type	Example
id	int	/api/organization/unitGroups?$filter=id eq 123
name	string	/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

Property	Type	Example
id	int	/api/organization/volumeDiscounts?$filter=id eq 123
name	string	/api/organization/volumeDiscounts?$filter=name eq ‘TenPlus’
isScalable	boolean	/api/organization/volumeDiscounts?$filter=isScalable eq true
isActive	boolean	/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

Property	Type	Example
id	Guid	/api/organization/unitsOfMeasure?$filter=id eq ‘117991E7-8610-45AE-80F4-00009D0248C7’
name	string	/api/organization/unitsOfMeasure?$filter=name eq ‘Instance’
isActive	boolean	/api/organization/unitsOfMeasure?$filter=isActive eq true
isDefault	boolean	/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

Property	Type	Example
id	Guid	/api/organization/priceGroups?$filter=id eq ‘117991E7-8610-45AE-80F4-00009D0248C7’
name	string	/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

Property	Type	Example
id	int	/api/organization/products/industries?$filter=id eq 123
name	string	/api/organization/products/industries?$filter=name eq ‘Information Technologies’
isActive	boolean	/api/organization/products/industries?$filter=isActive eq true
isDefault	boolean	/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

Property	Type	Example
id	int	/api/organization/industries?$filter=id eq 123
name	string	/api/organization/industries?$filter=name eq ‘Health-Care’
isDefault	boolean	/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

Property	Type	Example
id	int	/api/organization/{module}/customfields?$filter=id eq 123
name	string	/api/organization/{module}/customfields?$filter=name eq ‘Package Number’
groupId	numeric	/api/organization/{module}/customfields?$filter=groupId eq 5
groupName	string	/api/organization/{module}/customfields?$filter=groupName eq ‘test’
type	string	/api/organization/{module}/customfields?$filter=type eq ‘SimpleValue’
isCompulsory	boolean	/api/organization/{module}/customfields?$filter=isCompulsory eq true
isReadOnly	boolean	/api/organization/{module}/customfields?$filter=isReadyOnly eq true

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

Property	Type	Example
name	string	/api/system/countries?$filter=name eq ‘Greece’
code	string	/api/system/countries?$filter=code eq ‘GR’