Querying

Basics and examples of querying in Codat's APIs

The Codat API uses a simple, flexible query language to allow you to filter response data.

Use URL encoding

Include a URL encoded query parameter with your request to filter data returned from the API.

The below query functionality will only work when searching for company data (e.g. invoices, customers, etc), they will not work on settings or metadata endpoints such as listing integrations, companies or data connections.

Query format

• The query takes the form of propertyName=value.
• You can also include comparison operators, such as greater than, less than or equal to. The following table shows comparison operators that are supported for numeric, date, and string data types.

Operator	Name	Number	String	Date
=	Equals	✔	✔	✔
!=	Not equals	✔	✔	✔
~	Contains	❌	✔	❌
>	Greater than	✔	❌	✔
<	Less than	✔	❌	✔
>=	Greater than or equal to	✔	❌	✔
<=	Less than or equal to	✔	❌	✔

• Separate multiple query clauses with ampersands (&&) for AND queries or pipes (||) for OR queries.
• Access sub-properties by separating them from the property with a dot (see Invoices to a particular customer example below). This is only applicable to objects within our data endpoints. We do not support querying inside arrays.

Combining queries

To combine AND and OR queries, use curly braces ({ and }). For example:

query={totalAmount > 100 || totalAmount < 50} && status != paid

Query length limits

The total length of your query should be under 2048 characters in order to be valid. If your query is longer, the API will return an error message.

Querying on null fields

We do not currently support querying on null fields.

Getting all vs one item

Our GET /{dataType} endpoints typically return an array of items of that given data type. If you want to retrieve just a single data type by an ID, you can use a query. For example:

query=id%253D81be41e9-5c2c-4064-829c-bca43b5e6f59.

Example queries

Note: some characters are url-encoded:

• < = %3c
• > = %3e

Invoices with amounts outstanding

Query: amountDue > 0

HTTP

GET /companies/{companyId}/data/invoices?query=amountDue%3e0

Javascript

import {InvoicesQuery} from 'codat-queries';
import { api as codat } from 'codat';

var query = new InvoicesQuery(companyId, 'amountDue>0')
.run(codat.uat(apiKey));

C#

var request = new RestRequest("companies/{companyId}/data/invoices", Method.GET);
request.AddUrlSegment("companyId", companyId);
request.AddUrlSegment("query", "amountDue>0");
request.AddHeader("Authorization", $"Basic {encodedApiKey}");
var response = client.Execute(request);
var info = response.Data;

Invoices in GBP

Query: currency = GBP

HTTP

GET /companies/{companyId}/data/invoices?query=currency%3dGBP

Javascript

import {InvoicesQuery} from 'codat-queries';
import { api as codat } from 'codat';

var query = new InvoicesQuery(companyId, 'currency=GBP')
.run(codat.uat(apiKey));

C#

var request = new RestRequest("companies/{companyId}/data/invoices", Method.GET);
request.AddUrlSegment("companyId", companyId);
request.AddUrlSegment("query", "currency=GBP");
request.AddHeader("Authorization", $"Basic {encodedApiKey}");
var response = client.Execute(request);
var info = response.Data;

Invoices for a specific customer

Query: customerRef.id = 61

HTTP

GET /companies/{companyId}/data/invoices?query=customerRef.id%3d61

Javascript

import {InvoicesQuery} from 'codat-queries';
import { api as codat } from 'codat';

var query = new InvoicesQuery(companyId, 'customerRef.id=61')
.run(codat.uat(apiKey));

C#

var request = new RestRequest("companies/{companyId}/data/invoices", Method.GET);
request.AddUrlSegment("companyId", companyId);
request.AddUrlSegment("query", "customerRef.id=61");
request.AddHeader("Authorization", $"Basic {encodedApiKey}");
var response = client.Execute(request);
var info = response.Data;

Outstanding Invoices worth less than 1000

Query: amountDue > 0 && totalAmount < 1000

HTTP

GET /companies/{companyId}/data/invoices?query=amountDue%3e0%26%26totalAmount%3c1000

Javascript

import {InvoicesQuery} from 'codat-queries';
import { api as codat } from 'codat';

var query = new InvoicesQuery(companyId, 'amountDue>0&&totalAmount<1000')
.run(codat.uat(apiKey));

C#

var request = new RestRequest("companies/{companyId}/data/invoices", Method.GET);
request.AddUrlSegment("companyId", companyId);
request.AddUrlSegment("query", "amountDue>0&&totalAmount<1000");
request.AddHeader("Authorization", $"Basic {encodedApiKey}");
var response = client.Execute(request);
var info = response.Data;

Invoices that are due after a certain date

e.g. "2021-01-28" (YYYY-MM-DD format)

Query: dueDate > 2021-01-28

HTTP

GET /companies/{companyId}/data/invoices?query=dueDate%3E2021-01-28

Javascript

import {InvoicesQuery} from 'codat-queries';
import { api as codat } from 'codat';

var query = new InvoicesQuery(companyId,'dueDate>2021-01-28')
.run(codat.uat(apiKey));

C#

var request = new RestRequest("companies/{companyId}/data/invoices", Method.GET);
request.AddUrlSegment("companyId", companyId);
request.AddUrlSegment("query", "dueDate>2021-01-28");
request.AddHeader("Authorization", $"Basic {encodedApiKey}");
var response = client.Execute(request);
var info = response.Data;

Companies with "Pending" status connections

Query: dataConnections.status=PendingAuth

Note: the page size value is obligatory for querying.

HTTP

GET /companies?page=1&pageSize=100&query=dataConnections.status=PendingAuth

C#

var request = new RestRequest("companies", Method.GET);
request.AddUrlSegment("page", 1);
request.AddUrlSegment("query", "dataConnections.status=PendingAuth");
request.AddHeader("Authorization", $"Basic {encodedApiKey}");
var response = client.Execute(request);
var info = response.Data;

For companies with no connections

Query: dataConnections.count = 0

Note: The page size value is obligatory for querying.

HTTP

GET /companies?page=1&pageSize=100&query=dataConnections.count=0

C#

var request = new RestRequest("companies", Method.GET);
request.AddUrlSegment("page", 1);
request.AddUrlSegment("query", "dataConnections.count=0");
request.AddHeader("Authorization", $"Basic {encodedApiKey}");
var response = client.Execute(request);
var info = response.Data;

Queries that won't work

Although you can query properties of objects, you can't query arrays.

✅ Objects: Invoices > customerRef.id

GET /invoices?page=1&pageSize=100&query=customerRef.id%3Def6f54c1-eb45-4956-b8cd-1be82ad665f2

❌ Arrays: Invoices > lineItems

GET /invoices?page=1&pageSize=100&query=lineItems.unitAmount%3D700