Skip to main content
Records such as customers, products or invoices refer to records defined in Noyax (a district, a currency, a unit, …) by their code or name, not by an ID. For example, an address takes a District, not a district name. You get these IDs from the definition endpoints.

Which value comes from where?

Country and city lists help you find a district: country → city (country) → district (city).

Example: finding a district for an address

1

Find the city

2

Find the district

3

Use it in the address

Put the name of the district into the District field of the address (and its city into City when needed).

Good to know

  • Definitions are company-specific. Lists return the records of the company sent in X-CompanyID. A code or name of one company cannot be used in another company.
  • Permissions: lists under /definitions can be read with any valid API key. Creating, updating or deleting definitions requires the key to have the definition write permission. The same permission applies to customer, product and stock definitions (customer/product parameter definitions, product groups, warehouses and sections); their lists can also be read with any valid key.
  • Cache them. Definitions rarely change. Instead of querying before every record, store them on your side and refresh, for example, once a day. This saves your request limits.

Write rules

VAT rates and customer groups are read-only through the API. Definitions are fully replaced with PUT or partially updated with PATCH.