Updated: 2026-09-22

Parameters

Certain parameters have to be supplied in the URL path, as a JSON query, or as URL parameters.

path

URL path parameters

Example

In this example {invoiceId} in the path would be replaced by the value of the invoiceID:

GET /invoices/{invoiceId}

query

URI encoded URLSearchParams

query operators

Some endpoints like /documents has URLSearchParams where you need to supply an operator.

E.g. query with [eq], equal to, operator:

order[eq]=00000000-0000-0000-0000-000000000000 type[eq]=OrderSalesOrder

https://app.tracezilla.com/api/v1/example-company/documents?order%5Beq%5D=00000000-0000-0000-0000-000000000000&type%5Beq%5D=OrderSalesOrder

list of query operators

  • eq=equal to
  • ne=not equal to
  • gt=greater than
  • lt=less than
  • lte=less than or equal to
  • gte=greater than or equal to
  • in=in array or comma seperated list
  • nin=not in array or comma seperated list
  • nem=not empty
  • nct=does not contain
  • ct=contains
  • expr=expression where * as treated as wildcards - case insensitive
  • bw=begins with
  • ew=ends with
  • eqi=equal to - not case sensitive
  • em=empty

Request body JSON

Some endpoints will show a request body JSON schema that specifies the format for JSON in your request body.

For example, PUT /invoices/{invoiceId} requires JSON data in the body.

Table of contents