# Numbero Public API - **OpenAPI Version:** `3.1.0` - **API Version:** `1.0.0` Integrate a Numbero company account with e-commerce platforms, warehouse systems, and other business applications. The API uses JSON over HTTPS. Company data endpoints require a company API key with the permission stated by the operation. Send the key as a Bearer token in the Authorization header. Public API requests do not require a CSRF token. Authenticated Public API access is available during an active trial period. After the trial ends, it requires an Unlimited or Unlimited Plus subscription. Unlimited includes up to 1,000 authenticated Public API requests per subscription usage period, shared across all authenticated endpoints. Unlimited Plus provides unlimited Public API requests. The unauthenticated status endpoint does not consume the allowance and remains available independently of the company's subscription. Create and manage API keys in the Numbero company settings. The full key is displayed only once. A key can have a maximum lifetime of 365 days and can optionally be restricted to as many as 20 allowlist entries. Each entry may be an exact IPv4 or IPv6 address, such as 203.0.113.42 or 2001:db8::42, or a CIDR range, such as 203.0.113.0/24 or 2001:db8::/48. IPv4 prefix lengths must be between 0 and 32, and IPv6 prefix lengths between 0 and 128. Wildcards, host names, URLs, and addresses containing ports are not accepted. An empty IP allowlist permits requests from any address. Store API keys only on a server or in a secure secrets manager. Grant each integration only the permissions it requires. ## Servers - **URL:** `https://api.numbero.app/api/v1` - **Description:** Production ## Operations ### Check API status - **Method:** `GET` - **Path:** `/status` - **Tags:** Status Checks whether the Numbero Public API is reachable. This endpoint does not validate an API key or confirm access to company data. #### Responses ##### Status: 200 The API is available. ###### Content-Type: application/json - **`status` (required)** `string` **Example:** ```json { "status": "ok" } ``` ##### Status: 429 The request rate limit has been exceeded. Authenticated endpoints allow 120 requests per minute per API key, email delivery additionally allows 30 requests per minute per API key, authentication allows 300 attempts per minute per IP, and status allows 60 requests per minute per IP. ###### Content-Type: application/json - **`error` (required)** `string` - **`retry_after` (required)** `integer | string` — Seconds to wait before retrying. - **`status` (required)** `integer` **Example:** ```json { "status": 429, "error": "Too many requests.", "retry_after": 1 } ``` ### Fetch company profile - **Method:** `GET` - **Path:** `/company` - **Tags:** Company Returns the profile and bank accounts of the company associated with the API key. This operation is read-only. #### Responses ##### Status: 200 The company profile. ###### Content-Type: application/json - **`address` (required)** `string | null` - **`bank_accounts` (required)** `array` **Items:** - **`bank_name` (required)** `string | null` - **`iban` (required)** `string` - **`swift_code` (required)** `string | null` - **`currency_code` (required)** `string` - **`email` (required)** `string | null`, format: `email` - **`name` (required)** `string` - **`phone_number` (required)** `string | null` - **`phone_prefix` (required)** `string | null` - **`registration_number` (required)** `string | null` - **`vat_registration_number` (required)** `string | null` **Example:** ```json { "name": "", "registration_number": null, "vat_registration_number": null, "address": null, "email": null, "phone_prefix": null, "phone_number": null, "currency_code": "", "bank_accounts": [ { "bank_name": null, "swift_code": null, "iban": "" } ] } ``` ##### Status: 401 The API key is missing, invalid, deleted, or otherwise cannot be resolved. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 402 The company has neither an active trial nor Public API access in its current plan, the Unlimited Public API allowance has been exhausted, or another subscription feature limit has been reached. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 403 The key is suspended, expired, blocked by its IP allowlist, or lacks the required permission. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 429 The request rate limit has been exceeded. Authenticated endpoints allow 120 requests per minute per API key, email delivery additionally allows 30 requests per minute per API key, authentication allows 300 attempts per minute per IP, and status allows 60 requests per minute per IP. ###### Content-Type: application/json - **`error` (required)** `string` - **`retry_after` (required)** `integer | string` — Seconds to wait before retrying. - **`status` (required)** `integer` **Example:** ```json { "status": 429, "error": "Too many requests.", "retry_after": 1 } ``` ### Export document XML - **Method:** `GET` - **Path:** `/bookkeeping-records/{uuid}/ubl` - **Tags:** Bookkeeping records Returns UBL XML generated by Numbero's existing document exporter. All document types and statuses are supported, including drafts and canceled documents. No additional completeness validation is performed. #### Parameters ##### `App-Locale` - **In:** `header` Preferred language for validation messages. Use a two-letter system locale supported by Numbero. If omitted or unsupported, Numbero uses the fallback locale. `string` ##### `uuid` required - **In:** `path` Resource UUID. `string`, format: `uuid` #### Responses ##### Status: 200 The generated document XML. ###### Content-Type: application/xml `string` **Example:** ```xml ``` ##### Status: 401 The API key is missing, invalid, deleted, or otherwise cannot be resolved. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 402 The company has neither an active trial nor Public API access in its current plan, the Unlimited Public API allowance has been exhausted, or another subscription feature limit has been reached. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 403 The key is suspended, expired, blocked by its IP allowlist, or lacks the required permission. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 404 The document does not exist in the API key's company, is a template, or has been deleted. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 429 The request rate limit has been exceeded. Authenticated endpoints allow 120 requests per minute per API key, email delivery additionally allows 30 requests per minute per API key, authentication allows 300 attempts per minute per IP, and status allows 60 requests per minute per IP. ###### Content-Type: application/json - **`error` (required)** `string` - **`retry_after` (required)** `integer | string` — Seconds to wait before retrying. - **`status` (required)** `integer` **Example:** ```json { "status": 429, "error": "Too many requests.", "retry_after": 1 } ``` ### List bookkeeping records - **Method:** `GET` - **Path:** `/bookkeeping-records` - **Tags:** Bookkeeping records Returns a filtered, sorted, page-based list of documents belonging to the company associated with the API key. Templates and deleted documents are always excluded. When no sort parameters are supplied, results are ordered by most recent update. Requires an active trial, Unlimited, or Unlimited Plus subscription. Unlimited is subject to the shared 1,000-request Public API allowance. #### Parameters ##### `App-Locale` - **In:** `header` Preferred language for validation messages. Use a two-letter system locale supported by Numbero. If omitted or unsupported, Numbero uses the fallback locale. `string` ##### `page` - **In:** `query` Requested page number. `integer`, default: `1` ##### `per_page` - **In:** `query` Number of records per page. `integer`, default: `25` ##### `search` - **In:** `query` Searches document type, number, date, status, notes, line item names, and stored sender, recipient, payer, or carrier details. Record-number searches also ignore common separators. `[ "string", "null" ]` ##### `types[]` - **In:** `query` - **Style:** `form` - **Explode:** `true` Filter by one or more document types. Repeat the bracketed query key for every value. **Array of:** `string`, possible values: `"offer", "invoice", "waybill", "credit_note", "advance_invoice"` - Max items: `5` - Unique items: `true` ##### `statuses[]` - **In:** `query` - **Style:** `form` - **Explode:** `true` Filter by one or more document statuses. Repeat the bracketed query key for every value. **Array of:** `string`, possible values: `"draft", "sent", "partially_paid", "paid", "overdue", "overpaid", "unpaid", "canceled"` - Max items: `8` - Unique items: `true` ##### `date_from` - **In:** `query` Inclusive lower boundary for the document date. `string`, format: `date` ##### `date_to` - **In:** `query` Inclusive upper boundary for the document date. It cannot be earlier than date\_from. `string`, format: `date` ##### `label` - **In:** `query` Filter by an exact document label. `[ "string", "null" ]` ##### `sort_field` - **In:** `query` Field used to order the result. paid\_at uses the latest payment date, including partial payments; documents without payments come last in both directions. If only sort\_direction is supplied, the API sorts by date. `string`, possible values: `"date", "paid_at", "status", "recipient", "record_number", "total_with_vat"` ##### `sort_direction` - **In:** `query` Sort direction. `string`, possible values: `"asc", "desc"`, default: `"desc"` #### Responses ##### Status: 200 A page of bookkeeping records. ###### Content-Type: application/json - **`data` (required)** `array` **Items:** - **`created_at` (required)** `string | null`, format: `date-time` - **`currency_code` (required)** `string` - **`date` (required)** `string | null`, format: `date` - **`due_date` (required)** `string | null`, format: `date` - **`recipient` (required)** `object` - **`name` (required)** `string | null` - **`registration_number` (required)** `string | null` - **`record_number` (required)** `string | null` - **`status` (required)** `object` - **`total_with_vat` (required)** `number` - **`total_without_vat` (required)** `number` - **`type` (required)** `string`, possible values: `"offer", "invoice", "waybill", "credit_note", "advance_invoice"` - **`updated_at` (required)** `string | null`, format: `date-time` - **`uuid` (required)** `string`, format: `uuid` - **`links` (required)** `object` - **`first` (required)** `string`, format: `uri` - **`last` (required)** `string`, format: `uri` - **`next` (required)** `string | null`, format: `uri` - **`prev` (required)** `string | null`, format: `uri` - **`meta` (required)** `object` - **`current_page` (required)** `integer` - **`from` (required)** `integer | null` - **`last_page` (required)** `integer` - **`path` (required)** `string`, format: `uri` - **`per_page` (required)** `integer` - **`to` (required)** `integer | null` - **`total` (required)** `integer` **Example:** ```json { "data": [ { "uuid": "", "type": null, "status": null, "record_number": null, "date": null, "due_date": null, "currency_code": "EUR", "total_without_vat": 1, "total_with_vat": 1, "recipient": null, "created_at": null, "updated_at": null } ], "links": { "first": "", "last": "", "prev": null, "next": null }, "meta": { "current_page": 1, "from": null, "last_page": 1, "path": "", "per_page": 1, "to": null, "total": 0 } } ``` ##### Status: 401 The API key is missing, invalid, deleted, or otherwise cannot be resolved. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 402 The company has neither an active trial nor Public API access in its current plan, the Unlimited Public API allowance has been exhausted, or another subscription feature limit has been reached. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 403 The key is suspended, expired, blocked by its IP allowlist, or lacks the required permission. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 422 One or more request values are invalid. Error keys identify the invalid request fields. Human-readable messages can be localized and must not be used as stable machine-readable identifiers. ###### Content-Type: application/json - **`errors` (required)** `object` - **`message` (required)** `string` **Example:** ```json { "message": "", "errors": { "additionalProperty": [ "" ] } } ``` ##### Status: 429 The request rate limit has been exceeded. Authenticated endpoints allow 120 requests per minute per API key, email delivery additionally allows 30 requests per minute per API key, authentication allows 300 attempts per minute per IP, and status allows 60 requests per minute per IP. ###### Content-Type: application/json - **`error` (required)** `string` - **`retry_after` (required)** `integer | string` — Seconds to wait before retrying. - **`status` (required)** `integer` **Example:** ```json { "status": 429, "error": "Too many requests.", "retry_after": 1 } ``` ### Create a bookkeeping record - **Method:** `POST` - **Path:** `/bookkeeping-records` - **Tags:** Bookkeeping records Creates a non-template income document for the company associated with the API key. Numbero assigns the document owner, number, draft status, sender snapshot, and calculated totals. Requires an active trial, Unlimited, or Unlimited Plus subscription. Unlimited is subject to the shared 1,000-request Public API allowance. Document creation counts against the company's document feature allowance. #### Parameters ##### `App-Locale` - **In:** `header` Preferred language for validation messages. Use a two-letter system locale supported by Numbero. If omitted or unsupported, Numbero uses the fallback locale. `string` #### Request Body ##### Content-Type: application/json - **`currency_code` (required)** `string` — A currency code supported by Numbero. Input is normalized to uppercase. - **`date` (required)** `string`, format: `date` — Document date in YYYY-MM-DD format. - **`items` (required)** `array` **Items:** **Any of:** **Not:** **Any of:** - **`uuid`** `null` - **`lang` (required)** `string` — A two-letter document language supported by Numbero. - **`recipient` (required)** `object` — Provide an existing company partner UUID to fill recipient fields, preferences, and payment methods. With a non-null UUID, name, country, and vat\_registration\_number must be omitted: they are copied from the saved partner. Supplying these fields returns 422, even if unchanged, null, or empty. Other permitted fields override only the document snapshot. The saved partner is not updated. Omit UUID or send null to enter the recipient manually. **Any of:** **Not:** **Any of:** - **`uuid`** `null` - **`tax_by_group` (required)** `boolean` — Whether VAT and totals are rounded by VAT-rate group. - **`type` (required)** `string`, possible values: `"offer", "invoice", "waybill", "credit_note", "advance_invoice"` - **`additional_price_rows`** `array` — Positive previously-paid rows deducted from the total. **Items:** - **`amount` (required)** `number` - **`description` (required)** `string` - **`carrier`** `object` — Allowed only for waybills. When supplied, is\_legal, country, and name are required. - **`country` (required)** `string` - **`is_legal` (required)** `boolean` - **`name` (required)** `string` - **`driver`** `string | null` - **`issuing_address`** `string | null` - **`receipt_address`** `string | null` - **`registration_number`** `string | null` — Required when the carrier is a legal entity. - **`vehicle_model`** `string | null` - **`vehicle_plate`** `string | null` - **`currency_rate`** `number | null` — Required when currency\_code differs from the company's base currency. Numbero uses 1 for the base currency. At most five decimal places. - **`deal_type`** `object` — Not allowed for offers. - **`deal_type_custom`** `string | null` — Required only when deal\_type is other; prohibited otherwise. - **`due_date`** `string | null`, format: `date` — Cannot be earlier than date. - **`label`** `string | null` - **`late_fee_percent`** `number | null` - **`notes`** `string | null` - **`payment_type`** `object` — Not allowed for offers. - **`payment_type_custom`** `string | null` — Required only when payment\_type is other; prohibited otherwise. - **`prepaid_amount`** `number | null` — Allowed only for advance invoices. **Example:** ```json { "label": null, "lang": "en", "type": "offer", "currency_code": "EUR", "currency_rate": null, "tax_by_group": true, "date": "", "due_date": null, "late_fee_percent": null, "notes": null, "payment_type": "cash", "payment_type_custom": null, "deal_type": "goods", "deal_type_custom": null, "prepaid_amount": null, "recipient": { "uuid": "", "name": "", "country": "lv", "is_legal": true, "registration_number": null, "vat_registration_number": null, "email": null, "address": null, "phone_prefix": null, "phone_number": null, "notes": null, "internal_notes": null, "save_as_partner": true, "payment_methods": [] }, "carrier": { "is_legal": true, "country": "", "name": "", "registration_number": null, "driver": null, "vehicle_model": null, "vehicle_plate": null, "issuing_address": null, "receipt_address": null }, "items": [ { "uuid": "" } ], "additional_price_rows": [ { "description": "", "amount": 0.01 } ] } ``` #### Responses ##### Status: 201 The bookkeeping record was created. ###### Content-Type: application/json - **`additional_price_rows` (required)** `array` **Items:** - **`amount` (required)** `number` - **`description` (required)** `string` - **`carrier` (required)** `object` - **`category` (required)** `string` - **`color` (required)** `string | null` - **`created_at` (required)** `string | null`, format: `date-time` - **`currency_code` (required)** `string` - **`currency_rate` (required)** `number` - **`date` (required)** `string | null`, format: `date` - **`deal_type` (required)** `object` - **`deal_type_custom` (required)** `string | null` - **`due_date` (required)** `string | null`, format: `date` - **`has_discount` (required)** `boolean` - **`has_multi_discount` (required)** `boolean` - **`has_multi_vat` (required)** `boolean` - **`hide_currency_rate` (required)** `boolean` - **`is_final` (required)** `boolean` - **`is_template` (required)** `boolean` - **`items` (required)** `array` **Items:** - **`description` (required)** `string | null` - **`discount` (required)** `number | null` - **`measurement` (required)** `string` - **`name` (required)** `string` - **`price` (required)** `number` - **`quantity` (required)** `number` - **`sequence_no` (required)** `integer` - **`sku` (required)** `string | null` - **`total_with_vat` (required)** `number` - **`total_with_vat_local` (required)** `number` - **`total_without_vat` (required)** `number` - **`total_without_vat_local` (required)** `number` - **`uuid` (required)** `string`, format: `uuid` - **`vat_amount` (required)** `number` - **`vat_amount_local` (required)** `number` - **`vat_percent` (required)** `number | null` - **`vat_reference_uuid` (required)** `string | null`, format: `uuid` - **`label` (required)** `string | null` - **`lang` (required)** `string | null` - **`late_fee_percent` (required)** `number | null` - **`notes` (required)** `string | null` - **`number_format` (required)** `string | null` - **`number_iterator` (required)** `integer | null` - **`payment_type` (required)** `object` - **`payment_type_custom` (required)** `string | null` - **`prepaid_amount` (required)** `number | null` - **`recipient` (required)** `object` - **`record_number` (required)** `string | null` - **`sender` (required)** `object` - **`address`** `string | null` - **`country`** `string | null` - **`email`** `string | null` - **`name`** `string | null` - **`notes`** `string | null` - **`payment_methods`** `array` **Items:** - **`account_number`** `string | null` - **`bank_name`** `string | null` - **`name`** `string | null` - **`swift_code`** `string | null` - **`type`** `string` - **`phone_number`** `string | null` - **`phone_prefix`** `string | null` - **`registration_number`** `string | null` - **`vat_registration_number`** `string | null` - **`website`** `string | null` - **`signature` (required)** `object | null` - **`status` (required)** `object` - **`tax_by_group` (required)** `boolean` - **`total_with_vat` (required)** `number` - **`total_with_vat_local` (required)** `number` - **`total_without_vat` (required)** `number` - **`total_without_vat_local` (required)** `number` - **`type` (required)** `string`, possible values: `"offer", "invoice", "waybill", "credit_note", "advance_invoice"` - **`updated_at` (required)** `string | null`, format: `date-time` - **`uuid` (required)** `string`, format: `uuid` - **`vat_amount` (required)** `number` - **`vat_amount_local` (required)** `number` **Example:** ```json { "uuid": "", "category": "income", "type": "offer", "status": "draft", "label": null, "is_template": false, "is_final": true, "lang": null, "number_format": null, "number_iterator": null, "record_number": null, "date": null, "due_date": null, "currency_code": "", "currency_rate": 1, "hide_currency_rate": true, "tax_by_group": true, "has_discount": true, "has_multi_discount": true, "has_multi_vat": true, "late_fee_percent": null, "payment_type": "cash", "payment_type_custom": null, "deal_type": "goods", "deal_type_custom": null, "notes": null, "color": null, "sender": { "name": null, "registration_number": null, "vat_registration_number": null, "email": null, "address": null, "country": null, "website": null, "phone_prefix": null, "phone_number": null, "notes": null, "payment_methods": [], "additionalProperty": "anything" }, "recipient": { "uuid": "", "is_legal": true, "internal_notes": null, "preferences": { "additionalProperty": "anything" } }, "carrier": { "name": null, "registration_number": null, "driver": null, "vehicle_model": null, "vehicle_plate": null, "issuing_address": null, "receipt_address": null, "additionalProperty": "anything" }, "signature": null, "items": [ { "uuid": "", "sequence_no": 0, "sku": null, "name": "", "description": null, "measurement": "", "quantity": 1, "discount": null, "vat_percent": null, "price": 1, "vat_reference_uuid": null, "vat_amount": 1, "total_without_vat": 1, "total_with_vat": 1, "vat_amount_local": 1, "total_without_vat_local": 1, "total_with_vat_local": 1 } ], "additional_price_rows": [ { "description": "", "amount": 0.01 } ], "prepaid_amount": null, "vat_amount": 1, "total_without_vat": 1, "total_with_vat": 1, "vat_amount_local": 1, "total_without_vat_local": 1, "total_with_vat_local": 1, "created_at": null, "updated_at": null } ``` ##### Status: 401 The API key is missing, invalid, deleted, or otherwise cannot be resolved. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 402 The company has neither an active trial nor Public API access in its current plan, the Unlimited Public API allowance has been exhausted, or another subscription feature limit has been reached. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 403 The key is suspended, expired, blocked by its IP allowlist, or lacks the required permission. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 422 One or more request values are invalid. Error keys identify the invalid request fields. Human-readable messages can be localized and must not be used as stable machine-readable identifiers. ###### Content-Type: application/json - **`errors` (required)** `object` - **`message` (required)** `string` **Example:** ```json { "message": "", "errors": { "additionalProperty": [ "" ] } } ``` ##### Status: 429 The request rate limit has been exceeded. Authenticated endpoints allow 120 requests per minute per API key, email delivery additionally allows 30 requests per minute per API key, authentication allows 300 attempts per minute per IP, and status allows 60 requests per minute per IP. ###### Content-Type: application/json - **`error` (required)** `string` - **`retry_after` (required)** `integer | string` — Seconds to wait before retrying. - **`status` (required)** `integer` **Example:** ```json { "status": 429, "error": "Too many requests.", "retry_after": 1 } ``` ### Send a bookkeeping record by email - **Method:** `POST` - **Path:** `/bookkeeping-records/{uuid}/send` - **Tags:** Bookkeeping records Queues an email containing the document PDF and UBL XML attachment. The document must belong to the API key's company and must not be a template or deleted. Requires an active trial, Unlimited, or Unlimited Plus subscription. Unlimited is subject to the shared 1,000-request Public API allowance. A successful response confirms that the delivery job was queued, not that the destination mail server accepted the email. #### Parameters ##### `App-Locale` - **In:** `header` Preferred language for validation messages. Use a two-letter system locale supported by Numbero. If omitted or unsupported, Numbero uses the fallback locale. `string` ##### `uuid` required - **In:** `path` Bookkeeping record UUID. `string`, format: `uuid` #### Request Body ##### Content-Type: application/json - **`email` (required)** `string`, format: `email` — Primary recipient. Input is trimmed and normalized to lowercase. - **`bcc`** `array | null` — Up to five unique blind-copy addresses. The primary email address cannot also appear in this array. Stored company BCC defaults are not added automatically. - **`message`** `string | null` — When omitted or null, the company default for the document type is used. Document variables are replaced before the email is queued. - **`subject`** `string | null` — When omitted or null, the company default for the document type is used. Supported variables: {NUMBER}, {ISSUED\_AT}, {DUE\_AT}, {LATE\_FEE\_RATE}, {CLIENT\_NAME}, {TOTAL\_AMOUNT}, and {DOCUMENT\_TYPE}. Legacy equivalents prefixed with @ are also supported. **Example:** ```json { "email": "", "bcc": [ "" ], "subject": null, "message": null } ``` #### Responses ##### Status: 202 The email delivery job was queued. ###### Content-Type: application/json - **`status` (required)** `string` - **`uuid` (required)** `string`, format: `uuid` **Example:** ```json { "status": "queued", "uuid": "" } ``` ##### Status: 401 The API key is missing, invalid, deleted, or otherwise cannot be resolved. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 402 The company has neither an active trial nor Public API access in its current plan, the Unlimited Public API allowance has been exhausted, or another subscription feature limit has been reached. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 403 The key is suspended, expired, blocked by its IP allowlist, or lacks the required permission. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 404 The document does not exist in the API key's company, is a template, or has been deleted. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 422 One or more request values are invalid. Error keys identify the invalid request fields. Human-readable messages can be localized and must not be used as stable machine-readable identifiers. ###### Content-Type: application/json - **`errors` (required)** `object` - **`message` (required)** `string` **Example:** ```json { "message": "", "errors": { "additionalProperty": [ "" ] } } ``` ##### Status: 429 The request rate limit has been exceeded. Authenticated endpoints allow 120 requests per minute per API key, email delivery additionally allows 30 requests per minute per API key, authentication allows 300 attempts per minute per IP, and status allows 60 requests per minute per IP. ###### Content-Type: application/json - **`error` (required)** `string` - **`retry_after` (required)** `integer | string` — Seconds to wait before retrying. - **`status` (required)** `integer` **Example:** ```json { "status": 429, "error": "Too many requests.", "retry_after": 1 } ``` ### List partners - **Method:** `GET` - **Path:** `/partners` - **Tags:** Partners Returns a searchable, sorted, page-based list of non-deleted partners belonging to the API key's company. #### Parameters ##### `App-Locale` - **In:** `header` Preferred language for validation messages. Use a two-letter system locale supported by Numbero. If omitted or unsupported, Numbero uses the fallback locale. `string` ##### `page` - **In:** `query` Requested page number. `integer`, default: `1` ##### `per_page` - **In:** `query` Number of partners per page. `integer`, default: `25` ##### `search` - **In:** `query` Searches name, registration number, VAT registration number, email, and phone number. `[ "string", "null" ]` ##### `sort_field` - **In:** `query` Field used to order the result. `string`, possible values: `"name", "email", "phone_number"`, default: `"name"` ##### `sort_direction` - **In:** `query` Sort direction. `string`, possible values: `"asc", "desc"`, default: `"asc"` #### Responses ##### Status: 200 A page of partners. ###### Content-Type: application/json - **`data` (required)** `array` **Items:** - **`address` (required)** `string | null` - **`country` (required)** `string | null` - **`created_at` (required)** `string | null`, format: `date-time` - **`email` (required)** `string | null`, format: `email` - **`internal_notes` (required)** `string | null` - **`is_legal` (required)** `boolean` - **`name` (required)** `string` - **`notes` (required)** `string | null` - **`payment_methods` (required)** `array` **Items:** **All of:** - **`account_number` (required)** `string` - **`type` (required)** `string`, possible values: `"bank_account", "paypal", "skrill", "other"` - **`bank_name`** `string | null` — Required when \`type\` is \`bank\_account\`. - **`is_primary`** `boolean`, default: `false` - **`name`** `string | null` — Required when \`type\` is \`other\`. - **`swift_code`** `string | null` — Required when \`type\` is \`bank\_account\`. * **`uuid` (required)** `string`, format: `uuid` - **`phone_number` (required)** `string | null` - **`phone_prefix` (required)** `string | null` - **`preferences` (required)** `object` - **`currency_code`** `string | null` - **`default_due_days`** `integer | null` - **`document_lang`** `string | null` - **`late_fee_percent`** `number | null` - **`registration_number` (required)** `string | null` - **`updated_at` (required)** `string | null`, format: `date-time` - **`uuid` (required)** `string`, format: `uuid` - **`vat_registration_number` (required)** `string | null` - **`links` (required)** `object` - **`first` (required)** `string`, format: `uri` - **`last` (required)** `string`, format: `uri` - **`next` (required)** `string | null`, format: `uri` - **`prev` (required)** `string | null`, format: `uri` - **`meta` (required)** `object` - **`current_page` (required)** `integer` - **`from` (required)** `integer | null` - **`last_page` (required)** `integer` - **`path` (required)** `string`, format: `uri` - **`per_page` (required)** `integer` - **`to` (required)** `integer | null` - **`total` (required)** `integer` **Example:** ```json { "data": [ { "uuid": "", "name": "", "is_legal": true, "registration_number": null, "vat_registration_number": null, "address": null, "email": null, "country": null, "phone_prefix": null, "phone_number": null, "notes": null, "internal_notes": null, "preferences": null, "payment_methods": [], "created_at": null, "updated_at": null } ], "links": { "first": "", "last": "", "prev": null, "next": null }, "meta": { "current_page": 1, "from": null, "last_page": 1, "path": "", "per_page": 1, "to": null, "total": 0 } } ``` ##### Status: 401 The API key is missing, invalid, deleted, or otherwise cannot be resolved. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 402 The company has neither an active trial nor Public API access in its current plan, the Unlimited Public API allowance has been exhausted, or another subscription feature limit has been reached. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 403 The key is suspended, expired, blocked by its IP allowlist, or lacks the required permission. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 422 One or more request values are invalid. Error keys identify the invalid request fields. Human-readable messages can be localized and must not be used as stable machine-readable identifiers. ###### Content-Type: application/json - **`errors` (required)** `object` - **`message` (required)** `string` **Example:** ```json { "message": "", "errors": { "additionalProperty": [ "" ] } } ``` ##### Status: 429 The request rate limit has been exceeded. Authenticated endpoints allow 120 requests per minute per API key, email delivery additionally allows 30 requests per minute per API key, authentication allows 300 attempts per minute per IP, and status allows 60 requests per minute per IP. ###### Content-Type: application/json - **`error` (required)** `string` - **`retry_after` (required)** `integer | string` — Seconds to wait before retrying. - **`status` (required)** `integer` **Example:** ```json { "status": 429, "error": "Too many requests.", "retry_after": 1 } ``` ### Create a partner - **Method:** `POST` - **Path:** `/partners` - **Tags:** Partners Creates a customer or supplier for the API key's company. #### Parameters ##### `App-Locale` - **In:** `header` Preferred language for validation messages. Use a two-letter system locale supported by Numbero. If omitted or unsupported, Numbero uses the fallback locale. `string` #### Request Body ##### Content-Type: application/json **All of:** - **`address`** `string | null` - **`country`** `string | null` - **`email`** `string | null`, format: `email` - **`internal_notes`** `string | null` - **`is_legal`** `boolean` - **`name`** `string` - **`notes`** `string | null` - **`payment_methods`** `array` — When supplied, replaces the partner's payment methods. Send an empty array to remove all methods. **Items:** - **`account_number` (required)** `string` - **`type` (required)** `string`, possible values: `"bank_account", "paypal", "skrill", "other"` - **`bank_name`** `string | null` — Required when \`type\` is \`bank\_account\`. - **`is_primary`** `boolean`, default: `false` - **`name`** `string | null` — Required when \`type\` is \`other\`. - **`swift_code`** `string | null` — Required when \`type\` is \`bank\_account\`. - **`phone_number`** `string | null` - **`phone_prefix`** `string | null` - **`preferences`** `object` - **`currency_code`** `string | null` - **`default_due_days`** `integer | null` - **`document_lang`** `string | null` - **`late_fee_percent`** `number | null` - **`registration_number`** `string | null` — Required when the resulting partner is a legal entity. - **`vat_registration_number`** `string | null` **Example:** ```json { "name": "", "is_legal": true, "registration_number": null, "vat_registration_number": null, "address": null, "email": null, "country": null, "phone_prefix": null, "phone_number": null, "notes": null, "internal_notes": null, "preferences": null, "payment_methods": [] } ``` #### Responses ##### Status: 201 The partner was created. ###### Content-Type: application/json - **`address` (required)** `string | null` - **`country` (required)** `string | null` - **`created_at` (required)** `string | null`, format: `date-time` - **`email` (required)** `string | null`, format: `email` - **`internal_notes` (required)** `string | null` - **`is_legal` (required)** `boolean` - **`name` (required)** `string` - **`notes` (required)** `string | null` - **`payment_methods` (required)** `array` **Items:** **All of:** - **`account_number` (required)** `string` - **`type` (required)** `string`, possible values: `"bank_account", "paypal", "skrill", "other"` - **`bank_name`** `string | null` — Required when \`type\` is \`bank\_account\`. - **`is_primary`** `boolean`, default: `false` - **`name`** `string | null` — Required when \`type\` is \`other\`. - **`swift_code`** `string | null` — Required when \`type\` is \`bank\_account\`. * **`uuid` (required)** `string`, format: `uuid` - **`phone_number` (required)** `string | null` - **`phone_prefix` (required)** `string | null` - **`preferences` (required)** `object` - **`currency_code`** `string | null` - **`default_due_days`** `integer | null` - **`document_lang`** `string | null` - **`late_fee_percent`** `number | null` - **`registration_number` (required)** `string | null` - **`updated_at` (required)** `string | null`, format: `date-time` - **`uuid` (required)** `string`, format: `uuid` - **`vat_registration_number` (required)** `string | null` **Example:** ```json { "uuid": "", "name": "", "is_legal": true, "registration_number": null, "vat_registration_number": null, "address": null, "email": null, "country": null, "phone_prefix": null, "phone_number": null, "notes": null, "internal_notes": null, "preferences": { "default_due_days": null, "late_fee_percent": null, "currency_code": null, "document_lang": null }, "payment_methods": [ { "type": "bank_account", "is_primary": false, "account_number": "", "name": null, "bank_name": null, "swift_code": null, "uuid": "" } ], "created_at": null, "updated_at": null } ``` ##### Status: 401 The API key is missing, invalid, deleted, or otherwise cannot be resolved. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 402 The company has neither an active trial nor Public API access in its current plan, the Unlimited Public API allowance has been exhausted, or another subscription feature limit has been reached. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 403 The key is suspended, expired, blocked by its IP allowlist, or lacks the required permission. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 422 One or more request values are invalid. Error keys identify the invalid request fields. Human-readable messages can be localized and must not be used as stable machine-readable identifiers. ###### Content-Type: application/json - **`errors` (required)** `object` - **`message` (required)** `string` **Example:** ```json { "message": "", "errors": { "additionalProperty": [ "" ] } } ``` ##### Status: 429 The request rate limit has been exceeded. Authenticated endpoints allow 120 requests per minute per API key, email delivery additionally allows 30 requests per minute per API key, authentication allows 300 attempts per minute per IP, and status allows 60 requests per minute per IP. ###### Content-Type: application/json - **`error` (required)** `string` - **`retry_after` (required)** `integer | string` — Seconds to wait before retrying. - **`status` (required)** `integer` **Example:** ```json { "status": 429, "error": "Too many requests.", "retry_after": 1 } ``` ### Get a partner - **Method:** `GET` - **Path:** `/partners/{uuid}` - **Tags:** Partners Returns one non-deleted partner from the API key's company. #### Parameters ##### `App-Locale` - **In:** `header` Preferred language for validation messages. Use a two-letter system locale supported by Numbero. If omitted or unsupported, Numbero uses the fallback locale. `string` ##### `uuid` required - **In:** `path` Resource UUID. `string`, format: `uuid` #### Responses ##### Status: 200 The partner. ###### Content-Type: application/json - **`address` (required)** `string | null` - **`country` (required)** `string | null` - **`created_at` (required)** `string | null`, format: `date-time` - **`email` (required)** `string | null`, format: `email` - **`internal_notes` (required)** `string | null` - **`is_legal` (required)** `boolean` - **`name` (required)** `string` - **`notes` (required)** `string | null` - **`payment_methods` (required)** `array` **Items:** **All of:** - **`account_number` (required)** `string` - **`type` (required)** `string`, possible values: `"bank_account", "paypal", "skrill", "other"` - **`bank_name`** `string | null` — Required when \`type\` is \`bank\_account\`. - **`is_primary`** `boolean`, default: `false` - **`name`** `string | null` — Required when \`type\` is \`other\`. - **`swift_code`** `string | null` — Required when \`type\` is \`bank\_account\`. * **`uuid` (required)** `string`, format: `uuid` - **`phone_number` (required)** `string | null` - **`phone_prefix` (required)** `string | null` - **`preferences` (required)** `object` - **`currency_code`** `string | null` - **`default_due_days`** `integer | null` - **`document_lang`** `string | null` - **`late_fee_percent`** `number | null` - **`registration_number` (required)** `string | null` - **`updated_at` (required)** `string | null`, format: `date-time` - **`uuid` (required)** `string`, format: `uuid` - **`vat_registration_number` (required)** `string | null` **Example:** ```json { "uuid": "", "name": "", "is_legal": true, "registration_number": null, "vat_registration_number": null, "address": null, "email": null, "country": null, "phone_prefix": null, "phone_number": null, "notes": null, "internal_notes": null, "preferences": { "default_due_days": null, "late_fee_percent": null, "currency_code": null, "document_lang": null }, "payment_methods": [ { "type": "bank_account", "is_primary": false, "account_number": "", "name": null, "bank_name": null, "swift_code": null, "uuid": "" } ], "created_at": null, "updated_at": null } ``` ##### Status: 401 The API key is missing, invalid, deleted, or otherwise cannot be resolved. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 402 The company has neither an active trial nor Public API access in its current plan, the Unlimited Public API allowance has been exhausted, or another subscription feature limit has been reached. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 403 The key is suspended, expired, blocked by its IP allowlist, or lacks the required permission. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 404 The partner does not exist in the API key's company or has been deleted. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 429 The request rate limit has been exceeded. Authenticated endpoints allow 120 requests per minute per API key, email delivery additionally allows 30 requests per minute per API key, authentication allows 300 attempts per minute per IP, and status allows 60 requests per minute per IP. ###### Content-Type: application/json - **`error` (required)** `string` - **`retry_after` (required)** `integer | string` — Seconds to wait before retrying. - **`status` (required)** `integer` **Example:** ```json { "status": 429, "error": "Too many requests.", "retry_after": 1 } ``` ### Update a partner - **Method:** `PATCH` - **Path:** `/partners/{uuid}` - **Tags:** Partners Updates only the supplied fields. Omit `payment_methods` to preserve existing methods; send an empty array to remove them. #### Parameters ##### `App-Locale` - **In:** `header` Preferred language for validation messages. Use a two-letter system locale supported by Numbero. If omitted or unsupported, Numbero uses the fallback locale. `string` ##### `uuid` required - **In:** `path` Resource UUID. `string`, format: `uuid` #### Request Body ##### Content-Type: application/json - **`address`** `string | null` - **`country`** `string | null` - **`email`** `string | null`, format: `email` - **`internal_notes`** `string | null` - **`is_legal`** `boolean` - **`name`** `string` - **`notes`** `string | null` - **`payment_methods`** `array` — When supplied, replaces the partner's payment methods. Send an empty array to remove all methods. **Items:** - **`account_number` (required)** `string` - **`type` (required)** `string`, possible values: `"bank_account", "paypal", "skrill", "other"` - **`bank_name`** `string | null` — Required when \`type\` is \`bank\_account\`. - **`is_primary`** `boolean`, default: `false` - **`name`** `string | null` — Required when \`type\` is \`other\`. - **`swift_code`** `string | null` — Required when \`type\` is \`bank\_account\`. - **`phone_number`** `string | null` - **`phone_prefix`** `string | null` - **`preferences`** `object` - **`currency_code`** `string | null` - **`default_due_days`** `integer | null` - **`document_lang`** `string | null` - **`late_fee_percent`** `number | null` - **`registration_number`** `string | null` — Required when the resulting partner is a legal entity. - **`vat_registration_number`** `string | null` **Example:** ```json { "name": "", "is_legal": true, "registration_number": null, "vat_registration_number": null, "address": null, "email": null, "country": null, "phone_prefix": null, "phone_number": null, "notes": null, "internal_notes": null, "preferences": { "default_due_days": null, "late_fee_percent": null, "currency_code": null, "document_lang": null }, "payment_methods": [] } ``` #### Responses ##### Status: 200 The updated partner. ###### Content-Type: application/json - **`address` (required)** `string | null` - **`country` (required)** `string | null` - **`created_at` (required)** `string | null`, format: `date-time` - **`email` (required)** `string | null`, format: `email` - **`internal_notes` (required)** `string | null` - **`is_legal` (required)** `boolean` - **`name` (required)** `string` - **`notes` (required)** `string | null` - **`payment_methods` (required)** `array` **Items:** **All of:** - **`account_number` (required)** `string` - **`type` (required)** `string`, possible values: `"bank_account", "paypal", "skrill", "other"` - **`bank_name`** `string | null` — Required when \`type\` is \`bank\_account\`. - **`is_primary`** `boolean`, default: `false` - **`name`** `string | null` — Required when \`type\` is \`other\`. - **`swift_code`** `string | null` — Required when \`type\` is \`bank\_account\`. * **`uuid` (required)** `string`, format: `uuid` - **`phone_number` (required)** `string | null` - **`phone_prefix` (required)** `string | null` - **`preferences` (required)** `object` - **`currency_code`** `string | null` - **`default_due_days`** `integer | null` - **`document_lang`** `string | null` - **`late_fee_percent`** `number | null` - **`registration_number` (required)** `string | null` - **`updated_at` (required)** `string | null`, format: `date-time` - **`uuid` (required)** `string`, format: `uuid` - **`vat_registration_number` (required)** `string | null` **Example:** ```json { "uuid": "", "name": "", "is_legal": true, "registration_number": null, "vat_registration_number": null, "address": null, "email": null, "country": null, "phone_prefix": null, "phone_number": null, "notes": null, "internal_notes": null, "preferences": { "default_due_days": null, "late_fee_percent": null, "currency_code": null, "document_lang": null }, "payment_methods": [ { "type": "bank_account", "is_primary": false, "account_number": "", "name": null, "bank_name": null, "swift_code": null, "uuid": "" } ], "created_at": null, "updated_at": null } ``` ##### Status: 401 The API key is missing, invalid, deleted, or otherwise cannot be resolved. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 402 The company has neither an active trial nor Public API access in its current plan, the Unlimited Public API allowance has been exhausted, or another subscription feature limit has been reached. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 403 The key is suspended, expired, blocked by its IP allowlist, or lacks the required permission. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 404 The partner does not exist in the API key's company or has been deleted. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 422 One or more request values are invalid. Error keys identify the invalid request fields. Human-readable messages can be localized and must not be used as stable machine-readable identifiers. ###### Content-Type: application/json - **`errors` (required)** `object` - **`message` (required)** `string` **Example:** ```json { "message": "", "errors": { "additionalProperty": [ "" ] } } ``` ##### Status: 429 The request rate limit has been exceeded. Authenticated endpoints allow 120 requests per minute per API key, email delivery additionally allows 30 requests per minute per API key, authentication allows 300 attempts per minute per IP, and status allows 60 requests per minute per IP. ###### Content-Type: application/json - **`error` (required)** `string` - **`retry_after` (required)** `integer | string` — Seconds to wait before retrying. - **`status` (required)** `integer` **Example:** ```json { "status": 429, "error": "Too many requests.", "retry_after": 1 } ``` ### Delete a partner - **Method:** `DELETE` - **Path:** `/partners/{uuid}` - **Tags:** Partners Soft-deletes a partner from the API key's company. #### Parameters ##### `App-Locale` - **In:** `header` Preferred language for validation messages. Use a two-letter system locale supported by Numbero. If omitted or unsupported, Numbero uses the fallback locale. `string` ##### `uuid` required - **In:** `path` Resource UUID. `string`, format: `uuid` #### Responses ##### Status: 204 The partner was deleted. ##### Status: 401 The API key is missing, invalid, deleted, or otherwise cannot be resolved. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 402 The company has neither an active trial nor Public API access in its current plan, the Unlimited Public API allowance has been exhausted, or another subscription feature limit has been reached. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 403 The key is suspended, expired, blocked by its IP allowlist, or lacks the required permission. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 404 The partner does not exist in the API key's company or has been deleted. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 429 The request rate limit has been exceeded. Authenticated endpoints allow 120 requests per minute per API key, email delivery additionally allows 30 requests per minute per API key, authentication allows 300 attempts per minute per IP, and status allows 60 requests per minute per IP. ###### Content-Type: application/json - **`error` (required)** `string` - **`retry_after` (required)** `integer | string` — Seconds to wait before retrying. - **`status` (required)** `integer` **Example:** ```json { "status": 429, "error": "Too many requests.", "retry_after": 1 } ``` ### List stock items - **Method:** `GET` - **Path:** `/stock-items` - **Tags:** Stock items Returns a searchable, sorted, page-based list of non-deleted reusable products and services belonging to the API key's company. #### Parameters ##### `App-Locale` - **In:** `header` Preferred language for validation messages. Use a two-letter system locale supported by Numbero. If omitted or unsupported, Numbero uses the fallback locale. `string` ##### `page` - **In:** `query` `integer`, default: `1` ##### `per_page` - **In:** `query` `integer`, default: `25` ##### `search` - **In:** `query` Searches name, SKU, and description. `[ "string", "null" ]` ##### `sort_field` - **In:** `query` `string`, possible values: `"name", "sku", "measurement", "quantity", "price", "discount", "vat_percent"` ##### `sort_direction` - **In:** `query` `string`, possible values: `"asc", "desc"`, default: `"desc"` #### Responses ##### Status: 200 A page of stock items. ###### Content-Type: application/json - **`data` (required)** `array` **Items:** **All of:** - **`description`** `string | null` - **`discount`** `number | null` - **`measurement`** `string | null` - **`name`** `string` - **`price`** `number | null` - **`quantity`** `number | null` - **`sku`** `string | null` - **`vat_percent`** `number | null` - **`vat_reference_uuid`** `string | null`, format: `uuid` — Must identify a VAT reference belonging to the API key's company. Send null to remove it. * **`created_at` (required)** `string | null`, format: `date-time` * **`updated_at` (required)** `string | null`, format: `date-time` * **`uuid` (required)** `string`, format: `uuid` - **`links` (required)** `object` - **`first` (required)** `string`, format: `uri` - **`last` (required)** `string`, format: `uri` - **`next` (required)** `string | null`, format: `uri` - **`prev` (required)** `string | null`, format: `uri` - **`meta` (required)** `object` - **`current_page` (required)** `integer` - **`from` (required)** `integer | null` - **`last_page` (required)** `integer` - **`path` (required)** `string`, format: `uri` - **`per_page` (required)** `integer` - **`to` (required)** `integer | null` - **`total` (required)** `integer` **Example:** ```json { "data": [ { "sku": null, "name": "", "description": null, "measurement": null, "quantity": null, "price": null, "discount": null, "vat_percent": null, "vat_reference_uuid": null, "uuid": "", "created_at": null, "updated_at": null } ], "links": { "first": "", "last": "", "prev": null, "next": null }, "meta": { "current_page": 1, "from": null, "last_page": 1, "path": "", "per_page": 1, "to": null, "total": 0 } } ``` ##### Status: 401 The API key is missing, invalid, deleted, or otherwise cannot be resolved. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 402 The company has neither an active trial nor Public API access in its current plan, the Unlimited Public API allowance has been exhausted, or another subscription feature limit has been reached. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 403 The key is suspended, expired, blocked by its IP allowlist, or lacks the required permission. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 422 One or more request values are invalid. Error keys identify the invalid request fields. Human-readable messages can be localized and must not be used as stable machine-readable identifiers. ###### Content-Type: application/json - **`errors` (required)** `object` - **`message` (required)** `string` **Example:** ```json { "message": "", "errors": { "additionalProperty": [ "" ] } } ``` ##### Status: 429 The request rate limit has been exceeded. Authenticated endpoints allow 120 requests per minute per API key, email delivery additionally allows 30 requests per minute per API key, authentication allows 300 attempts per minute per IP, and status allows 60 requests per minute per IP. ###### Content-Type: application/json - **`error` (required)** `string` - **`retry_after` (required)** `integer | string` — Seconds to wait before retrying. - **`status` (required)** `integer` **Example:** ```json { "status": 429, "error": "Too many requests.", "retry_after": 1 } ``` ### Create a stock item - **Method:** `POST` - **Path:** `/stock-items` - **Tags:** Stock items Creates a reusable product or service for the API key's company. #### Parameters ##### `App-Locale` - **In:** `header` Preferred language for validation messages. Use a two-letter system locale supported by Numbero. If omitted or unsupported, Numbero uses the fallback locale. `string` #### Request Body ##### Content-Type: application/json **All of:** - **`description`** `string | null` - **`discount`** `number | null` - **`measurement`** `string | null` - **`name`** `string` - **`price`** `number | null` - **`quantity`** `number | null` - **`sku`** `string | null` - **`vat_percent`** `number | null` - **`vat_reference_uuid`** `string | null`, format: `uuid` — Must identify a VAT reference belonging to the API key's company. Send null to remove it. **Example:** ```json { "sku": null, "name": "", "description": null, "measurement": null, "quantity": null, "price": null, "discount": null, "vat_percent": null, "vat_reference_uuid": null } ``` #### Responses ##### Status: 201 The stock item was created. ###### Content-Type: application/json **All of:** - **`description`** `string | null` - **`discount`** `number | null` - **`measurement`** `string | null` - **`name`** `string` - **`price`** `number | null` - **`quantity`** `number | null` - **`sku`** `string | null` - **`vat_percent`** `number | null` - **`vat_reference_uuid`** `string | null`, format: `uuid` — Must identify a VAT reference belonging to the API key's company. Send null to remove it. * **`created_at` (required)** `string | null`, format: `date-time` * **`updated_at` (required)** `string | null`, format: `date-time` * **`uuid` (required)** `string`, format: `uuid` **Example:** ```json { "sku": null, "name": "", "description": null, "measurement": null, "quantity": null, "price": null, "discount": null, "vat_percent": null, "vat_reference_uuid": null, "uuid": "", "created_at": null, "updated_at": null } ``` ##### Status: 401 The API key is missing, invalid, deleted, or otherwise cannot be resolved. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 402 The company has neither an active trial nor Public API access in its current plan, the Unlimited Public API allowance has been exhausted, or another subscription feature limit has been reached. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 403 The key is suspended, expired, blocked by its IP allowlist, or lacks the required permission. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 422 One or more request values are invalid. Error keys identify the invalid request fields. Human-readable messages can be localized and must not be used as stable machine-readable identifiers. ###### Content-Type: application/json - **`errors` (required)** `object` - **`message` (required)** `string` **Example:** ```json { "message": "", "errors": { "additionalProperty": [ "" ] } } ``` ##### Status: 429 The request rate limit has been exceeded. Authenticated endpoints allow 120 requests per minute per API key, email delivery additionally allows 30 requests per minute per API key, authentication allows 300 attempts per minute per IP, and status allows 60 requests per minute per IP. ###### Content-Type: application/json - **`error` (required)** `string` - **`retry_after` (required)** `integer | string` — Seconds to wait before retrying. - **`status` (required)** `integer` **Example:** ```json { "status": 429, "error": "Too many requests.", "retry_after": 1 } ``` ### Get a stock item - **Method:** `GET` - **Path:** `/stock-items/{uuid}` - **Tags:** Stock items Returns one non-deleted stock item from the API key's company. #### Parameters ##### `App-Locale` - **In:** `header` Preferred language for validation messages. Use a two-letter system locale supported by Numbero. If omitted or unsupported, Numbero uses the fallback locale. `string` ##### `uuid` required - **In:** `path` Resource UUID. `string`, format: `uuid` #### Responses ##### Status: 200 The stock item. ###### Content-Type: application/json **All of:** - **`description`** `string | null` - **`discount`** `number | null` - **`measurement`** `string | null` - **`name`** `string` - **`price`** `number | null` - **`quantity`** `number | null` - **`sku`** `string | null` - **`vat_percent`** `number | null` - **`vat_reference_uuid`** `string | null`, format: `uuid` — Must identify a VAT reference belonging to the API key's company. Send null to remove it. * **`created_at` (required)** `string | null`, format: `date-time` * **`updated_at` (required)** `string | null`, format: `date-time` * **`uuid` (required)** `string`, format: `uuid` **Example:** ```json { "sku": null, "name": "", "description": null, "measurement": null, "quantity": null, "price": null, "discount": null, "vat_percent": null, "vat_reference_uuid": null, "uuid": "", "created_at": null, "updated_at": null } ``` ##### Status: 401 The API key is missing, invalid, deleted, or otherwise cannot be resolved. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 402 The company has neither an active trial nor Public API access in its current plan, the Unlimited Public API allowance has been exhausted, or another subscription feature limit has been reached. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 403 The key is suspended, expired, blocked by its IP allowlist, or lacks the required permission. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 404 The stock item does not exist in the API key's company or has been deleted. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 429 The request rate limit has been exceeded. Authenticated endpoints allow 120 requests per minute per API key, email delivery additionally allows 30 requests per minute per API key, authentication allows 300 attempts per minute per IP, and status allows 60 requests per minute per IP. ###### Content-Type: application/json - **`error` (required)** `string` - **`retry_after` (required)** `integer | string` — Seconds to wait before retrying. - **`status` (required)** `integer` **Example:** ```json { "status": 429, "error": "Too many requests.", "retry_after": 1 } ``` ### Update a stock item - **Method:** `PATCH` - **Path:** `/stock-items/{uuid}` - **Tags:** Stock items Updates only the supplied fields of a stock item. #### Parameters ##### `App-Locale` - **In:** `header` Preferred language for validation messages. Use a two-letter system locale supported by Numbero. If omitted or unsupported, Numbero uses the fallback locale. `string` ##### `uuid` required - **In:** `path` Resource UUID. `string`, format: `uuid` #### Request Body ##### Content-Type: application/json - **`description`** `string | null` - **`discount`** `number | null` - **`measurement`** `string | null` - **`name`** `string` - **`price`** `number | null` - **`quantity`** `number | null` - **`sku`** `string | null` - **`vat_percent`** `number | null` - **`vat_reference_uuid`** `string | null`, format: `uuid` — Must identify a VAT reference belonging to the API key's company. Send null to remove it. **Example:** ```json { "sku": null, "name": "", "description": null, "measurement": null, "quantity": null, "price": null, "discount": null, "vat_percent": null, "vat_reference_uuid": null } ``` #### Responses ##### Status: 200 The updated stock item. ###### Content-Type: application/json **All of:** - **`description`** `string | null` - **`discount`** `number | null` - **`measurement`** `string | null` - **`name`** `string` - **`price`** `number | null` - **`quantity`** `number | null` - **`sku`** `string | null` - **`vat_percent`** `number | null` - **`vat_reference_uuid`** `string | null`, format: `uuid` — Must identify a VAT reference belonging to the API key's company. Send null to remove it. * **`created_at` (required)** `string | null`, format: `date-time` * **`updated_at` (required)** `string | null`, format: `date-time` * **`uuid` (required)** `string`, format: `uuid` **Example:** ```json { "sku": null, "name": "", "description": null, "measurement": null, "quantity": null, "price": null, "discount": null, "vat_percent": null, "vat_reference_uuid": null, "uuid": "", "created_at": null, "updated_at": null } ``` ##### Status: 401 The API key is missing, invalid, deleted, or otherwise cannot be resolved. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 402 The company has neither an active trial nor Public API access in its current plan, the Unlimited Public API allowance has been exhausted, or another subscription feature limit has been reached. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 403 The key is suspended, expired, blocked by its IP allowlist, or lacks the required permission. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 404 The stock item does not exist in the API key's company or has been deleted. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 422 One or more request values are invalid. Error keys identify the invalid request fields. Human-readable messages can be localized and must not be used as stable machine-readable identifiers. ###### Content-Type: application/json - **`errors` (required)** `object` - **`message` (required)** `string` **Example:** ```json { "message": "", "errors": { "additionalProperty": [ "" ] } } ``` ##### Status: 429 The request rate limit has been exceeded. Authenticated endpoints allow 120 requests per minute per API key, email delivery additionally allows 30 requests per minute per API key, authentication allows 300 attempts per minute per IP, and status allows 60 requests per minute per IP. ###### Content-Type: application/json - **`error` (required)** `string` - **`retry_after` (required)** `integer | string` — Seconds to wait before retrying. - **`status` (required)** `integer` **Example:** ```json { "status": 429, "error": "Too many requests.", "retry_after": 1 } ``` ### Delete a stock item - **Method:** `DELETE` - **Path:** `/stock-items/{uuid}` - **Tags:** Stock items Soft-deletes a stock item from the API key's company. #### Parameters ##### `App-Locale` - **In:** `header` Preferred language for validation messages. Use a two-letter system locale supported by Numbero. If omitted or unsupported, Numbero uses the fallback locale. `string` ##### `uuid` required - **In:** `path` Resource UUID. `string`, format: `uuid` #### Responses ##### Status: 204 The stock item was deleted. ##### Status: 401 The API key is missing, invalid, deleted, or otherwise cannot be resolved. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 402 The company has neither an active trial nor Public API access in its current plan, the Unlimited Public API allowance has been exhausted, or another subscription feature limit has been reached. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 403 The key is suspended, expired, blocked by its IP allowlist, or lacks the required permission. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 404 The stock item does not exist in the API key's company or has been deleted. ###### Content-Type: application/json - **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ##### Status: 429 The request rate limit has been exceeded. Authenticated endpoints allow 120 requests per minute per API key, email delivery additionally allows 30 requests per minute per API key, authentication allows 300 attempts per minute per IP, and status allows 60 requests per minute per IP. ###### Content-Type: application/json - **`error` (required)** `string` - **`retry_after` (required)** `integer | string` — Seconds to wait before retrying. - **`status` (required)** `integer` **Example:** ```json { "status": 429, "error": "Too many requests.", "retry_after": 1 } ``` ## Schemas ### StatusResponse - **Type:**`object` * **`status` (required)** `string` **Example:** ```json { "status": "ok" } ``` ### BookkeepingRecordType - **Type:**`string` **Example:** ### BookkeepingRecordStatus - **Type:**`string` **Example:** ### PaymentType - **Type:**`string` **Example:** ### DealType - **Type:**`string` **Example:** ### CreateBookkeepingRecordRequest - **Type:**`object` Do not send server-managed fields such as category, status, is\_template, is\_final, document numbering fields, sender, logo, color, signature, discount flags, or line sequence numbers. Numbero returns a validation error when a specifically prohibited field is supplied. - **`currency_code` (required)** `string` — A currency code supported by Numbero. Input is normalized to uppercase. - **`date` (required)** `string`, format: `date` — Document date in YYYY-MM-DD format. - **`items` (required)** `array` **Items:** **Any of:** **Not:** **Any of:** - **`uuid`** `null` - **`lang` (required)** `string` — A two-letter document language supported by Numbero. - **`recipient` (required)** `object` — Provide an existing company partner UUID to fill recipient fields, preferences, and payment methods. With a non-null UUID, name, country, and vat\_registration\_number must be omitted: they are copied from the saved partner. Supplying these fields returns 422, even if unchanged, null, or empty. Other permitted fields override only the document snapshot. The saved partner is not updated. Omit UUID or send null to enter the recipient manually. **Any of:** **Not:** **Any of:** - **`uuid`** `null` - **`tax_by_group` (required)** `boolean` — Whether VAT and totals are rounded by VAT-rate group. - **`type` (required)** `string`, possible values: `"offer", "invoice", "waybill", "credit_note", "advance_invoice"` - **`additional_price_rows`** `array` — Positive previously-paid rows deducted from the total. **Items:** - **`amount` (required)** `number` - **`description` (required)** `string` - **`carrier`** `object` — Allowed only for waybills. When supplied, is\_legal, country, and name are required. - **`country` (required)** `string` - **`is_legal` (required)** `boolean` - **`name` (required)** `string` - **`driver`** `string | null` - **`issuing_address`** `string | null` - **`receipt_address`** `string | null` - **`registration_number`** `string | null` — Required when the carrier is a legal entity. - **`vehicle_model`** `string | null` - **`vehicle_plate`** `string | null` - **`currency_rate`** `number | null` — Required when currency\_code differs from the company's base currency. Numbero uses 1 for the base currency. At most five decimal places. - **`deal_type`** `object` — Not allowed for offers. - **`deal_type_custom`** `string | null` — Required only when deal\_type is other; prohibited otherwise. - **`due_date`** `string | null`, format: `date` — Cannot be earlier than date. - **`label`** `string | null` - **`late_fee_percent`** `number | null` - **`notes`** `string | null` - **`payment_type`** `object` — Not allowed for offers. - **`payment_type_custom`** `string | null` — Required only when payment\_type is other; prohibited otherwise. - **`prepaid_amount`** `number | null` — Allowed only for advance invoices. **Example:** ```json { "label": null, "lang": "en", "type": "offer", "currency_code": "EUR", "currency_rate": null, "tax_by_group": true, "date": "", "due_date": null, "late_fee_percent": null, "notes": null, "payment_type": "cash", "payment_type_custom": null, "deal_type": "goods", "deal_type_custom": null, "prepaid_amount": null, "recipient": { "uuid": "", "name": "", "country": "lv", "is_legal": true, "registration_number": null, "vat_registration_number": null, "email": null, "address": null, "phone_prefix": null, "phone_number": null, "notes": null, "internal_notes": null, "save_as_partner": true, "payment_methods": [] }, "carrier": { "is_legal": true, "country": "", "name": "", "registration_number": null, "driver": null, "vehicle_model": null, "vehicle_plate": null, "issuing_address": null, "receipt_address": null }, "items": [ { "uuid": "" } ], "additional_price_rows": [ { "description": "", "amount": 0.01 } ] } ``` ### RecipientInput - **Type:**`object` Provide an existing company partner UUID to fill recipient fields, preferences, and payment methods. With a non-null UUID, name, country, and vat\_registration\_number must be omitted: they are copied from the saved partner. Supplying these fields returns 422, even if unchanged, null, or empty. Other permitted fields override only the document snapshot. The saved partner is not updated. Omit UUID or send null to enter the recipient manually. **Any of:** **Not:** **Any of:** - **`uuid`** `null` **Example:** ```json { "uuid": "", "name": "", "country": "lv", "is_legal": true, "registration_number": null, "vat_registration_number": null, "email": null, "address": null, "phone_prefix": null, "phone_number": null, "notes": null, "internal_notes": null, "save_as_partner": true, "payment_methods": [ { "account_number": "", "bank_name": "", "swift_code": "" } ] } ``` ### RecipientPaymentMethodInput - **Type:**`object` Do not send type. Numbero stores the method as a bank account. - **`account_number` (required)** `string` - **`bank_name` (required)** `string` - **`swift_code` (required)** `string` **Example:** ```json { "account_number": "", "bank_name": "", "swift_code": "" } ``` ### CarrierInput - **Type:**`object` Allowed only for waybills. When supplied, is\_legal, country, and name are required. - **`country` (required)** `string` - **`is_legal` (required)** `boolean` - **`name` (required)** `string` - **`driver`** `string | null` - **`issuing_address`** `string | null` - **`receipt_address`** `string | null` - **`registration_number`** `string | null` — Required when the carrier is a legal entity. - **`vehicle_model`** `string | null` - **`vehicle_plate`** `string | null` **Example:** ```json { "is_legal": true, "country": "", "name": "", "registration_number": null, "driver": null, "vehicle_model": null, "vehicle_plate": null, "issuing_address": null, "receipt_address": null } ``` ### BookkeepingRecordItemInput - **Type:**`object` Use a stock item UUID to fill omitted fields, or omit UUID/send null and enter line fields manually. With a non-null UUID, sending name or sku returns 422, even if unchanged, null, or empty. Other permitted fields can override the document line. Name, measurement, quantity, and price must be valid after merging. Manual and UUID-based lines can be mixed. Do not send sequence\_no. Numbero assigns line order and calculates VAT, discounts, and totals. **Any of:** **Not:** **Any of:** - **`uuid`** `null` **Example:** ```json { "uuid": "", "sku": null, "name": "", "description": null, "measurement": "", "quantity": -999999999.999999, "discount": 0, "vat_percent": null, "price": -999999999.999999, "vat_reference_uuid": null } ``` ### AdditionalPriceRow - **Type:**`object` * **`amount` (required)** `number` * **`description` (required)** `string` **Example:** ```json { "description": "", "amount": 0.01 } ``` ### SendBookkeepingRecordRequest - **Type:**`object` * **`email` (required)** `string`, format: `email` — Primary recipient. Input is trimmed and normalized to lowercase. * **`bcc`** `array | null` — Up to five unique blind-copy addresses. The primary email address cannot also appear in this array. Stored company BCC defaults are not added automatically. * **`message`** `string | null` — When omitted or null, the company default for the document type is used. Document variables are replaced before the email is queued. * **`subject`** `string | null` — When omitted or null, the company default for the document type is used. Supported variables: {NUMBER}, {ISSUED\_AT}, {DUE\_AT}, {LATE\_FEE\_RATE}, {CLIENT\_NAME}, {TOTAL\_AMOUNT}, and {DOCUMENT\_TYPE}. Legacy equivalents prefixed with @ are also supported. **Example:** ```json { "email": "", "bcc": [ "" ], "subject": null, "message": null } ``` ### QueuedEmailResponse - **Type:**`object` * **`status` (required)** `string` * **`uuid` (required)** `string`, format: `uuid` **Example:** ```json { "status": "queued", "uuid": "" } ``` ### BookkeepingRecordSummary - **Type:**`object` * **`created_at` (required)** `string | null`, format: `date-time` * **`currency_code` (required)** `string` * **`date` (required)** `string | null`, format: `date` * **`due_date` (required)** `string | null`, format: `date` * **`recipient` (required)** `object` - **`name` (required)** `string | null` - **`registration_number` (required)** `string | null` * **`record_number` (required)** `string | null` * **`status` (required)** `object` * **`total_with_vat` (required)** `number` * **`total_without_vat` (required)** `number` * **`type` (required)** `string`, possible values: `"offer", "invoice", "waybill", "credit_note", "advance_invoice"` * **`updated_at` (required)** `string | null`, format: `date-time` * **`uuid` (required)** `string`, format: `uuid` **Example:** ```json { "uuid": "", "type": "offer", "status": "draft", "record_number": null, "date": null, "due_date": null, "currency_code": "EUR", "total_without_vat": 1, "total_with_vat": 1, "recipient": { "name": null, "registration_number": null }, "created_at": null, "updated_at": null } ``` ### BookkeepingRecordRecipientSummary - **Type:**`object` * **`name` (required)** `string | null` * **`registration_number` (required)** `string | null` **Example:** ```json { "name": null, "registration_number": null } ``` ### PaginationLinks - **Type:**`object` * **`first` (required)** `string`, format: `uri` * **`last` (required)** `string`, format: `uri` * **`next` (required)** `string | null`, format: `uri` * **`prev` (required)** `string | null`, format: `uri` **Example:** ```json { "first": "", "last": "", "prev": null, "next": null } ``` ### PaginationMeta - **Type:**`object` * **`current_page` (required)** `integer` * **`from` (required)** `integer | null` * **`last_page` (required)** `integer` * **`path` (required)** `string`, format: `uri` * **`per_page` (required)** `integer` * **`to` (required)** `integer | null` * **`total` (required)** `integer` **Example:** ```json { "current_page": 1, "from": null, "last_page": 1, "path": "", "per_page": 1, "to": null, "total": 0 } ``` ### PaginatedBookkeepingRecords - **Type:**`object` * **`data` (required)** `array` **Items:** - **`created_at` (required)** `string | null`, format: `date-time` - **`currency_code` (required)** `string` - **`date` (required)** `string | null`, format: `date` - **`due_date` (required)** `string | null`, format: `date` - **`recipient` (required)** `object` - **`name` (required)** `string | null` - **`registration_number` (required)** `string | null` - **`record_number` (required)** `string | null` - **`status` (required)** `object` - **`total_with_vat` (required)** `number` - **`total_without_vat` (required)** `number` - **`type` (required)** `string`, possible values: `"offer", "invoice", "waybill", "credit_note", "advance_invoice"` - **`updated_at` (required)** `string | null`, format: `date-time` - **`uuid` (required)** `string`, format: `uuid` * **`links` (required)** `object` - **`first` (required)** `string`, format: `uri` - **`last` (required)** `string`, format: `uri` - **`next` (required)** `string | null`, format: `uri` - **`prev` (required)** `string | null`, format: `uri` * **`meta` (required)** `object` - **`current_page` (required)** `integer` - **`from` (required)** `integer | null` - **`last_page` (required)** `integer` - **`path` (required)** `string`, format: `uri` - **`per_page` (required)** `integer` - **`to` (required)** `integer | null` - **`total` (required)** `integer` **Example:** ```json { "data": [ { "uuid": "", "type": null, "status": null, "record_number": null, "date": null, "due_date": null, "currency_code": "EUR", "total_without_vat": 1, "total_with_vat": 1, "recipient": null, "created_at": null, "updated_at": null } ], "links": { "first": "", "last": "", "prev": null, "next": null }, "meta": { "current_page": 1, "from": null, "last_page": 1, "path": "", "per_page": 1, "to": null, "total": 0 } } ``` ### PartnerPreferences - **Type:**`object` * **`currency_code`** `string | null` * **`default_due_days`** `integer | null` * **`document_lang`** `string | null` * **`late_fee_percent`** `number | null` **Example:** ```json { "default_due_days": null, "late_fee_percent": null, "currency_code": null, "document_lang": null } ``` ### PartnerPaymentMethodInput - **Type:**`object` * **`account_number` (required)** `string` * **`type` (required)** `string`, possible values: `"bank_account", "paypal", "skrill", "other"` * **`bank_name`** `string | null` — Required when \`type\` is \`bank\_account\`. * **`is_primary`** `boolean`, default: `false` * **`name`** `string | null` — Required when \`type\` is \`other\`. * **`swift_code`** `string | null` — Required when \`type\` is \`bank\_account\`. **Example:** ```json { "type": "bank_account", "is_primary": false, "account_number": "", "name": null, "bank_name": null, "swift_code": null } ``` ### PartnerPaymentMethod - **Type:** **Example:** ### UpdatePartnerRequest - **Type:**`object` * **`address`** `string | null` * **`country`** `string | null` * **`email`** `string | null`, format: `email` * **`internal_notes`** `string | null` * **`is_legal`** `boolean` * **`name`** `string` * **`notes`** `string | null` * **`payment_methods`** `array` — When supplied, replaces the partner's payment methods. Send an empty array to remove all methods. **Items:** - **`account_number` (required)** `string` - **`type` (required)** `string`, possible values: `"bank_account", "paypal", "skrill", "other"` - **`bank_name`** `string | null` — Required when \`type\` is \`bank\_account\`. - **`is_primary`** `boolean`, default: `false` - **`name`** `string | null` — Required when \`type\` is \`other\`. - **`swift_code`** `string | null` — Required when \`type\` is \`bank\_account\`. * **`phone_number`** `string | null` * **`phone_prefix`** `string | null` * **`preferences`** `object` - **`currency_code`** `string | null` - **`default_due_days`** `integer | null` - **`document_lang`** `string | null` - **`late_fee_percent`** `number | null` * **`registration_number`** `string | null` — Required when the resulting partner is a legal entity. * **`vat_registration_number`** `string | null` **Example:** ```json { "name": "", "is_legal": true, "registration_number": null, "vat_registration_number": null, "address": null, "email": null, "country": null, "phone_prefix": null, "phone_number": null, "notes": null, "internal_notes": null, "preferences": { "default_due_days": null, "late_fee_percent": null, "currency_code": null, "document_lang": null }, "payment_methods": [ { "type": "bank_account", "is_primary": false, "account_number": "", "name": null, "bank_name": null, "swift_code": null } ] } ``` ### CreatePartnerRequest - **Type:** **Example:** ### Partner - **Type:**`object` * **`address` (required)** `string | null` * **`country` (required)** `string | null` * **`created_at` (required)** `string | null`, format: `date-time` * **`email` (required)** `string | null`, format: `email` * **`internal_notes` (required)** `string | null` * **`is_legal` (required)** `boolean` * **`name` (required)** `string` * **`notes` (required)** `string | null` * **`payment_methods` (required)** `array` **Items:** **All of:** - **`account_number` (required)** `string` - **`type` (required)** `string`, possible values: `"bank_account", "paypal", "skrill", "other"` - **`bank_name`** `string | null` — Required when \`type\` is \`bank\_account\`. - **`is_primary`** `boolean`, default: `false` - **`name`** `string | null` — Required when \`type\` is \`other\`. - **`swift_code`** `string | null` — Required when \`type\` is \`bank\_account\`. * **`uuid` (required)** `string`, format: `uuid` * **`phone_number` (required)** `string | null` * **`phone_prefix` (required)** `string | null` * **`preferences` (required)** `object` - **`currency_code`** `string | null` - **`default_due_days`** `integer | null` - **`document_lang`** `string | null` - **`late_fee_percent`** `number | null` * **`registration_number` (required)** `string | null` * **`updated_at` (required)** `string | null`, format: `date-time` * **`uuid` (required)** `string`, format: `uuid` * **`vat_registration_number` (required)** `string | null` **Example:** ```json { "uuid": "", "name": "", "is_legal": true, "registration_number": null, "vat_registration_number": null, "address": null, "email": null, "country": null, "phone_prefix": null, "phone_number": null, "notes": null, "internal_notes": null, "preferences": { "default_due_days": null, "late_fee_percent": null, "currency_code": null, "document_lang": null }, "payment_methods": [ { "type": "bank_account", "is_primary": false, "account_number": "", "name": null, "bank_name": null, "swift_code": null, "uuid": "" } ], "created_at": null, "updated_at": null } ``` ### PaginatedPartners - **Type:**`object` * **`data` (required)** `array` **Items:** - **`address` (required)** `string | null` - **`country` (required)** `string | null` - **`created_at` (required)** `string | null`, format: `date-time` - **`email` (required)** `string | null`, format: `email` - **`internal_notes` (required)** `string | null` - **`is_legal` (required)** `boolean` - **`name` (required)** `string` - **`notes` (required)** `string | null` - **`payment_methods` (required)** `array` **Items:** **All of:** - **`account_number` (required)** `string` - **`type` (required)** `string`, possible values: `"bank_account", "paypal", "skrill", "other"` - **`bank_name`** `string | null` — Required when \`type\` is \`bank\_account\`. - **`is_primary`** `boolean`, default: `false` - **`name`** `string | null` — Required when \`type\` is \`other\`. - **`swift_code`** `string | null` — Required when \`type\` is \`bank\_account\`. * **`uuid` (required)** `string`, format: `uuid` - **`phone_number` (required)** `string | null` - **`phone_prefix` (required)** `string | null` - **`preferences` (required)** `object` - **`currency_code`** `string | null` - **`default_due_days`** `integer | null` - **`document_lang`** `string | null` - **`late_fee_percent`** `number | null` - **`registration_number` (required)** `string | null` - **`updated_at` (required)** `string | null`, format: `date-time` - **`uuid` (required)** `string`, format: `uuid` - **`vat_registration_number` (required)** `string | null` * **`links` (required)** `object` - **`first` (required)** `string`, format: `uri` - **`last` (required)** `string`, format: `uri` - **`next` (required)** `string | null`, format: `uri` - **`prev` (required)** `string | null`, format: `uri` * **`meta` (required)** `object` - **`current_page` (required)** `integer` - **`from` (required)** `integer | null` - **`last_page` (required)** `integer` - **`path` (required)** `string`, format: `uri` - **`per_page` (required)** `integer` - **`to` (required)** `integer | null` - **`total` (required)** `integer` **Example:** ```json { "data": [ { "uuid": "", "name": "", "is_legal": true, "registration_number": null, "vat_registration_number": null, "address": null, "email": null, "country": null, "phone_prefix": null, "phone_number": null, "notes": null, "internal_notes": null, "preferences": null, "payment_methods": [], "created_at": null, "updated_at": null } ], "links": { "first": "", "last": "", "prev": null, "next": null }, "meta": { "current_page": 1, "from": null, "last_page": 1, "path": "", "per_page": 1, "to": null, "total": 0 } } ``` ### UpdateStockItemRequest - **Type:**`object` * **`description`** `string | null` * **`discount`** `number | null` * **`measurement`** `string | null` * **`name`** `string` * **`price`** `number | null` * **`quantity`** `number | null` * **`sku`** `string | null` * **`vat_percent`** `number | null` * **`vat_reference_uuid`** `string | null`, format: `uuid` — Must identify a VAT reference belonging to the API key's company. Send null to remove it. **Example:** ```json { "sku": null, "name": "", "description": null, "measurement": null, "quantity": null, "price": null, "discount": null, "vat_percent": null, "vat_reference_uuid": null } ``` ### CreateStockItemRequest - **Type:** **Example:** ### StockItem - **Type:** **Example:** ### PaginatedStockItems - **Type:**`object` * **`data` (required)** `array` **Items:** **All of:** - **`description`** `string | null` - **`discount`** `number | null` - **`measurement`** `string | null` - **`name`** `string` - **`price`** `number | null` - **`quantity`** `number | null` - **`sku`** `string | null` - **`vat_percent`** `number | null` - **`vat_reference_uuid`** `string | null`, format: `uuid` — Must identify a VAT reference belonging to the API key's company. Send null to remove it. * **`created_at` (required)** `string | null`, format: `date-time` * **`updated_at` (required)** `string | null`, format: `date-time` * **`uuid` (required)** `string`, format: `uuid` * **`links` (required)** `object` - **`first` (required)** `string`, format: `uri` - **`last` (required)** `string`, format: `uri` - **`next` (required)** `string | null`, format: `uri` - **`prev` (required)** `string | null`, format: `uri` * **`meta` (required)** `object` - **`current_page` (required)** `integer` - **`from` (required)** `integer | null` - **`last_page` (required)** `integer` - **`path` (required)** `string`, format: `uri` - **`per_page` (required)** `integer` - **`to` (required)** `integer | null` - **`total` (required)** `integer` **Example:** ```json { "data": [ { "sku": null, "name": "", "description": null, "measurement": null, "quantity": null, "price": null, "discount": null, "vat_percent": null, "vat_reference_uuid": null, "uuid": "", "created_at": null, "updated_at": null } ], "links": { "first": "", "last": "", "prev": null, "next": null }, "meta": { "current_page": 1, "from": null, "last_page": 1, "path": "", "per_page": 1, "to": null, "total": 0 } } ``` ### BookkeepingRecord - **Type:**`object` * **`additional_price_rows` (required)** `array` **Items:** - **`amount` (required)** `number` - **`description` (required)** `string` * **`carrier` (required)** `object` * **`category` (required)** `string` * **`color` (required)** `string | null` * **`created_at` (required)** `string | null`, format: `date-time` * **`currency_code` (required)** `string` * **`currency_rate` (required)** `number` * **`date` (required)** `string | null`, format: `date` * **`deal_type` (required)** `object` * **`deal_type_custom` (required)** `string | null` * **`due_date` (required)** `string | null`, format: `date` * **`has_discount` (required)** `boolean` * **`has_multi_discount` (required)** `boolean` * **`has_multi_vat` (required)** `boolean` * **`hide_currency_rate` (required)** `boolean` * **`is_final` (required)** `boolean` * **`is_template` (required)** `boolean` * **`items` (required)** `array` **Items:** - **`description` (required)** `string | null` - **`discount` (required)** `number | null` - **`measurement` (required)** `string` - **`name` (required)** `string` - **`price` (required)** `number` - **`quantity` (required)** `number` - **`sequence_no` (required)** `integer` - **`sku` (required)** `string | null` - **`total_with_vat` (required)** `number` - **`total_with_vat_local` (required)** `number` - **`total_without_vat` (required)** `number` - **`total_without_vat_local` (required)** `number` - **`uuid` (required)** `string`, format: `uuid` - **`vat_amount` (required)** `number` - **`vat_amount_local` (required)** `number` - **`vat_percent` (required)** `number | null` - **`vat_reference_uuid` (required)** `string | null`, format: `uuid` * **`label` (required)** `string | null` * **`lang` (required)** `string | null` * **`late_fee_percent` (required)** `number | null` * **`notes` (required)** `string | null` * **`number_format` (required)** `string | null` * **`number_iterator` (required)** `integer | null` * **`payment_type` (required)** `object` * **`payment_type_custom` (required)** `string | null` * **`prepaid_amount` (required)** `number | null` * **`recipient` (required)** `object` * **`record_number` (required)** `string | null` * **`sender` (required)** `object` - **`address`** `string | null` - **`country`** `string | null` - **`email`** `string | null` - **`name`** `string | null` - **`notes`** `string | null` - **`payment_methods`** `array` **Items:** - **`account_number`** `string | null` - **`bank_name`** `string | null` - **`name`** `string | null` - **`swift_code`** `string | null` - **`type`** `string` - **`phone_number`** `string | null` - **`phone_prefix`** `string | null` - **`registration_number`** `string | null` - **`vat_registration_number`** `string | null` - **`website`** `string | null` * **`signature` (required)** `object | null` * **`status` (required)** `object` * **`tax_by_group` (required)** `boolean` * **`total_with_vat` (required)** `number` * **`total_with_vat_local` (required)** `number` * **`total_without_vat` (required)** `number` * **`total_without_vat_local` (required)** `number` * **`type` (required)** `string`, possible values: `"offer", "invoice", "waybill", "credit_note", "advance_invoice"` * **`updated_at` (required)** `string | null`, format: `date-time` * **`uuid` (required)** `string`, format: `uuid` * **`vat_amount` (required)** `number` * **`vat_amount_local` (required)** `number` **Example:** ```json { "uuid": "", "category": "income", "type": "offer", "status": "draft", "label": null, "is_template": false, "is_final": true, "lang": null, "number_format": null, "number_iterator": null, "record_number": null, "date": null, "due_date": null, "currency_code": "", "currency_rate": 1, "hide_currency_rate": true, "tax_by_group": true, "has_discount": true, "has_multi_discount": true, "has_multi_vat": true, "late_fee_percent": null, "payment_type": "cash", "payment_type_custom": null, "deal_type": "goods", "deal_type_custom": null, "notes": null, "color": null, "sender": { "name": null, "registration_number": null, "vat_registration_number": null, "email": null, "address": null, "country": null, "website": null, "phone_prefix": null, "phone_number": null, "notes": null, "payment_methods": [], "additionalProperty": "anything" }, "recipient": { "uuid": "", "is_legal": true, "internal_notes": null, "preferences": { "additionalProperty": "anything" } }, "carrier": { "name": null, "registration_number": null, "driver": null, "vehicle_model": null, "vehicle_plate": null, "issuing_address": null, "receipt_address": null, "additionalProperty": "anything" }, "signature": null, "items": [ { "uuid": "", "sequence_no": 0, "sku": null, "name": "", "description": null, "measurement": "", "quantity": 1, "discount": null, "vat_percent": null, "price": 1, "vat_reference_uuid": null, "vat_amount": 1, "total_without_vat": 1, "total_with_vat": 1, "vat_amount_local": 1, "total_without_vat_local": 1, "total_with_vat_local": 1 } ], "additional_price_rows": [ { "description": "", "amount": 0.01 } ], "prepaid_amount": null, "vat_amount": 1, "total_without_vat": 1, "total_with_vat": 1, "vat_amount_local": 1, "total_without_vat_local": 1, "total_with_vat_local": 1, "created_at": null, "updated_at": null } ``` ### PartySnapshot - **Type:**`object` * **`address`** `string | null` * **`country`** `string | null` * **`email`** `string | null` * **`name`** `string | null` * **`notes`** `string | null` * **`payment_methods`** `array` **Items:** - **`account_number`** `string | null` - **`bank_name`** `string | null` - **`name`** `string | null` - **`swift_code`** `string | null` - **`type`** `string` * **`phone_number`** `string | null` * **`phone_prefix`** `string | null` * **`registration_number`** `string | null` * **`vat_registration_number`** `string | null` * **`website`** `string | null` **Example:** ```json { "name": null, "registration_number": null, "vat_registration_number": null, "email": null, "address": null, "country": null, "website": null, "phone_prefix": null, "phone_number": null, "notes": null, "payment_methods": [ { "type": "", "name": null, "account_number": null, "bank_name": null, "swift_code": null, "additionalProperty": "anything" } ], "additionalProperty": "anything" } ``` ### RecipientSnapshot - **Type:** **Example:** ### CarrierSnapshot - **Type:**`object` * **`driver`** `string | null` * **`issuing_address`** `string | null` * **`name`** `string | null` * **`receipt_address`** `string | null` * **`registration_number`** `string | null` * **`vehicle_model`** `string | null` * **`vehicle_plate`** `string | null` **Example:** ```json { "name": null, "registration_number": null, "driver": null, "vehicle_model": null, "vehicle_plate": null, "issuing_address": null, "receipt_address": null, "additionalProperty": "anything" } ``` ### PaymentMethodSnapshot - **Type:**`object` * **`account_number`** `string | null` * **`bank_name`** `string | null` * **`name`** `string | null` * **`swift_code`** `string | null` * **`type`** `string` **Example:** ```json { "type": "", "name": null, "account_number": null, "bank_name": null, "swift_code": null, "additionalProperty": "anything" } ``` ### BookkeepingRecordItem - **Type:**`object` * **`description` (required)** `string | null` * **`discount` (required)** `number | null` * **`measurement` (required)** `string` * **`name` (required)** `string` * **`price` (required)** `number` * **`quantity` (required)** `number` * **`sequence_no` (required)** `integer` * **`sku` (required)** `string | null` * **`total_with_vat` (required)** `number` * **`total_with_vat_local` (required)** `number` * **`total_without_vat` (required)** `number` * **`total_without_vat_local` (required)** `number` * **`uuid` (required)** `string`, format: `uuid` * **`vat_amount` (required)** `number` * **`vat_amount_local` (required)** `number` * **`vat_percent` (required)** `number | null` * **`vat_reference_uuid` (required)** `string | null`, format: `uuid` **Example:** ```json { "uuid": "", "sequence_no": 0, "sku": null, "name": "", "description": null, "measurement": "", "quantity": 1, "discount": null, "vat_percent": null, "price": 1, "vat_reference_uuid": null, "vat_amount": 1, "total_without_vat": 1, "total_with_vat": 1, "vat_amount_local": 1, "total_without_vat_local": 1, "total_with_vat_local": 1 } ``` ### ApiErrorResponse - **Type:**`object` * **`error` (required)** `object` - **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` - **`message` (required)** `string` - **`feature`** `string`, possible values: `"documents", "sent_emails"` - **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. - **`limit`** `integer` - **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` - **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "error": { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": null, "ip_address": "" } } ``` ### ApiError - **Type:**`object` * **`code` (required)** `string`, possible values: `"invalid_api_key", "api_access_suspended", "api_key_expired", "ip_address_not_allowed", "insufficient_permissions", "public_api_subscription_required", "feature_limit_exceeded", "document_not_found", "partner_not_found", "stock_item_not_found"` * **`message` (required)** `string` * **`feature`** `string`, possible values: `"documents", "sent_emails"` * **`ip_address`** `string` — The client IP address detected by the API, returned with ip\_address\_not\_allowed. * **`limit`** `integer` * **`required_permission`** `string`, possible values: `"bookkeeping_records.list", "bookkeeping_records.ubl", "bookkeeping_records.create", "bookkeeping_records.send", "company.view", "partners.list", "partners.view", "partners.create", "partners.update", "partners.delete", "stock_items.list", "stock_items.view", "stock_items.create", "stock_items.update", "stock_items.delete"` * **`usage`** `object` - **`current` (required)** `integer` - **`requested` (required)** `integer` **Example:** ```json { "code": "invalid_api_key", "message": "", "required_permission": "bookkeeping_records.list", "feature": "documents", "limit": 1, "usage": { "current": 0, "requested": 0 }, "ip_address": "" } ``` ### FeatureUsage - **Type:**`object` * **`current` (required)** `integer` * **`requested` (required)** `integer` **Example:** ```json { "current": 0, "requested": 0 } ``` ### ValidationErrorResponse - **Type:**`object` * **`errors` (required)** `object` * **`message` (required)** `string` **Example:** ```json { "message": "", "errors": { "additionalProperty": [ "" ] } } ``` ### RateLimitErrorResponse - **Type:**`object` * **`error` (required)** `string` * **`retry_after` (required)** `integer | string` — Seconds to wait before retrying. * **`status` (required)** `integer` **Example:** ```json { "status": 429, "error": "Too many requests.", "retry_after": 1 } ```