Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Body

application/json

A formula to check against a dataset.

dataset
string
required

The dataset the formula reads, such as inventory.stock-movements.

Pattern: ^[a-z]+\.[a-z][a-z0-9-]{0,63}$
formula
string | null
required

Such as SUM([Revenue]) - SUM([Cost]), with fields in brackets by key or name.

Maximum string length: 2000

Response

FormulaCheckResource

data
FormulaCheckResource · object
required