{"openapi":"3.1.0","info":{"title":"Omnizone API","version":"v1","description":"Public REST API for Omnizone workspaces. Authenticate with an org API key (`Authorization: Bearer ozk_live_…`).\n\nBase URL is versioned (`/v1`). Breaking changes ship as `/v2`.\n\nList endpoints return `{ data, meta: { limit, offset, total } }`. Errors return `{ error: { code, message, request_id } }`.\n\nAccess follows the workspace subscription: Starter covers books; Growth adds inventory, HR, CRM, and operations; Business raises rate limits and key caps.\n\nThis surface does not include the in-app cookie API, platform admin, NAV migration, or jurisdiction working papers."},"servers":[{"url":"https://api.omnizone.app","description":"Omnizone API"}],"paths":{"/v1/me":{"get":{"operationId":"get_me","tags":["Current key"],"summary":"GET Current key","description":"Workspace and plan for the API key making the request. Requires the starter plan (or higher) and the api_keys permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25}},{"name":"offset","in":"query","schema":{"type":"integer","default":0}},{"name":"q","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"}},"/v1/clients":{"get":{"operationId":"get_clients","tags":["Clients"],"summary":"GET Clients","description":"Customer directory. Requires the growth plan (or higher) and the clients permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25}},{"name":"offset","in":"query","schema":{"type":"integer","default":0}},{"name":"q","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"growth"},"post":{"operationId":"post_clients","tags":["Clients"],"summary":"POST Clients","description":"Customer directory. Requires the growth plan (or higher) and the clients permission.","security":[{"bearerAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"phones":{"type":"string"},"contact":{"type":"string"},"address":{"type":"string"},"currency_code":{"type":"string"},"payment_terms_code":{"type":"string"},"notes":{"type":"string"},"active":{"type":"boolean"}},"required":["name"]}}}},"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"growth"}},"/v1/clients/{id}":{"get":{"operationId":"get_clients_item","tags":["Clients"],"summary":"GET Clients by id","description":"Customer directory. Requires the growth plan (or higher) and the clients permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"growth"},"patch":{"operationId":"patch_clients_item","tags":["Clients"],"summary":"PATCH Clients by id","description":"Customer directory. Requires the growth plan (or higher) and the clients permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"phones":{"type":"string"},"contact":{"type":"string"},"address":{"type":"string"},"currency_code":{"type":"string"},"payment_terms_code":{"type":"string"},"notes":{"type":"string"},"active":{"type":"boolean"}},"required":["name"]}}}},"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"growth"}},"/v1/invoices":{"get":{"operationId":"get_invoices","tags":["Invoices"],"summary":"GET Invoices","description":"Sales invoices. Requires the starter plan (or higher) and the invoices permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25}},{"name":"offset","in":"query","schema":{"type":"integer","default":0}},{"name":"q","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"}},"/v1/invoices/{id}":{"get":{"operationId":"get_invoices_item","tags":["Invoices"],"summary":"GET Invoices by id","description":"Sales invoices. Requires the starter plan (or higher) and the invoices permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"}},"/v1/invoices/{id}/payments":{"get":{"operationId":"get_invoices_item","tags":["Invoices"],"summary":"List payments on an invoice.","description":"Sales invoices. Requires the starter plan (or higher) and the invoices permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"},"post":{"operationId":"post_invoices_item","tags":["Invoices"],"summary":"Record a payment on an invoice.","description":"Sales invoices. Requires the starter plan (or higher) and the invoices permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Record id"},"number":{"type":"string","description":"Document number shown to the customer."},"status":{"type":"string"},"date":{"type":"string"},"due_date":{"type":"string"},"client_id":{"type":"string","nullable":true},"client_name":{"type":"string"},"currency_code":{"type":"string"},"amount_excl_vat_cents":{"type":"integer","description":"Amount excluding VAT, in minor units."},"vat_amount_cents":{"type":"integer","description":"VAT in minor units."},"amount_incl_vat_cents":{"type":"integer","description":"Amount including VAT, in minor units."},"remaining_cents":{"type":"integer","description":"Open balance in document currency, minor units."},"notes":{"type":"string"}},"required":["id","number","status","date"]}}}},"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"}},"/v1/quotes":{"get":{"operationId":"get_quotes","tags":["Quotes"],"summary":"GET Quotes","description":"Sales quotes. Requires the starter plan (or higher) and the quotes permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25}},{"name":"offset","in":"query","schema":{"type":"integer","default":0}},{"name":"q","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"}},"/v1/quotes/{id}":{"get":{"operationId":"get_quotes_item","tags":["Quotes"],"summary":"GET Quotes by id","description":"Sales quotes. Requires the starter plan (or higher) and the quotes permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"}},"/v1/credit-notes":{"get":{"operationId":"get_credit_notes","tags":["Credit notes"],"summary":"GET Credit notes","description":"Customer credit notes. Requires the starter plan (or higher) and the receivables permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25}},{"name":"offset","in":"query","schema":{"type":"integer","default":0}},{"name":"q","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"}},"/v1/credit-notes/{id}":{"get":{"operationId":"get_credit_notes_item","tags":["Credit notes"],"summary":"GET Credit notes by id","description":"Customer credit notes. Requires the starter plan (or higher) and the receivables permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"}},"/v1/vendors":{"get":{"operationId":"get_vendors","tags":["Vendors"],"summary":"GET Vendors","description":"Supplier directory. Requires the starter plan (or higher) and the payables permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25}},{"name":"offset","in":"query","schema":{"type":"integer","default":0}},{"name":"q","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"},"post":{"operationId":"post_vendors","tags":["Vendors"],"summary":"POST Vendors","description":"Supplier directory. Requires the starter plan (or higher) and the payables permission.","security":[{"bearerAuth":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"currency_code":{"type":"string"},"notes":{"type":"string"}},"required":["name"]}}}},"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"}},"/v1/vendors/{id}":{"get":{"operationId":"get_vendors_item","tags":["Vendors"],"summary":"GET Vendors by id","description":"Supplier directory. Requires the starter plan (or higher) and the payables permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"},"patch":{"operationId":"patch_vendors_item","tags":["Vendors"],"summary":"PATCH Vendors by id","description":"Supplier directory. Requires the starter plan (or higher) and the payables permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"currency_code":{"type":"string"},"notes":{"type":"string"}},"required":["name"]}}}},"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"}},"/v1/bills":{"get":{"operationId":"get_bills","tags":["Bills"],"summary":"GET Bills","description":"Vendor bills. Requires the starter plan (or higher) and the payables permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25}},{"name":"offset","in":"query","schema":{"type":"integer","default":0}},{"name":"q","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"}},"/v1/bills/{id}":{"get":{"operationId":"get_bills_item","tags":["Bills"],"summary":"GET Bills by id","description":"Vendor bills. Requires the starter plan (or higher) and the payables permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"}},"/v1/bills/{id}/payments":{"get":{"operationId":"get_bills_item","tags":["Bills"],"summary":"List payments on a bill.","description":"Vendor bills. Requires the starter plan (or higher) and the payables permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"},"post":{"operationId":"post_bills_item","tags":["Bills"],"summary":"Record a payment on a bill.","description":"Vendor bills. Requires the starter plan (or higher) and the payables permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Record id"},"number":{"type":"string"},"date":{"type":"string"},"due_date":{"type":"string"},"vendor_id":{"type":"string","nullable":true},"vendor_name":{"type":"string"},"currency_code":{"type":"string"},"amount_incl_vat_cents":{"type":"integer","description":"Bill total including VAT, minor units."},"remaining_cents":{"type":"integer","description":"Open balance in document currency, minor units."},"status":{"type":"string"}},"required":["id"]}}}},"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"}},"/v1/items":{"get":{"operationId":"get_items","tags":["Items"],"summary":"GET Items","description":"Item catalog. Requires the starter plan (or higher) and the items permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25}},{"name":"offset","in":"query","schema":{"type":"integer","default":0}},{"name":"q","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"}},"/v1/items/{id}":{"get":{"operationId":"get_items_item","tags":["Items"],"summary":"GET Items by id","description":"Item catalog. Requires the starter plan (or higher) and the items permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"}},"/v1/accounts":{"get":{"operationId":"get_accounts","tags":["Chart of accounts"],"summary":"GET Chart of accounts","description":"General ledger accounts (read). Requires the starter plan (or higher) and the accounting permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25}},{"name":"offset","in":"query","schema":{"type":"integer","default":0}},{"name":"q","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"}},"/v1/accounts/{id}":{"get":{"operationId":"get_accounts_item","tags":["Chart of accounts"],"summary":"GET Chart of accounts by id","description":"General ledger accounts (read). Requires the starter plan (or higher) and the accounting permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"}},"/v1/journals":{"get":{"operationId":"get_journals","tags":["Journals"],"summary":"GET Journals","description":"Posted journal entries (read). Requires the starter plan (or higher) and the accounting permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25}},{"name":"offset","in":"query","schema":{"type":"integer","default":0}},{"name":"q","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"}},"/v1/journals/{id}":{"get":{"operationId":"get_journals_item","tags":["Journals"],"summary":"GET Journals by id","description":"Posted journal entries (read). Requires the starter plan (or higher) and the accounting permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"}},"/v1/bank-accounts":{"get":{"operationId":"get_bank_accounts","tags":["Bank accounts"],"summary":"GET Bank accounts","description":"Workspace bank accounts (read). Requires the starter plan (or higher) and the accounting permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25}},{"name":"offset","in":"query","schema":{"type":"integer","default":0}},{"name":"q","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"}},"/v1/bank-accounts/{id}":{"get":{"operationId":"get_bank_accounts_item","tags":["Bank accounts"],"summary":"GET Bank accounts by id","description":"Workspace bank accounts (read). Requires the starter plan (or higher) and the accounting permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"}},"/v1/currencies":{"get":{"operationId":"get_currencies","tags":["Currencies"],"summary":"GET Currencies","description":"Enabled workspace currencies (read). Requires the starter plan (or higher) and the accounting permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25}},{"name":"offset","in":"query","schema":{"type":"integer","default":0}},{"name":"q","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"}},"/v1/exchange-rates":{"get":{"operationId":"get_exchange_rates","tags":["Exchange rates"],"summary":"GET Exchange rates","description":"Effective-dated FX rates (read). Rate is LCY per 1 foreign unit × 10,000. Requires the starter plan (or higher) and the accounting permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25}},{"name":"offset","in":"query","schema":{"type":"integer","default":0}},{"name":"q","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"starter"}},"/v1/warehouses":{"get":{"operationId":"get_warehouses","tags":["Warehouses"],"summary":"GET Warehouses","description":"Inventory locations. Requires the growth plan (or higher) and the inventory permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25}},{"name":"offset","in":"query","schema":{"type":"integer","default":0}},{"name":"q","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"growth"}},"/v1/warehouses/{id}":{"get":{"operationId":"get_warehouses_item","tags":["Warehouses"],"summary":"GET Warehouses by id","description":"Inventory locations. Requires the growth plan (or higher) and the inventory permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"growth"}},"/v1/inventory/on-hand":{"get":{"operationId":"get_inventory_on_hand","tags":["Inventory on hand"],"summary":"GET Inventory on hand","description":"Stock on hand by item and location. Requires the growth plan (or higher) and the inventory permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25}},{"name":"offset","in":"query","schema":{"type":"integer","default":0}},{"name":"q","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"growth"}},"/v1/inventory/adjustments":{"get":{"operationId":"get_inventory_adjustments","tags":["Inventory adjustments"],"summary":"GET Inventory adjustments","description":"Stock adjustments. Requires the growth plan (or higher) and the inventory permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25}},{"name":"offset","in":"query","schema":{"type":"integer","default":0}},{"name":"q","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"growth"}},"/v1/inventory/adjustments/{id}":{"get":{"operationId":"get_inventory_adjustments_item","tags":["Inventory adjustments"],"summary":"GET Inventory adjustments by id","description":"Stock adjustments. Requires the growth plan (or higher) and the inventory permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"growth"}},"/v1/inventory/transfers":{"get":{"operationId":"get_inventory_transfers","tags":["Inventory transfers"],"summary":"GET Inventory transfers","description":"Stock transfers between locations. Requires the growth plan (or higher) and the inventory permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25}},{"name":"offset","in":"query","schema":{"type":"integer","default":0}},{"name":"q","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"growth"}},"/v1/inventory/transfers/{id}":{"get":{"operationId":"get_inventory_transfers_item","tags":["Inventory transfers"],"summary":"GET Inventory transfers by id","description":"Stock transfers between locations. Requires the growth plan (or higher) and the inventory permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"growth"}},"/v1/employees":{"get":{"operationId":"get_employees","tags":["Employees"],"summary":"GET Employees","description":"Employee directory. Requires the growth plan (or higher) and the employees permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25}},{"name":"offset","in":"query","schema":{"type":"integer","default":0}},{"name":"q","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"growth"}},"/v1/employees/{id}":{"get":{"operationId":"get_employees_item","tags":["Employees"],"summary":"GET Employees by id","description":"Employee directory. Requires the growth plan (or higher) and the employees permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"growth"}},"/v1/leave":{"get":{"operationId":"get_leave","tags":["Leave"],"summary":"GET Leave","description":"Leave requests. Requires the growth plan (or higher) and the leave permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25}},{"name":"offset","in":"query","schema":{"type":"integer","default":0}},{"name":"q","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"growth"}},"/v1/leave/{id}":{"get":{"operationId":"get_leave_item","tags":["Leave"],"summary":"GET Leave by id","description":"Leave requests. Requires the growth plan (or higher) and the leave permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"growth"}},"/v1/attendance":{"get":{"operationId":"get_attendance","tags":["Attendance"],"summary":"GET Attendance","description":"Attendance punches. Requires the growth plan (or higher) and the attendance permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25}},{"name":"offset","in":"query","schema":{"type":"integer","default":0}},{"name":"q","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"growth"}},"/v1/holidays":{"get":{"operationId":"get_holidays","tags":["Holidays"],"summary":"GET Holidays","description":"Public holidays. Requires the growth plan (or higher) and the holidays permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25}},{"name":"offset","in":"query","schema":{"type":"integer","default":0}},{"name":"q","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"growth"}},"/v1/payroll":{"get":{"operationId":"get_payroll","tags":["Payroll runs"],"summary":"GET Payroll runs","description":"Pay runs (not statutory working papers). Requires the growth plan (or higher) and the payroll permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25}},{"name":"offset","in":"query","schema":{"type":"integer","default":0}},{"name":"q","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"growth"}},"/v1/payroll/{id}":{"get":{"operationId":"get_payroll_item","tags":["Payroll runs"],"summary":"GET Payroll runs by id","description":"Pay runs (not statutory working papers). Requires the growth plan (or higher) and the payroll permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"growth"}},"/v1/leads":{"get":{"operationId":"get_leads","tags":["Leads"],"summary":"GET Leads","description":"Sales leads. Requires the growth plan (or higher) and the leads permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25}},{"name":"offset","in":"query","schema":{"type":"integer","default":0}},{"name":"q","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"growth"}},"/v1/leads/{id}":{"get":{"operationId":"get_leads_item","tags":["Leads"],"summary":"GET Leads by id","description":"Sales leads. Requires the growth plan (or higher) and the leads permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"growth"}},"/v1/tasks":{"get":{"operationId":"get_tasks","tags":["Tasks"],"summary":"GET Tasks","description":"Workspace tasks. Requires the growth plan (or higher) and the tasks permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25}},{"name":"offset","in":"query","schema":{"type":"integer","default":0}},{"name":"q","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"growth"}},"/v1/tasks/{id}":{"get":{"operationId":"get_tasks_item","tags":["Tasks"],"summary":"GET Tasks by id","description":"Workspace tasks. Requires the growth plan (or higher) and the tasks permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"growth"}},"/v1/calendar/events":{"get":{"operationId":"get_calendar","tags":["Calendar events"],"summary":"GET Calendar events","description":"Meetings and calendar events (not Google sync). Requires the growth plan (or higher) and the calendar permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":25}},{"name":"offset","in":"query","schema":{"type":"integer","default":0}},{"name":"q","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"growth"}},"/v1/calendar/events/{id}":{"get":{"operationId":"get_calendar_item","tags":["Calendar events"],"summary":"GET Calendar events by id","description":"Meetings and calendar events (not Google sync). Requires the growth plan (or higher) and the calendar permission.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Missing or invalid API key"},"403":{"description":"Forbidden or plan required"},"404":{"description":"Not found"},"429":{"description":"Rate limited"}},"x-min-plan":"growth"}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API key","description":"Org API key created in Settings → API keys."}}},"tags":[{"name":"Current key","description":"Workspace and plan for the API key making the request."},{"name":"Clients","description":"Customer directory."},{"name":"Invoices","description":"Sales invoices."},{"name":"Quotes","description":"Sales quotes."},{"name":"Credit notes","description":"Customer credit notes."},{"name":"Vendors","description":"Supplier directory."},{"name":"Bills","description":"Vendor bills."},{"name":"Items","description":"Item catalog."},{"name":"Chart of accounts","description":"General ledger accounts (read)."},{"name":"Journals","description":"Posted journal entries (read)."},{"name":"Bank accounts","description":"Workspace bank accounts (read)."},{"name":"Currencies","description":"Enabled workspace currencies (read)."},{"name":"Exchange rates","description":"Effective-dated FX rates (read). Rate is LCY per 1 foreign unit × 10,000."},{"name":"Warehouses","description":"Inventory locations."},{"name":"Inventory on hand","description":"Stock on hand by item and location."},{"name":"Inventory adjustments","description":"Stock adjustments."},{"name":"Inventory transfers","description":"Stock transfers between locations."},{"name":"Employees","description":"Employee directory."},{"name":"Leave","description":"Leave requests."},{"name":"Attendance","description":"Attendance punches."},{"name":"Holidays","description":"Public holidays."},{"name":"Payroll runs","description":"Pay runs (not statutory working papers)."},{"name":"Leads","description":"Sales leads."},{"name":"Tasks","description":"Workspace tasks."},{"name":"Calendar events","description":"Meetings and calendar events (not Google sync)."}]}