{ "info": { "name": "blueQ API v1", "_postman_id": "b1ue0000-api0-4000-8000-6654c734ccab", "description": "Set the apiKey collection variable to your workspace key (Settings → Developer API). Start with your sandbox key (bq_test_...) so tests never touch live data. Docs: https://www.blueq.app/api/doc/v1", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://www.blueq.app/api/v1" }, { "key": "apiKey", "value": "bq_test_your_sandbox_key_here" } ], "item": [ { "name": "Getting started", "item": [ { "name": "Account", "description": "The workspace that owns the API key, its plan, API access level and rate limit.", "item": [ { "name": "Get the current workspace", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/me", "host": [ "{{baseUrl}}" ], "path": [ "me" ], "query": [], "variable": [] }, "description": "Get the current workspace. Use this to test a key. Returns the workspace, plan, access level and rate limit." } } ] } ] }, { "name": "Customers", "item": [ { "name": "Clients", "description": "Customers you invoice and sell to. Creating a client counts against the plan's client limit.", "item": [ { "name": "List clients", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/clients", "host": [ "{{baseUrl}}" ], "path": [ "clients" ], "query": [ { "key": "q", "value": "", "description": "Search name, phone or email.", "disabled": true }, { "key": "from", "value": "", "description": "Created on/after (YYYY-MM-DD).", "disabled": true }, { "key": "to", "value": "", "description": "Created on/before.", "disabled": true }, { "key": "sort", "value": "", "description": "name, -created_at (default).", "disabled": true } ], "variable": [] }, "description": "List clients." } }, { "name": "Create a client", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/clients", "host": [ "{{baseUrl}}" ], "path": [ "clients" ], "query": [], "variable": [] }, "description": "Create a client.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Akosua Boateng\",\n \"contact_person\": \"Kwame Boateng\",\n \"phone\": \"0244123456\",\n \"email\": \"akosua@example.com\",\n \"gender\": \"female\",\n \"date_of_birth\": \"1992-04-18\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a client", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/clients/:id", "host": [ "{{baseUrl}}" ], "path": [ "clients", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Clients ID." } ] }, "description": "Get a client." } }, { "name": "Update a client", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/clients/:id", "host": [ "{{baseUrl}}" ], "path": [ "clients", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Clients ID." } ] }, "description": "Update a client.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Akosua Boateng\",\n \"contact_person\": \"Kwame Boateng\",\n \"phone\": \"0244123456\",\n \"email\": \"akosua@example.com\",\n \"gender\": \"female\",\n \"date_of_birth\": \"1992-04-18\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a client", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/clients/:id", "host": [ "{{baseUrl}}" ], "path": [ "clients", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Clients ID." } ] }, "description": "Delete a client. Refused with 409 if the client has invoices." } }, { "name": "List a client's invoices", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/clients/:id/invoices", "host": [ "{{baseUrl}}" ], "path": [ "clients", ":id", "invoices" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Clients ID." } ] }, "description": "List a client's invoices." } }, { "name": "List a client's payments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/clients/:id/payments", "host": [ "{{baseUrl}}" ], "path": [ "clients", ":id", "payments" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Clients ID." } ] }, "description": "List a client's payments." } } ] }, { "name": "Suppliers", "description": "Vendors you buy stock and services from. Deleting a supplier archives it.", "item": [ { "name": "List suppliers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/suppliers", "host": [ "{{baseUrl}}" ], "path": [ "suppliers" ], "query": [ { "key": "q", "value": "", "description": "Search name, phone or email.", "disabled": true }, { "key": "sort", "value": "", "description": "name, -created_at (default).", "disabled": true } ], "variable": [] }, "description": "List suppliers." } }, { "name": "Create a supplier", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/suppliers", "host": [ "{{baseUrl}}" ], "path": [ "suppliers" ], "query": [], "variable": [] }, "description": "Create a supplier.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Accra Paper Mills\",\n \"phone\": \"0302123456\",\n \"email\": \"sales@accrapaper.com\",\n \"notes\": \"Delivers on Tuesdays.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a supplier", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/suppliers/:id", "host": [ "{{baseUrl}}" ], "path": [ "suppliers", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Suppliers ID." } ] }, "description": "Get a supplier." } }, { "name": "Update a supplier", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/suppliers/:id", "host": [ "{{baseUrl}}" ], "path": [ "suppliers", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Suppliers ID." } ] }, "description": "Update a supplier.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Accra Paper Mills\",\n \"phone\": \"0302123456\",\n \"email\": \"sales@accrapaper.com\",\n \"notes\": \"Delivers on Tuesdays.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Archive a supplier", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/suppliers/:id", "host": [ "{{baseUrl}}" ], "path": [ "suppliers", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Suppliers ID." } ] }, "description": "Archive a supplier." } } ] } ] }, { "name": "Catalogue & stock", "item": [ { "name": "Products", "description": "Catalogue items: sellable products, services, menu items and stock (inventory) items, with optional variations (sizes). Stock quantity changes go through /stock/adjustments.", "item": [ { "name": "List products", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/products", "host": [ "{{baseUrl}}" ], "path": [ "products" ], "query": [ { "key": "q", "value": "", "description": "Search name or description.", "disabled": true }, { "key": "category_id", "value": "", "description": "Filter by category.", "disabled": true }, { "key": "kind", "value": "", "description": "product, service or menu.", "disabled": true }, { "key": "sellable", "value": "", "description": "true for catalogue items, false for stock items.", "disabled": true }, { "key": "low_stock", "value": "", "description": "true to list items at or below reorder level.", "disabled": true }, { "key": "sort", "value": "", "description": "name, price, -created_at (default).", "disabled": true } ], "variable": [] }, "description": "List products." } }, { "name": "Create a product", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/products", "host": [ "{{baseUrl}}" ], "path": [ "products" ], "query": [], "variable": [] }, "description": "Create a product.", "body": { "mode": "raw", "raw": "{\n \"name\": \"A2 Flyer (glossy)\",\n \"description\": \"Full-colour, 150gsm\",\n \"price\": 2.5,\n \"category_id\": 14,\n \"sellable\": true,\n \"active\": true,\n \"unit\": \"pcs\",\n \"stock_qty\": 500,\n \"reorder_level\": 50,\n \"expiry_date\": null,\n \"supplier_id\": 57,\n \"supplier_cost\": 1.1,\n \"variations\": [\n {\n \"id\": 813,\n \"label\": \"Pack of 100\",\n \"price\": 220,\n \"stock_qty\": 20\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a product", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/products/:id", "host": [ "{{baseUrl}}" ], "path": [ "products", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Products ID." } ] }, "description": "Get a product." } }, { "name": "Update a product", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/products/:id", "host": [ "{{baseUrl}}" ], "path": [ "products", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Products ID." } ] }, "description": "Update a product. stock_qty and variations are ignored here. Use /stock/adjustments to change quantities.", "body": { "mode": "raw", "raw": "{\n \"name\": \"A2 Flyer (glossy)\",\n \"description\": \"Full-colour, 150gsm\",\n \"price\": 2.5,\n \"category_id\": 14,\n \"sellable\": true,\n \"active\": true,\n \"unit\": \"pcs\",\n \"stock_qty\": 500,\n \"reorder_level\": 50,\n \"expiry_date\": null,\n \"supplier_id\": 57,\n \"supplier_cost\": 1.1,\n \"variations\": [\n {\n \"id\": 813,\n \"label\": \"Pack of 100\",\n \"price\": 220,\n \"stock_qty\": 20\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a product", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/products/:id", "host": [ "{{baseUrl}}" ], "path": [ "products", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Products ID." } ] }, "description": "Delete a product. Deletes the item, its variations and its store links." } } ] }, { "name": "Product categories", "description": "Groups for catalogue items. Each category has a kind: product, service or menu.", "item": [ { "name": "List categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/product-categories", "host": [ "{{baseUrl}}" ], "path": [ "product-categories" ], "query": [ { "key": "q", "value": "", "description": "Search by name.", "disabled": true }, { "key": "kind", "value": "", "description": "product, service or menu.", "disabled": true } ], "variable": [] }, "description": "List categories." } }, { "name": "Create a category", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/product-categories", "host": [ "{{baseUrl}}" ], "path": [ "product-categories" ], "query": [], "variable": [] }, "description": "Create a category.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Banners\",\n \"kind\": \"product\",\n \"store_visible\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a category", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/product-categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "product-categories", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Product categories ID." } ] }, "description": "Get a category." } }, { "name": "Update a category", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/product-categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "product-categories", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Product categories ID." } ] }, "description": "Update a category.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Banners\",\n \"kind\": \"product\",\n \"store_visible\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a category", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/product-categories/:id", "host": [ "{{baseUrl}}" ], "path": [ "product-categories", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Product categories ID." } ] }, "description": "Delete a category. Refused with 409 while products are still in the category." } } ] }, { "name": "Stock", "description": "Quantities on hand for product-kind items, the stock movement history, and adjustments. Adjustments made through the API are applied immediately and recorded in the stock history as approved, with \"API\" as the requester.", "item": [ { "name": "List stock levels", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/stock", "host": [ "{{baseUrl}}" ], "path": [ "stock" ], "query": [ { "key": "q", "value": "", "description": "Search item name.", "disabled": true }, { "key": "low_stock", "value": "", "description": "true to list only items at or below reorder level.", "disabled": true }, { "key": "sellable", "value": "", "description": "true/false.", "disabled": true } ], "variable": [] }, "description": "List stock levels." } }, { "name": "List stock movements", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/stock/movements", "host": [ "{{baseUrl}}" ], "path": [ "stock", "movements" ], "query": [ { "key": "product_id", "value": "", "description": "Filter by product.", "disabled": true }, { "key": "status", "value": "", "description": "pending, approved or rejected.", "disabled": true }, { "key": "from", "value": "", "description": "On/after date.", "disabled": true }, { "key": "to", "value": "", "description": "On/before date.", "disabled": true } ], "variable": [] }, "description": "List stock movements." } }, { "name": "Adjust stock", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/stock/adjustments", "host": [ "{{baseUrl}}" ], "path": [ "stock", "adjustments" ], "query": [], "variable": [] }, "description": "Adjust stock. Subtracting more than is on hand returns 422.", "body": { "mode": "raw", "raw": "{\n \"product_id\": 812,\n \"direction\": \"add\",\n \"qty\": 100,\n \"reason\": null,\n \"note\": \"Delivery from Accra Paper Mills\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get stock for a product", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/stock/:id", "host": [ "{{baseUrl}}" ], "path": [ "stock", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Stock ID." } ] }, "description": "Get stock for a product. Includes the 20 most recent movements as \"movements\"." } } ] } ] }, { "name": "Sales & billing", "item": [ { "name": "Invoices", "description": "Quotes (proformas), invoices and receipts. A new invoice starts as a proforma; confirming it turns it into an invoice, and payments turn it into a receipt. Totals (taxes, discount) are recalculated on every change. Creating an invoice counts against the plan's monthly invoice limit.", "item": [ { "name": "List invoices", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/invoices", "host": [ "{{baseUrl}}" ], "path": [ "invoices" ], "query": [ { "key": "q", "value": "", "description": "Search number or title.", "disabled": true }, { "key": "status", "value": "", "description": "open, completed, discarded, or all (default excludes discarded).", "disabled": true }, { "key": "type", "value": "", "description": "proforma, invoice or receipt.", "disabled": true }, { "key": "client_id", "value": "", "description": "Only this client.", "disabled": true }, { "key": "from", "value": "", "description": "Invoice date on/after.", "disabled": true }, { "key": "to", "value": "", "description": "Invoice date on/before.", "disabled": true }, { "key": "sort", "value": "", "description": "date, total, number, -created_at (default).", "disabled": true } ], "variable": [] }, "description": "List invoices." } }, { "name": "Create an invoice", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/invoices", "host": [ "{{baseUrl}}" ], "path": [ "invoices" ], "query": [], "variable": [] }, "description": "Create an invoice. Pass items[] to add lines in the same call. Set \"confirm\": true to confirm it straight away.", "body": { "mode": "raw", "raw": "{\n \"title\": \"Branded T-shirts — October order\",\n \"client_id\": 2381,\n \"date\": \"2026-10-08\",\n \"due_date\": \"2026-10-22\",\n \"tax_group_id\": 1,\n \"discount_type\": \"percent\",\n \"discount_value\": 5,\n \"items\": [\n {\n \"product_id\": 57,\n \"name\": \"Round-neck T-shirt (L)\",\n \"description\": \"Navy, 2-colour print front\",\n \"qty\": 40,\n \"unit_price\": 30\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get an invoice with items and payments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/invoices/:id", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Invoices ID." } ] }, "description": "Get an invoice with items and payments." } }, { "name": "Update an invoice", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/invoices/:id", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Invoices ID." } ] }, "description": "Update an invoice. Client, title, dates, tax group and discount. Line items are locked once a payment is recorded.", "body": { "mode": "raw", "raw": "{\n \"title\": \"Branded T-shirts — October order\",\n \"client_id\": 2381,\n \"date\": \"2026-10-08\",\n \"due_date\": \"2026-10-22\",\n \"tax_group_id\": 1,\n \"discount_type\": \"percent\",\n \"discount_value\": 5,\n \"items\": [\n {\n \"product_id\": 57,\n \"name\": \"Round-neck T-shirt (L)\",\n \"description\": \"Navy, 2-colour print front\",\n \"qty\": 40,\n \"unit_price\": 30\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Discard an invoice", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/invoices/:id", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Invoices ID." } ] }, "description": "Discard an invoice. Invoices are never hard-deleted. Any invoice can be discarded with a note, and restored later.", "body": { "mode": "raw", "raw": "{\n \"note\": \"Client cancelled\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Restore a discarded invoice", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true } ], "url": { "raw": "{{baseUrl}}/invoices/:id/restore", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "restore" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Invoices ID." } ] }, "description": "Restore a discarded invoice." } }, { "name": "Confirm a proforma into an invoice", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true } ], "url": { "raw": "{{baseUrl}}/invoices/:id/confirm", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "confirm" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Invoices ID." } ] }, "description": "Confirm a proforma into an invoice." } }, { "name": "List line items", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/items", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "items" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Invoices ID." } ] }, "description": "List line items." } }, { "name": "Add a line item", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/items", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "items" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Invoices ID." } ] }, "description": "Add a line item.", "body": { "mode": "raw", "raw": "{\n \"product_id\": 57,\n \"name\": \"Round-neck T-shirt (L)\",\n \"description\": \"Navy, 2-colour print front\",\n \"qty\": 40,\n \"unit_price\": 30\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update a line item", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/items/:item_id", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "items", ":item_id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Invoices ID." }, { "key": "item_id", "value": "", "description": "Item id." } ] }, "description": "Update a line item.", "body": { "mode": "raw", "raw": "{\n \"product_id\": 57,\n \"name\": \"Round-neck T-shirt (L)\",\n \"description\": \"Navy, 2-colour print front\",\n \"qty\": 40,\n \"unit_price\": 30\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove a line item", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/items/:item_id", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "items", ":item_id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Invoices ID." }, { "key": "item_id", "value": "", "description": "Item id." } ] }, "description": "Remove a line item." } }, { "name": "List payments on the invoice", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/payments", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "payments" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Invoices ID." } ] }, "description": "List payments on the invoice." } }, { "name": "Record a payment", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/payments", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "payments" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Invoices ID." } ] }, "description": "Record a payment. Duplicate payments (same client, amount, date and mode) are refused with 409. Send an Idempotency-Key to retry safely.", "body": { "mode": "raw", "raw": "{\n \"amount\": 500,\n \"mode\": \"momo\",\n \"date\": \"2026-10-08\",\n \"remarks\": \"MoMo ref 77812\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Edit a payment", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/payments/:payment_id", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "payments", ":payment_id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Invoices ID." }, { "key": "payment_id", "value": "", "description": "Payment id." } ] }, "description": "Edit a payment.", "body": { "mode": "raw", "raw": "{\n \"amount\": 500,\n \"mode\": \"momo\",\n \"date\": \"2026-10-08\",\n \"remarks\": \"MoMo ref 77812\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a payment", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/payments/:payment_id", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "payments", ":payment_id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Invoices ID." }, { "key": "payment_id", "value": "", "description": "Payment id." } ] }, "description": "Delete a payment." } }, { "name": "Send the invoice to the client", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/send", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "send" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Invoices ID." } ] }, "description": "Send the invoice to the client. Sending enables the public share link. SMS and WhatsApp use the workspace's messaging credits.", "body": { "mode": "raw", "raw": "{\n \"channels\": [\n \"email\",\n \"whatsapp\"\n ],\n \"email_to\": [\n \"akosua@example.com\"\n ],\n \"cc\": \"accounts@kenteprints.com\",\n \"sms_to\": [],\n \"whatsapp_to\": [],\n \"message\": \"Please find your invoice below.\",\n \"attach_pdf\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Public view, PDF and receipt links", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/links", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "links" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Invoices ID." } ] }, "description": "Public view, PDF and receipt links." } }, { "name": "Get the PDF link", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/pdf", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "pdf" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Invoices ID." } ] }, "description": "Get the PDF link. Same as /links. The PDF is rendered by the public print page, so turn sharing on first if the client should open it." } }, { "name": "Turn the public link on or off", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/share", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "share" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Invoices ID." } ] }, "description": "Turn the public link on or off.", "body": { "mode": "raw", "raw": "{\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List scheduled reminders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/reminders", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "reminders" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Invoices ID." } ] }, "description": "List scheduled reminders." } }, { "name": "Schedule a reminder", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/reminders", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "reminders" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Invoices ID." } ] }, "description": "Schedule a reminder.", "body": { "mode": "raw", "raw": "{\n \"remind_at\": \"2026-10-20 09:00\",\n \"channels\": [\n \"email\",\n \"sms\"\n ],\n \"message\": \"Friendly reminder — balance due Friday.\",\n \"email_to\": [],\n \"sms_to\": [],\n \"whatsapp_to\": [],\n \"whatsapp_pdf\": false,\n \"recur\": \"monthly\",\n \"recur_until\": \"2026-12-31\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change a pending reminder", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/reminders/:reminder_id", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "reminders", ":reminder_id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Invoices ID." }, { "key": "reminder_id", "value": "", "description": "Reminder id." } ] }, "description": "Change a pending reminder.", "body": { "mode": "raw", "raw": "{\n \"remind_at\": \"2026-10-20 09:00\",\n \"channels\": [\n \"email\",\n \"sms\"\n ],\n \"message\": \"Friendly reminder — balance due Friday.\",\n \"email_to\": [],\n \"sms_to\": [],\n \"whatsapp_to\": [],\n \"whatsapp_pdf\": false,\n \"recur\": \"monthly\",\n \"recur_until\": \"2026-12-31\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel a reminder", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/reminders/:reminder_id", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "reminders", ":reminder_id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Invoices ID." }, { "key": "reminder_id", "value": "", "description": "Reminder id." } ] }, "description": "Cancel a reminder." } } ] }, { "name": "Payments", "description": "Every payment received against invoices, across the workspace. Read-only here — record, edit or delete payments through /invoices/{id}/payments so invoice balances stay in sync.", "item": [ { "name": "List payments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments", "host": [ "{{baseUrl}}" ], "path": [ "payments" ], "query": [ { "key": "q", "value": "", "description": "Search remarks or mode.", "disabled": true }, { "key": "client_id", "value": "", "description": "Only this client.", "disabled": true }, { "key": "invoice_id", "value": "", "description": "Only this invoice.", "disabled": true }, { "key": "mode", "value": "", "description": "Only this payment mode.", "disabled": true }, { "key": "from", "value": "", "description": "Payment date on/after.", "disabled": true }, { "key": "to", "value": "", "description": "Payment date on/before.", "disabled": true }, { "key": "sort", "value": "", "description": "date, amount, -created_at (default).", "disabled": true } ], "variable": [] }, "description": "List payments." } }, { "name": "Get a payment", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/:id", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Payments ID." } ] }, "description": "Get a payment." } } ] }, { "name": "Sales", "description": "Counter and walk-in sales recorded outside of invoices (multi-item carts with optional payments, discount and taxes). Creating a sale counts against the plan's monthly sales limit.", "item": [ { "name": "List sales", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sales", "host": [ "{{baseUrl}}" ], "path": [ "sales" ], "query": [ { "key": "q", "value": "", "description": "Search customer, product summary or remarks.", "disabled": true }, { "key": "status", "value": "", "description": "paid, partial or unpaid.", "disabled": true }, { "key": "client_id", "value": "", "description": "Only this client.", "disabled": true }, { "key": "from", "value": "", "description": "Sale date on/after.", "disabled": true }, { "key": "to", "value": "", "description": "Sale date on/before.", "disabled": true }, { "key": "sort", "value": "", "description": "date, total, -created_at (default).", "disabled": true } ], "variable": [] }, "description": "List sales." } }, { "name": "Record a sale", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sales", "host": [ "{{baseUrl}}" ], "path": [ "sales" ], "query": [], "variable": [] }, "description": "Record a sale.", "body": { "mode": "raw", "raw": "{\n \"date\": \"2026-10-08\",\n \"client_id\": 2381,\n \"customer\": \"Walk-in\",\n \"items\": [\n {\n \"product_id\": 57,\n \"name\": \"Lamination A3\",\n \"category\": \"Counter / walk-in sales\",\n \"qty\": 2,\n \"unit_price\": 125\n }\n ],\n \"payments\": [\n {\n \"amount\": 250,\n \"mode\": \"cash\",\n \"date\": \"2026-10-08\",\n \"reference\": \"\"\n }\n ],\n \"discount_type\": \"amount\",\n \"discount_value\": 0,\n \"tax_group_id\": null,\n \"remarks\": \"Paid at the counter\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a sale with items and payments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sales/:id", "host": [ "{{baseUrl}}" ], "path": [ "sales", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Sales ID." } ] }, "description": "Get a sale with items and payments." } }, { "name": "Update a sale", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sales/:id", "host": [ "{{baseUrl}}" ], "path": [ "sales", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Sales ID." } ] }, "description": "Update a sale. Fields you omit are kept. Passing items or payments replaces the whole list.", "body": { "mode": "raw", "raw": "{\n \"date\": \"2026-10-08\",\n \"client_id\": 2381,\n \"customer\": \"Walk-in\",\n \"items\": [\n {\n \"product_id\": 57,\n \"name\": \"Lamination A3\",\n \"category\": \"Counter / walk-in sales\",\n \"qty\": 2,\n \"unit_price\": 125\n }\n ],\n \"payments\": [\n {\n \"amount\": 250,\n \"mode\": \"cash\",\n \"date\": \"2026-10-08\",\n \"reference\": \"\"\n }\n ],\n \"discount_type\": \"amount\",\n \"discount_value\": 0,\n \"tax_group_id\": null,\n \"remarks\": \"Paid at the counter\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a sale", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sales/:id", "host": [ "{{baseUrl}}" ], "path": [ "sales", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Sales ID." } ] }, "description": "Delete a sale." } }, { "name": "Add a payment to a sale", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sales/:id/payments", "host": [ "{{baseUrl}}" ], "path": [ "sales", ":id", "payments" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Sales ID." } ] }, "description": "Add a payment to a sale.", "body": { "mode": "raw", "raw": "{\n \"amount\": 250,\n \"mode\": \"cash\",\n \"date\": \"2026-10-08\",\n \"reference\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Generate an invoice from the sale", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true } ], "url": { "raw": "{{baseUrl}}/sales/:id/invoice", "host": [ "{{baseUrl}}" ], "path": [ "sales", ":id", "invoice" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Sales ID." } ] }, "description": "Generate an invoice from the sale. Returns the existing invoice if one was already generated." } } ] }, { "name": "Expenditure", "description": "Business expenses with line items, supplier, and payments. Lines whose expense type is set to add stock (or that reference a stock product) update inventory automatically, exactly as in the app. Creating an expense counts against the plan's monthly expenditure limit.", "item": [ { "name": "List expenses", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/expenditure", "host": [ "{{baseUrl}}" ], "path": [ "expenditure" ], "query": [ { "key": "q", "value": "", "description": "Search payee, category or remarks.", "disabled": true }, { "key": "status", "value": "", "description": "paid, partial or unpaid.", "disabled": true }, { "key": "supplier_id", "value": "", "description": "Only this supplier.", "disabled": true }, { "key": "from", "value": "", "description": "Expense date on/after.", "disabled": true }, { "key": "to", "value": "", "description": "Expense date on/before.", "disabled": true }, { "key": "sort", "value": "", "description": "date, total, -created_at (default).", "disabled": true } ], "variable": [] }, "description": "List expenses." } }, { "name": "Record an expense", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/expenditure", "host": [ "{{baseUrl}}" ], "path": [ "expenditure" ], "query": [], "variable": [] }, "description": "Record an expense.", "body": { "mode": "raw", "raw": "{\n \"date\": \"2026-10-07\",\n \"payee\": \"Accra Paper Mills\",\n \"supplier_id\": 14,\n \"supplier_invoice\": \"APM-55120\",\n \"linked_invoice_id\": null,\n \"items\": [\n {\n \"product_id\": 61,\n \"name\": \"A4 paper 80gsm (box)\",\n \"category\": \"Raw materials\",\n \"qty\": 10,\n \"unit\": \"box\",\n \"unit_price\": 145,\n \"remarks\": \"\",\n \"expiry_date\": null\n }\n ],\n \"payments\": [\n {\n \"amount\": 1450,\n \"mode\": \"momo\",\n \"date\": \"2026-10-07\",\n \"reference\": \"MOMO-99812\",\n \"remarks\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get an expense with lines and payments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/expenditure/:id", "host": [ "{{baseUrl}}" ], "path": [ "expenditure", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Expenditure ID." } ] }, "description": "Get an expense with lines and payments." } }, { "name": "Update an expense", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/expenditure/:id", "host": [ "{{baseUrl}}" ], "path": [ "expenditure", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Expenditure ID." } ] }, "description": "Update an expense. Omitted fields are kept. Passing items or payments replaces the whole list; stock is re-balanced.", "body": { "mode": "raw", "raw": "{\n \"date\": \"2026-10-07\",\n \"payee\": \"Accra Paper Mills\",\n \"supplier_id\": 14,\n \"supplier_invoice\": \"APM-55120\",\n \"linked_invoice_id\": null,\n \"items\": [\n {\n \"product_id\": 61,\n \"name\": \"A4 paper 80gsm (box)\",\n \"category\": \"Raw materials\",\n \"qty\": 10,\n \"unit\": \"box\",\n \"unit_price\": 145,\n \"remarks\": \"\",\n \"expiry_date\": null\n }\n ],\n \"payments\": [\n {\n \"amount\": 1450,\n \"mode\": \"momo\",\n \"date\": \"2026-10-07\",\n \"reference\": \"MOMO-99812\",\n \"remarks\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete an expense", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/expenditure/:id", "host": [ "{{baseUrl}}" ], "path": [ "expenditure", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Expenditure ID." } ] }, "description": "Delete an expense. Stock added by the expense is reversed." } }, { "name": "Add a payment to an expense", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/expenditure/:id/payments", "host": [ "{{baseUrl}}" ], "path": [ "expenditure", ":id", "payments" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Expenditure ID." } ] }, "description": "Add a payment to an expense.", "body": { "mode": "raw", "raw": "{\n \"amount\": 1450,\n \"mode\": \"momo\",\n \"date\": \"2026-10-07\",\n \"reference\": \"MOMO-99812\",\n \"remarks\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Operations", "item": [ { "name": "Orders (production)", "description": "Production orders created from invoices. Each invoice line becomes a job; each job holds one or more orders that move through pending → in_progress → completed (or cancelled). Orders can carry processes (e.g. \"Design\", \"Print\", \"Laminate\") that are ticked off as work progresses.", "item": [ { "name": "List orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/orders", "host": [ "{{baseUrl}}" ], "path": [ "orders" ], "query": [ { "key": "status", "value": "", "description": "pending, in_progress, completed or cancelled.", "disabled": true }, { "key": "invoice_id", "value": "", "description": "Only orders from this invoice.", "disabled": true }, { "key": "job_id", "value": "", "description": "Only orders in this job.", "disabled": true }, { "key": "assigned_to", "value": "", "description": "Only orders assigned to this user.", "disabled": true }, { "key": "q", "value": "", "description": "Search title or remarks.", "disabled": true }, { "key": "from", "value": "", "description": "Created on/after.", "disabled": true }, { "key": "to", "value": "", "description": "Created on/before.", "disabled": true }, { "key": "sort", "value": "", "description": "start_at, end_at, -created_at (default).", "disabled": true } ], "variable": [] }, "description": "List orders." } }, { "name": "Create an order inside a job", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/orders", "host": [ "{{baseUrl}}" ], "path": [ "orders" ], "query": [], "variable": [] }, "description": "Create an order inside a job.", "body": { "mode": "raw", "raw": "{\n \"job_id\": 388,\n \"title\": \"Round-neck T-shirt (L) — navy\",\n \"product_id\": 57,\n \"qty\": 40,\n \"assigned_to\": 77,\n \"start_at\": \"2026-10-09 08:00\",\n \"end_at\": \"2026-10-10 17:00\",\n \"remarks\": \"Use Pantone 2945C\",\n \"processes\": [\n []\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List jobs (invoice line groups)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/orders/jobs", "host": [ "{{baseUrl}}" ], "path": [ "orders", "jobs" ], "query": [ { "key": "invoice_id", "value": "", "description": "Only jobs from this invoice.", "disabled": true } ], "variable": [] }, "description": "List jobs (invoice line groups)." } }, { "name": "Create jobs and orders from an invoice", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/orders/from-invoice", "host": [ "{{baseUrl}}" ], "path": [ "orders", "from-invoice" ], "query": [], "variable": [] }, "description": "Create jobs and orders from an invoice. One job is created per line item. Requires the invoice to be eligible for production (confirmed / paid per your settings).", "body": { "mode": "raw", "raw": "{\n \"invoice_id\": \"66f1c2a9e4b1d\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get an order with its processes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/orders/:id", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Orders (production) ID." } ] }, "description": "Get an order with its processes." } }, { "name": "Update a pending order", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/orders/:id", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Orders (production) ID." } ] }, "description": "Update a pending order.", "body": { "mode": "raw", "raw": "{\n \"job_id\": 388,\n \"title\": \"Round-neck T-shirt (L) — navy\",\n \"product_id\": 57,\n \"qty\": 40,\n \"assigned_to\": 77,\n \"start_at\": \"2026-10-09 08:00\",\n \"end_at\": \"2026-10-10 17:00\",\n \"remarks\": \"Use Pantone 2945C\",\n \"processes\": [\n []\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a pending order", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/orders/:id", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Orders (production) ID." } ] }, "description": "Delete a pending order." } }, { "name": "Start work on an order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true } ], "url": { "raw": "{{baseUrl}}/orders/:id/commence", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":id", "commence" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Orders (production) ID." } ] }, "description": "Start work on an order." } }, { "name": "Complete an order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/orders/:id/complete", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":id", "complete" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Orders (production) ID." } ] }, "description": "Complete an order. Refused with 409 while processes are open unless \"force\": true.", "body": { "mode": "raw", "raw": "{\n \"force\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel an order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true } ], "url": { "raw": "{{baseUrl}}/orders/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":id", "cancel" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Orders (production) ID." } ] }, "description": "Cancel an order." } }, { "name": "Add processes", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/orders/:id/processes", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":id", "processes" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Orders (production) ID." } ] }, "description": "Add processes.", "body": { "mode": "raw", "raw": "{\n \"names\": [\n \"Design\",\n \"Print\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Tick off a process", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true } ], "url": { "raw": "{{baseUrl}}/orders/:id/processes/:process_id/complete", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":id", "processes", ":process_id", "complete" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Orders (production) ID." }, { "key": "process_id", "value": "", "description": "Process id." } ] }, "description": "Tick off a process. The order must be in progress." } }, { "name": "Remove an open process", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/orders/:id/processes/:process_id", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":id", "processes", ":process_id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Orders (production) ID." }, { "key": "process_id", "value": "", "description": "Process id." } ] }, "description": "Remove an open process." } } ] }, { "name": "Recipes", "description": "Recipes (bill of materials) for food and production businesses: ingredients drawn from Cost-of-Sale stock items, optional base recipes, yield, and live cost. Available when the Recipes feature is enabled for the business type. Sizes/variations and cost add-ons are managed in the app and returned read-only.", "item": [ { "name": "List recipes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/recipes", "host": [ "{{baseUrl}}" ], "path": [ "recipes" ], "query": [ { "key": "q", "value": "", "description": "Search name.", "disabled": true }, { "key": "sort", "value": "", "description": "name (default), -created_at.", "disabled": true } ], "variable": [] }, "description": "List recipes." } }, { "name": "Create a recipe", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/recipes", "host": [ "{{baseUrl}}" ], "path": [ "recipes" ], "query": [], "variable": [] }, "description": "Create a recipe.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Jollof rice (party pack)\",\n \"notes\": \"Parboil rice 10 min before adding stew.\",\n \"yield_qty\": 10,\n \"yield_unit\": \"portion\",\n \"ingredients\": [\n {\n \"product_id\": 61,\n \"name\": \"Water\",\n \"qty\": 2.5,\n \"unit\": \"kg\"\n }\n ],\n \"bases\": [\n {\n \"recipe_id\": 12,\n \"variation_id\": 0,\n \"qty\": 1,\n \"unit\": \"portion\"\n }\n ],\n \"publish_to_menu\": false,\n \"menu_price\": 35,\n \"menu_category_id\": 3\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a recipe with ingredients and cost", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/recipes/:id", "host": [ "{{baseUrl}}" ], "path": [ "recipes", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Recipes ID." } ] }, "description": "Get a recipe with ingredients and cost." } }, { "name": "Get the current cost of a recipe", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/recipes/:id/cost", "host": [ "{{baseUrl}}" ], "path": [ "recipes", ":id", "cost" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Recipes ID." } ] }, "description": "Get the current cost of a recipe. Batch cost, cost per unit and the cost of each size, priced from current stock costs." } }, { "name": "Update a recipe", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/recipes/:id", "host": [ "{{baseUrl}}" ], "path": [ "recipes", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Recipes ID." } ] }, "description": "Update a recipe. Passing ingredients or bases replaces that list. Sizes and cost add-ons are not changed.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Jollof rice (party pack)\",\n \"notes\": \"Parboil rice 10 min before adding stew.\",\n \"yield_qty\": 10,\n \"yield_unit\": \"portion\",\n \"ingredients\": [\n {\n \"product_id\": 61,\n \"name\": \"Water\",\n \"qty\": 2.5,\n \"unit\": \"kg\"\n }\n ],\n \"bases\": [\n {\n \"recipe_id\": 12,\n \"variation_id\": 0,\n \"qty\": 1,\n \"unit\": \"portion\"\n }\n ],\n \"publish_to_menu\": false,\n \"menu_price\": 35,\n \"menu_category_id\": 3\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a recipe", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/recipes/:id", "host": [ "{{baseUrl}}" ], "path": [ "recipes", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Recipes ID." } ] }, "description": "Delete a recipe. Also removes its sizes and any menu-item variations linked to it." } } ] } ] }, { "name": "Settings", "item": [ { "name": "Taxes", "description": "Tax rates (levies and VAT). Levies are charged on the taxable amount; VAT is charged on the taxable amount plus levies. Group rates into tax groups to apply them to invoices and sales.", "item": [ { "name": "List taxes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/taxes", "host": [ "{{baseUrl}}" ], "path": [ "taxes" ], "query": [], "variable": [] }, "description": "List taxes." } }, { "name": "Create a tax", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/taxes", "host": [ "{{baseUrl}}" ], "path": [ "taxes" ], "query": [], "variable": [] }, "description": "Create a tax.", "body": { "mode": "raw", "raw": "{\n \"name\": \"VAT\",\n \"rate\": 15,\n \"type\": \"vat\",\n \"sort\": 40,\n \"active\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a tax", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/taxes/:id", "host": [ "{{baseUrl}}" ], "path": [ "taxes", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Taxes ID." } ] }, "description": "Get a tax." } }, { "name": "Update a tax", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/taxes/:id", "host": [ "{{baseUrl}}" ], "path": [ "taxes", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Taxes ID." } ] }, "description": "Update a tax. Invoices already confirmed keep the rates they were issued with.", "body": { "mode": "raw", "raw": "{\n \"name\": \"VAT\",\n \"rate\": 15,\n \"type\": \"vat\",\n \"sort\": 40,\n \"active\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a tax", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/taxes/:id", "host": [ "{{baseUrl}}" ], "path": [ "taxes", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Taxes ID." } ] }, "description": "Delete a tax. Also removes the tax from every tax group." } } ] }, { "name": "Tax groups", "description": "Named sets of taxes (called \"tax instances\" in the app), e.g. \"Standard VAT + levies\" or \"VAT exempt\". One group is the default for new invoices and sales.", "item": [ { "name": "List tax groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/tax-groups", "host": [ "{{baseUrl}}" ], "path": [ "tax-groups" ], "query": [], "variable": [] }, "description": "List tax groups." } }, { "name": "Create a tax group", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/tax-groups", "host": [ "{{baseUrl}}" ], "path": [ "tax-groups" ], "query": [], "variable": [] }, "description": "Create a tax group.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Standard (VAT + levies)\",\n \"is_default\": true,\n \"active\": true,\n \"sort\": 0,\n \"tax_ids\": [\n 28,\n 29,\n 30,\n 31\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a tax group", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/tax-groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "tax-groups", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Tax groups ID." } ] }, "description": "Get a tax group." } }, { "name": "Update a tax group", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/tax-groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "tax-groups", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Tax groups ID." } ] }, "description": "Update a tax group.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Standard (VAT + levies)\",\n \"is_default\": true,\n \"active\": true,\n \"sort\": 0,\n \"tax_ids\": [\n 28,\n 29,\n 30,\n 31\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a tax group", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/tax-groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "tax-groups", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Tax groups ID." } ] }, "description": "Delete a tax group. The default group cannot be deleted (409)." } } ] }, { "name": "Branches", "description": "Shop locations. Every workspace has at least one branch; one is the default. Creating a branch counts against the plan's branch limit.", "item": [ { "name": "List branches", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/branches", "host": [ "{{baseUrl}}" ], "path": [ "branches" ], "query": [], "variable": [] }, "description": "List branches." } }, { "name": "Create a branch", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/branches", "host": [ "{{baseUrl}}" ], "path": [ "branches" ], "query": [], "variable": [] }, "description": "Create a branch.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Kumasi Mall\",\n \"code\": \"KSI\",\n \"phone\": \"0322000111\",\n \"email\": \"kumasi@kenteprints.com\",\n \"address\": \"Shop 14, Kumasi City Mall\",\n \"town\": \"Kumasi\",\n \"is_default\": false,\n \"active\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a branch", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/branches/:id", "host": [ "{{baseUrl}}" ], "path": [ "branches", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Branches ID." } ] }, "description": "Get a branch." } }, { "name": "Update a branch", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/branches/:id", "host": [ "{{baseUrl}}" ], "path": [ "branches", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Branches ID." } ] }, "description": "Update a branch.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Kumasi Mall\",\n \"code\": \"KSI\",\n \"phone\": \"0322000111\",\n \"email\": \"kumasi@kenteprints.com\",\n \"address\": \"Shop 14, Kumasi City Mall\",\n \"town\": \"Kumasi\",\n \"is_default\": false,\n \"active\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a branch", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/branches/:id", "host": [ "{{baseUrl}}" ], "path": [ "branches", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Branches ID." } ] }, "description": "Delete a branch. If the default branch is deleted another becomes the default. The last branch is recreated automatically." } } ] }, { "name": "Users (team)", "description": "Team members with access to the workspace. New users are always invited by email and set their own password; passwords are never accepted or returned by the API. The workspace owner cannot be changed or removed here.", "item": [ { "name": "List team members", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users", "host": [ "{{baseUrl}}" ], "path": [ "users" ], "query": [ { "key": "q", "value": "", "description": "Search name, email or phone.", "disabled": true }, { "key": "role", "value": "", "description": "Only this role.", "disabled": true } ], "variable": [] }, "description": "List team members." } }, { "name": "Invite a team member", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users", "host": [ "{{baseUrl}}" ], "path": [ "users" ], "query": [], "variable": [] }, "description": "Invite a team member. Sends an invitation email. \"invite_sent\" in the response is false if the email could not be delivered (the user is still created).", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"Esi\",\n \"last_name\": \"Mensah\",\n \"email\": \"esi@kenteprints.com\",\n \"phone\": \"0201234567\",\n \"role\": \"manager\",\n \"branch_id\": 1,\n \"active\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a team member", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Users (team) ID." } ] }, "description": "Get a team member." } }, { "name": "Update a team member", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Users (team) ID." } ] }, "description": "Update a team member.", "body": { "mode": "raw", "raw": "{\n \"first_name\": \"Esi\",\n \"last_name\": \"Mensah\",\n \"email\": \"esi@kenteprints.com\",\n \"phone\": \"0201234567\",\n \"role\": \"manager\",\n \"branch_id\": 1,\n \"active\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove a team member", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Users (team) ID." } ] }, "description": "Remove a team member." } } ] }, { "name": "Roles & privileges", "description": "Roles decide what each team member can do. Every module has four privileges: view, add, update, delete. Built-in roles can be narrowed (except super_admin); custom roles can be created and deleted.", "item": [ { "name": "List roles with privileges", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/roles", "host": [ "{{baseUrl}}" ], "path": [ "roles" ], "query": [], "variable": [] }, "description": "List roles with privileges." } }, { "name": "Create a custom role", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/roles", "host": [ "{{baseUrl}}" ], "path": [ "roles" ], "query": [], "variable": [] }, "description": "Create a custom role.", "body": { "mode": "raw", "raw": "{\n \"label\": \"Front desk\",\n \"summary\": \"Clients, invoices and POS only.\",\n \"privileges\": {\n \"invoices\": {\n \"view\": true,\n \"add\": true,\n \"update\": true,\n \"delete\": false\n }\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List modules that privileges apply to", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/roles/modules", "host": [ "{{baseUrl}}" ], "path": [ "roles", "modules" ], "query": [], "variable": [] }, "description": "List modules that privileges apply to." } }, { "name": "Get a role", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/roles/:key", "host": [ "{{baseUrl}}" ], "path": [ "roles", ":key" ], "query": [], "variable": [ { "key": "key", "value": "", "description": "Key." } ] }, "description": "Get a role." } }, { "name": "Change a role's privileges", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/roles/:key", "host": [ "{{baseUrl}}" ], "path": [ "roles", ":key" ], "query": [], "variable": [ { "key": "key", "value": "", "description": "Key." } ] }, "description": "Change a role's privileges.", "body": { "mode": "raw", "raw": "{\n \"privileges\": {\n \"reports\": {\n \"view\": true\n }\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a custom role", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/roles/:key", "host": [ "{{baseUrl}}" ], "path": [ "roles", ":key" ], "query": [], "variable": [ { "key": "key", "value": "", "description": "Key." } ] }, "description": "Delete a custom role. Refused with 409 while users still have the role." } } ] } ] }, { "name": "Commerce", "item": [ { "name": "Online stores", "description": "Public online stores (storefronts) and which catalogue products each one sells. Payment gateway secrets are never returned. Deleting a store takes it offline; orders are kept.", "item": [ { "name": "List stores", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/stores", "host": [ "{{baseUrl}}" ], "path": [ "stores" ], "query": [], "variable": [] }, "description": "List stores." } }, { "name": "Create a store", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/stores", "host": [ "{{baseUrl}}" ], "path": [ "stores" ], "query": [], "variable": [] }, "description": "Create a store. The first store automatically lists every sellable product.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Kente Prints Shop\",\n \"description\": \"Custom T-shirts, banners and souvenirs.\",\n \"phone\": \"0244000111\",\n \"email\": \"shop@kenteprints.com\",\n \"slug\": \"kente-prints\",\n \"template\": \"classic\",\n \"active\": true,\n \"settings\": {\n \"checkout_payment\": \"paystack\",\n \"pickup_enabled\": true,\n \"delivery_enabled\": true,\n \"send_receipt\": true,\n \"tax_group_id\": null\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a store", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/stores/:id", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Online stores ID." } ] }, "description": "Get a store." } }, { "name": "Update a store", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/stores/:id", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Online stores ID." } ] }, "description": "Update a store.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Kente Prints Shop\",\n \"description\": \"Custom T-shirts, banners and souvenirs.\",\n \"phone\": \"0244000111\",\n \"email\": \"shop@kenteprints.com\",\n \"slug\": \"kente-prints\",\n \"template\": \"classic\",\n \"active\": true,\n \"settings\": {\n \"checkout_payment\": \"paystack\",\n \"pickup_enabled\": true,\n \"delivery_enabled\": true,\n \"send_receipt\": true,\n \"tax_group_id\": null\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Take a store offline", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/stores/:id", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Online stores ID." } ] }, "description": "Take a store offline." } }, { "name": "List products in a store", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/stores/:id/products", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":id", "products" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Online stores ID." } ] }, "description": "List products in a store." } }, { "name": "Add products to a store", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/stores/:id/products", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":id", "products" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Online stores ID." } ] }, "description": "Add products to a store.", "body": { "mode": "raw", "raw": "{\n \"product_ids\": [\n 57,\n 58\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove a product from a store", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/stores/:id/products/:product_id", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":id", "products", ":product_id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Online stores ID." }, { "key": "product_id", "value": "", "description": "Product id." } ] }, "description": "Remove a product from a store." } } ] }, { "name": "Store & walk-in orders", "description": "Orders placed on online stores (channel \"online\") and at the POS till (channel \"walkin\"). Orders are created by customers at checkout or by cashiers at the till; the API reads them and marks paid orders as picked up / delivered.", "item": [ { "name": "List orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/store-orders", "host": [ "{{baseUrl}}" ], "path": [ "store-orders" ], "query": [ { "key": "store_id", "value": "", "description": "Only this store.", "disabled": true }, { "key": "status", "value": "", "description": "pending, paid, failed or open (paid, not picked up).", "disabled": true }, { "key": "channel", "value": "", "description": "online or walkin.", "disabled": true }, { "key": "payment_mode", "value": "", "description": "Paystack, Cash, Mobile Money, Card, Place order.", "disabled": true }, { "key": "q", "value": "", "description": "Search number, receipt, customer or reference.", "disabled": true }, { "key": "from", "value": "", "description": "Order date on/after.", "disabled": true }, { "key": "to", "value": "", "description": "Order date on/before.", "disabled": true } ], "variable": [] }, "description": "List orders." } }, { "name": "Get an order with items", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/store-orders/:id", "host": [ "{{baseUrl}}" ], "path": [ "store-orders", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Store & walk-in orders ID." } ] }, "description": "Get an order with items." } }, { "name": "Mark picked up / delivered", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/store-orders/:id/picked-up", "host": [ "{{baseUrl}}" ], "path": [ "store-orders", ":id", "picked-up" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Store & walk-in orders ID." } ] }, "description": "Mark picked up / delivered. Only paid orders can be marked.", "body": { "mode": "raw", "raw": "{\n \"picked_up\": true\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Delivery zones", "description": "Delivery fees for online stores. Each zone has a price and the towns it covers; at checkout the cheapest zone covering the customer's town is used.", "item": [ { "name": "List delivery zones", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/delivery-zones", "host": [ "{{baseUrl}}" ], "path": [ "delivery-zones" ], "query": [ { "key": "store_id", "value": "", "description": "Only this store.", "disabled": true } ], "variable": [] }, "description": "List delivery zones." } }, { "name": "Create a zone", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/delivery-zones", "host": [ "{{baseUrl}}" ], "path": [ "delivery-zones" ], "query": [], "variable": [] }, "description": "Create a zone.", "body": { "mode": "raw", "raw": "{\n \"store_id\": 2,\n \"name\": \"Accra East\",\n \"price\": 25,\n \"towns\": [\n \"East Legon\",\n \"Madina\",\n \"Adenta\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a zone", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/delivery-zones/:id", "host": [ "{{baseUrl}}" ], "path": [ "delivery-zones", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Delivery zones ID." } ] }, "description": "Get a zone." } }, { "name": "Update a zone", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/delivery-zones/:id", "host": [ "{{baseUrl}}" ], "path": [ "delivery-zones", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Delivery zones ID." } ] }, "description": "Update a zone. Passing towns replaces the list.", "body": { "mode": "raw", "raw": "{\n \"store_id\": 2,\n \"name\": \"Accra East\",\n \"price\": 25,\n \"towns\": [\n \"East Legon\",\n \"Madina\",\n \"Adenta\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a zone", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/delivery-zones/:id", "host": [ "{{baseUrl}}" ], "path": [ "delivery-zones", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Delivery zones ID." } ] }, "description": "Delete a zone." } } ] }, { "name": "Store customer accounts", "description": "Shopper accounts created on your online stores. Customers register themselves at checkout; the API can list, correct and remove accounts. Passwords are never exposed.", "item": [ { "name": "List customer accounts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/store-accounts", "host": [ "{{baseUrl}}" ], "path": [ "store-accounts" ], "query": [ { "key": "q", "value": "", "description": "Search email, name or phone.", "disabled": true }, { "key": "from", "value": "", "description": "Registered on/after.", "disabled": true }, { "key": "to", "value": "", "description": "Registered on/before.", "disabled": true } ], "variable": [] }, "description": "List customer accounts." } }, { "name": "Get a customer account", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/store-accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "store-accounts", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Store customer accounts ID." } ] }, "description": "Get a customer account." } }, { "name": "Update name or phone", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/store-accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "store-accounts", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Store customer accounts ID." } ] }, "description": "Update name or phone.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Yaw Asante\",\n \"phone\": \"0244111222\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a customer account", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/store-accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "store-accounts", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Store customer accounts ID." } ] }, "description": "Delete a customer account. Past orders are kept." } } ] }, { "name": "POS (point of sale)", "description": "The walk-in till: register settings, cashier sessions (\"accounts\") that are opened, closed and reviewed, and walk-in sales. Sales are recorded against the cashier's open session, deduct stock, and share order numbers with the linked online store. Paystack payments need the customer present at the till and are not available through the API.", "item": [ { "name": "Get the till register", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pos/register", "host": [ "{{baseUrl}}" ], "path": [ "pos", "register" ], "query": [], "variable": [] }, "description": "Get the till register." } }, { "name": "Create or update the till register", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pos/register", "host": [ "{{baseUrl}}" ], "path": [ "pos", "register" ], "query": [], "variable": [] }, "description": "Create or update the till register.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Front counter\",\n \"phone\": \"0302000111\",\n \"email\": \"counter@kenteprints.com\",\n \"address\": \"Osu, Oxford St.\",\n \"active\": true,\n \"store_id\": 2,\n \"tax_group_id\": 0\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List cashier sessions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pos/sessions", "host": [ "{{baseUrl}}" ], "path": [ "pos", "sessions" ], "query": [ { "key": "status", "value": "", "description": "open, pending, approved or rejected.", "disabled": true }, { "key": "cashier_id", "value": "", "description": "Only this cashier.", "disabled": true } ], "variable": [] }, "description": "List cashier sessions." } }, { "name": "Open a cashier session", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pos/sessions", "host": [ "{{baseUrl}}" ], "path": [ "pos", "sessions" ], "query": [], "variable": [] }, "description": "Open a cashier session.", "body": { "mode": "raw", "raw": "{\n \"cashier_id\": 77\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a session with its sales", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pos/sessions/:id", "host": [ "{{baseUrl}}" ], "path": [ "pos", "sessions", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "POS (point of sale) ID." } ] }, "description": "Get a session with its sales." } }, { "name": "Close a session for review", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true } ], "url": { "raw": "{{baseUrl}}/pos/sessions/:id/close", "host": [ "{{baseUrl}}" ], "path": [ "pos", "sessions", ":id", "close" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "POS (point of sale) ID." } ] }, "description": "Close a session for review." } }, { "name": "Approve or reject a closed session", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pos/sessions/:id/review", "host": [ "{{baseUrl}}" ], "path": [ "pos", "sessions", ":id", "review" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "POS (point of sale) ID." } ] }, "description": "Approve or reject a closed session.", "body": { "mode": "raw", "raw": "{\n \"decision\": \"approved\",\n \"note\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Record a walk-in sale", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/pos/sales", "host": [ "{{baseUrl}}" ], "path": [ "pos", "sales" ], "query": [], "variable": [] }, "description": "Record a walk-in sale. Fails with 422 if the cashier has no open session, the register is inactive, or stock is insufficient. Send an Idempotency-Key so a retried request never charges twice.", "body": { "mode": "raw", "raw": "{\n \"cashier_id\": 77,\n \"items\": [\n {\n \"product_id\": 57,\n \"qty\": 2\n }\n ],\n \"payment_mode\": \"Cash\",\n \"customer_name\": \"Walk-in\",\n \"customer_phone\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Reports", "item": [ { "name": "Reports", "description": "The same datasets as the Reports area and scheduled report e-mails: run any built-in report with filters, read its summary and chart series, and manage saved custom reports (several datasets with chosen columns). Rows come back both as raw arrays (matching `columns`) and as keyed objects; money columns are numbers.", "item": [ { "name": "List available reports and their filters", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports", "host": [ "{{baseUrl}}" ], "path": [ "reports" ], "query": [], "variable": [] }, "description": "List available reports and their filters." } }, { "name": "List saved custom reports", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/custom", "host": [ "{{baseUrl}}" ], "path": [ "reports", "custom" ], "query": [], "variable": [] }, "description": "List saved custom reports." } }, { "name": "Save a custom report", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/custom", "host": [ "{{baseUrl}}" ], "path": [ "reports", "custom" ], "query": [], "variable": [] }, "description": "Save a custom report.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Monthly cash view\",\n \"sections\": [\n {\n \"source\": \"payments\",\n \"columns\": [\n \"Date\",\n \"Client\",\n \"Amount (GHS)\"\n ],\n \"filters\": {\n \"payment_type\": \"credit\"\n },\n \"chart\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a custom report definition", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/custom/:id", "host": [ "{{baseUrl}}" ], "path": [ "reports", "custom", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Reports ID." } ] }, "description": "Get a custom report definition." } }, { "name": "Update a custom report", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/custom/:id", "host": [ "{{baseUrl}}" ], "path": [ "reports", "custom", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Reports ID." } ] }, "description": "Update a custom report.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Monthly cash view\",\n \"sections\": [\n {\n \"source\": \"payments\",\n \"columns\": [\n \"Date\",\n \"Client\",\n \"Amount (GHS)\"\n ],\n \"filters\": {\n \"payment_type\": \"credit\"\n },\n \"chart\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a custom report", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/custom/:id", "host": [ "{{baseUrl}}" ], "path": [ "reports", "custom", ":id" ], "query": [], "variable": [ { "key": "id", "value": "", "description": "Reports ID." } ] }, "description": "Delete a custom report." } }, { "name": "Run a custom report", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/custom/:id/run", "host": [ "{{baseUrl}}" ], "path": [ "reports", "custom", ":id", "run" ], "query": [ { "key": "from", "value": "", "description": "Start date (YYYY-MM-DD).", "disabled": true }, { "key": "to", "value": "", "description": "End date (YYYY-MM-DD).", "disabled": true }, { "key": "limit", "value": "", "description": "Max rows, 1-5000 (default 1500).", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Reports ID." } ] }, "description": "Run a custom report. Returns one result block (same shape as a built-in report) per section." } }, { "name": "Run a custom report (POST)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}", "disabled": true } ], "url": { "raw": "{{baseUrl}}/reports/custom/:id/run", "host": [ "{{baseUrl}}" ], "path": [ "reports", "custom", ":id", "run" ], "query": [ { "key": "from", "value": "", "description": "Start date (YYYY-MM-DD).", "disabled": true }, { "key": "to", "value": "", "description": "End date (YYYY-MM-DD).", "disabled": true }, { "key": "limit", "value": "", "description": "Max rows, 1-5000 (default 1500).", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "Reports ID." } ] }, "description": "Run a custom report (POST). Same as the GET form, for clients that prefer POST. Allowed on read-only keys." } }, { "name": "Run a built-in report", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/:source", "host": [ "{{baseUrl}}" ], "path": [ "reports", ":source" ], "query": [ { "key": "from", "value": "", "description": "Start date (YYYY-MM-DD).", "disabled": true }, { "key": "to", "value": "", "description": "End date (YYYY-MM-DD).", "disabled": true }, { "key": "limit", "value": "", "description": "Max rows, 1-5000 (default 1500).", "disabled": true } ], "variable": [ { "key": "source", "value": "", "description": "Source." } ] }, "description": "Run a built-in report." } }, { "name": "Chart series for a report", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reports/:source/charts", "host": [ "{{baseUrl}}" ], "path": [ "reports", ":source", "charts" ], "query": [ { "key": "from", "value": "", "description": "Start date.", "disabled": true }, { "key": "to", "value": "", "description": "End date.", "disabled": true } ], "variable": [ { "key": "source", "value": "", "description": "Source." } ] }, "description": "Chart series for a report. Each chart has a title, type (bar, line, pie, doughnut) and labels/series ready for any chart library." } } ] } ] } ] }