Glossary

This documentation uses each of these words with one meaning only. When a page uses one, it means exactly what is written here.

Terms

• company: the business whose data you read and write. An API key belongs to one company.

• API key: the secret that identifies your system and its company in every request. See Create your first key.

• scope: one thing a key may do, such as products:read. See Scopes.

• resource: a kind of record the API serves, such as products or orders.

• operation: one method and path, such as GET /v1/products.

• reference: an object in a request body that names another record, by id, by external_id and source, or by sku. See References and external ids.

• external id: the id of a record in your own system, stored in BIRP next to the record.

• source: the name of the system an external id comes from, such as woocommerce.

• idempotency key: the value of the Idempotency-Key header, unique to one request, so a retry is never applied twice. See Idempotency.

• request id: the id of one request, in the X-Request-Id header and in every error body. Quote it to support.

• draft: an order or invoice that can still change. A draft invoice has no number yet.

• issued: an invoice that has its number and never changes again.

• cursor: the value that asks a list for its next page. See Pagination and filtering.

• decimal string: an amount, price or quantity written as a string, such as "12.50". See Decimal strings, dates and ids.

• tax code: the tax rule of an invoice line, such as a standard or a zero rate. The codes follow the rules of the company's country. See Create and issue invoices.

Related

• what-the-api-is-for
• references-and-external-ids
• formats