{ "info": { "name": "Alya Books e-Invoicing API 1.0.0", "description": "Generated from the OpenAPI document. Set the variables baseUrl (your API base, e.g. https://.supabase.co/functions/v1/api-v1) and apiKey (a test key while integrating).", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "baseUrl", "value": "https://api.alyabooks.ai/api/v1" }, { "key": "apiKey", "value": "fw_test_" } ], "item": [ { "name": "Start here: ERP integration", "description": "The requests an ERP integration begins with. Use a test key (fw_test_…): its invoices never reach the live service provider.", "item": [ { "name": "Who am I (key and organisation)", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/me", "host": [ "{{baseUrl}}" ], "path": [ "me" ], "variable": [] } } }, { "name": "Dry run: freight invoice (JSON)", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/invoices/validate", "host": [ "{{baseUrl}}" ], "path": [ "invoices", "validate" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"buyer\": {\n \"name\": \"Desert Rose Trading LLC\",\n \"trn\": \"100765432100003\",\n \"email\": \"ap@desertrose.example\",\n \"address\": {\n \"street\": \"Corniche Road 5\",\n \"city\": \"Abu Dhabi\",\n \"emirate\": \"AUH\",\n \"country\": \"AE\"\n }\n },\n \"issueDate\": \"2027-01-12\",\n \"currency\": \"AED\",\n \"payment\": {\n \"termsDays\": 30\n },\n \"metadata\": {\n \"job\": \"S00123456\",\n \"house_bill\": \"DXBSHA2701234\",\n \"branch\": \"DXB\"\n },\n \"notes\": \"Job S00123456, house bill DXBSHA2701234\",\n \"items\": [\n {\n \"description\": \"Ocean freight DXB to SHA\",\n \"quantity\": 1,\n \"unitPrice\": 12000,\n \"taxCategory\": \"zero_rated\",\n \"itemType\": \"S\",\n \"serviceAccountingCode\": \"996521\"\n },\n {\n \"description\": \"Terminal handling, Jebel Ali\",\n \"quantity\": 1,\n \"unitPrice\": 1800,\n \"taxCategory\": \"standard\",\n \"itemType\": \"S\",\n \"serviceAccountingCode\": \"996751\"\n },\n {\n \"description\": \"Customs duty paid on your behalf\",\n \"quantity\": 1,\n \"unitPrice\": 3250,\n \"taxCategory\": \"out_of_scope\",\n \"itemType\": \"S\",\n \"serviceAccountingCode\": \"996799\"\n }\n ],\n \"submit\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Dry run: CargoWise UniversalTransaction", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/xml", "type": "text" } ], "url": { "raw": "{{baseUrl}}/invoices/validate?connector=cargowise", "host": [ "{{baseUrl}}" ], "path": [ "invoices", "validate" ], "variable": [], "query": [ { "key": "connector", "value": "cargowise" } ] }, "body": { "mode": "raw", "raw": "\n\n
\n BLUEHARBORDXB\n EINVOICING\n
\n \n \n \n \n \n AccountingInvoiceINV-2027-00412\n \n DXBBlue Harbor Logistics LLC\n \n INV\n INV-2027-00412\n 2027-01-12T00:00:00\n 2027-02-11T00:00:00\n DXBDubai\n S00123456\n DXBSHA2701234\n FOBFree On Board\n AEDUAE Dirham\n 7f3c2c1e-9a0b-4c4d-8e1f-0a1b2c3d4e5f\n \n \n DESROSE\n Desert Rose Trading LLC\n 100765432100003\n CN-7654321\n ap@desertrose.example\n
\n Corniche Road 5\n Abu Dhabi\n AUH\n AEUnited Arab Emirates\n
\n \n \n \n FRT\n Ocean freight DXB to SHA, 1x40HC\n 1\n 12000.00\n Z\n \n \n THC\n Terminal handling, Jebel Ali\n 1\n 1800.00\n S\n \n \n DUTY\n Customs duty paid on your behalf\n 1\n 3250.00\n O\n \n \n \n \n\n", "options": { "raw": { "language": "xml" } } } } }, { "name": "ERP intake: CargoWise message (HTTP Basic, as eAdaptor)", "request": { "method": "POST", "auth": { "type": "basic", "basic": [ { "key": "username", "value": "eadaptor", "type": "string" }, { "key": "password", "value": "{{apiKey}}", "type": "string" } ] }, "header": [ { "key": "Content-Type", "value": "application/xml", "type": "text" } ], "url": { "raw": "{{baseUrl}}/erp/cargowise/messages", "host": [ "{{baseUrl}}" ], "path": [ "erp", "cargowise", "messages" ] }, "body": { "mode": "raw", "raw": "\n\n
\n BLUEHARBORDXB\n EINVOICING\n
\n \n \n \n \n \n AccountingInvoiceINV-2027-00412\n \n DXBBlue Harbor Logistics LLC\n \n INV\n INV-2027-00412\n 2027-01-12T00:00:00\n 2027-02-11T00:00:00\n DXBDubai\n S00123456\n DXBSHA2701234\n FOBFree On Board\n AEDUAE Dirham\n 7f3c2c1e-9a0b-4c4d-8e1f-0a1b2c3d4e5f\n \n \n DESROSE\n Desert Rose Trading LLC\n 100765432100003\n CN-7654321\n ap@desertrose.example\n
\n Corniche Road 5\n Abu Dhabi\n AUH\n AEUnited Arab Emirates\n
\n \n \n \n FRT\n Ocean freight DXB to SHA, 1x40HC\n 1\n 12000.00\n Z\n \n \n THC\n Terminal handling, Jebel Ali\n 1\n 1800.00\n S\n \n \n DUTY\n Customs duty paid on your behalf\n 1\n 3250.00\n O\n \n \n \n \n\n", "options": { "raw": { "language": "xml" } } } } }, { "name": "ERP message log: failed", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/erp/messages?status=failed", "host": [ "{{baseUrl}}" ], "path": [ "erp", "messages" ], "query": [ { "key": "status", "value": "failed" } ] } } } ] }, { "name": "Invoices", "item": [ { "name": "Create invoices (batch)", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/invoices", "host": [ "{{baseUrl}}" ], "path": [ "invoices" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"invoices\": [\n {\n \"buyer\": null,\n \"items\": null\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates one or more tax invoices, credit notes or debit notes. Returns 202 with one result per input when every invoice was created. When any element fails, the response status mirrors the first failure and extra.results lists the outcome of every element; invoices with success=true HAVE been created." } }, { "name": "List invoices", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/invoices?page=&perPage=&sort=&order=&keyword=&invoiceNumber=&status=&paymentStatus=&documentKind=&buyerId=&projectId=&recurringInvoiceId=&startIssueDate=&endIssueDate=&startDate=&endDate=&includeArchived=&isTest=&externalId=", "host": [ "{{baseUrl}}" ], "path": [ "invoices" ], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "perPage", "value": "", "disabled": true }, { "key": "sort", "value": "", "disabled": true }, { "key": "order", "value": "", "disabled": true }, { "key": "keyword", "value": "", "disabled": true }, { "key": "invoiceNumber", "value": "", "disabled": true }, { "key": "status", "value": "", "disabled": true }, { "key": "paymentStatus", "value": "", "disabled": true }, { "key": "documentKind", "value": "", "disabled": true }, { "key": "buyerId", "value": "", "disabled": true }, { "key": "projectId", "value": "", "disabled": true }, { "key": "recurringInvoiceId", "value": "", "disabled": true }, { "key": "startIssueDate", "value": "", "disabled": true }, { "key": "endIssueDate", "value": "", "disabled": true }, { "key": "startDate", "value": "", "disabled": true }, { "key": "endDate", "value": "", "disabled": true }, { "key": "includeArchived", "value": "", "disabled": true }, { "key": "isTest", "value": "", "disabled": true }, { "key": "externalId", "value": "", "disabled": true } ], "variable": [] } } }, { "name": "Retrieve an invoice (JSON, PDF, XML or HTML)", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/invoices/:id?format=&language=", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id" ], "query": [ { "key": "format", "value": "", "disabled": true }, { "key": "language", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Use ?format=pdf|xml|html or an Accept header of application/pdf or application/xml to download the rendered document or the PINT AE UBL XML." } }, { "name": "Replace a draft invoice", "request": { "method": "PUT", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/invoices/:id", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"buyer\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"\",\n \"trn\": \"\"\n },\n \"items\": [\n {\n \"description\": null,\n \"quantity\": null,\n \"unitPrice\": null\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update housekeeping fields (category, cost centre, project, supply emirate, archive, custom fields)", "request": { "method": "PATCH", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/invoices/:id", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"categoryId\": \"00000000-0000-0000-0000-000000000000\",\n \"costCentreId\": \"00000000-0000-0000-0000-000000000000\",\n \"projectId\": \"00000000-0000-0000-0000-000000000000\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a draft invoice", "request": { "method": "DELETE", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/invoices/:id", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "List document designs", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/design-templates", "host": [ "{{baseUrl}}" ], "path": [ "design-templates" ], "variable": [] }, "description": "The organisation's PDF designs (Settings → Documents → Document designs) with their layout: standard, or logistics with a shipment panel. Pass an id as designTemplateId on an invoice, or on an ERP connector so its invoices use it; without one the default design applies." } }, { "name": "Get a short-lived download link to the invoice file", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/download-link?format=&language=", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "download-link" ], "query": [ { "key": "format", "value": "", "disabled": true }, { "key": "language", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Stores the invoice as a PDF (default), PINT AE XML or printable HTML and returns a signed link that works for 15 minutes without an API key. Use it to hand the file to a browser or to an AI assistant that cannot take binary responses; anyone with the link can download the file until it expires." } }, { "name": "Get post-processing status (ASP/FTA, delivery, validation)", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "status" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Get the PINT AE validation report", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/validation", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "validation" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Dry run: map and validate an invoice without creating it", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/invoices/validate?connector=", "host": [ "{{baseUrl}}" ], "path": [ "invoices", "validate" ], "query": [ { "key": "connector", "value": "", "disabled": true } ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"buyer\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"\",\n \"trn\": \"\"\n },\n \"items\": [\n {\n \"description\": null,\n \"quantity\": null,\n \"unitPrice\": null\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Send an InvoiceInput as JSON, or an ERP message with ?connector=cargowise and its content type, and get the PINT AE report plus a preview of the mapped invoice. Nothing is stored and no number is consumed. Answers 200 when valid, 422 when not." } }, { "name": "Run validation and mark the invoice as validated", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/validate", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "validate" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Submit the invoice to the ASP (Taxilla) for FTA reporting", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/submit", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "submit" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Send the invoice by email", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/send", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "send" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"to\": null\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List invoice lines and allowances", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/items", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "items" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "List payments recorded on the invoice", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/payments", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "payments" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Record a payment", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/payments", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "payments" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 0\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Invoice number", "item": [ { "name": "Get the next available invoice number", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/invoices/next-number?series=&date=", "host": [ "{{baseUrl}}" ], "path": [ "invoices", "next-number" ], "query": [ { "key": "series", "value": "", "disabled": true }, { "key": "date", "value": "", "disabled": true } ], "variable": [] } } }, { "name": "Verify whether an invoice number is available", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/invoices/verify-number?value=&series=", "host": [ "{{baseUrl}}" ], "path": [ "invoices", "verify-number" ], "query": [ { "key": "value", "value": "", "disabled": false }, { "key": "series", "value": "", "disabled": true } ], "variable": [] } } }, { "name": "Get number series settings", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/settings/invoice-number-template", "host": [ "{{baseUrl}}" ], "path": [ "settings", "invoice-number-template" ], "variable": [] } } }, { "name": "Update a number series", "request": { "method": "PUT", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/settings/invoice-number-template", "host": [ "{{baseUrl}}" ], "path": [ "settings", "invoice-number-template" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"series\": \"\",\n \"template\": \"\",\n \"padLength\": 0\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Recurring invoices", "item": [ { "name": "Turn an invoice into a recurring template (draft)", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/make-recurring", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "make-recurring" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"schedule\": {\n \"frequency\": \"weekly\",\n \"startDate\": \"2026-09-23\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List recurring invoices", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/recurring-invoices?page=&perPage=&sort=&order=&status=&buyerId=&projectId=&keyword=", "host": [ "{{baseUrl}}" ], "path": [ "recurring-invoices" ], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "perPage", "value": "", "disabled": true }, { "key": "sort", "value": "", "disabled": true }, { "key": "order", "value": "", "disabled": true }, { "key": "status", "value": "", "disabled": true }, { "key": "buyerId", "value": "", "disabled": true }, { "key": "projectId", "value": "", "disabled": true }, { "key": "keyword", "value": "", "disabled": true } ], "variable": [] } } }, { "name": "Create a recurring invoice", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/recurring-invoices", "host": [ "{{baseUrl}}" ], "path": [ "recurring-invoices" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"buyer\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"\",\n \"trn\": \"\"\n },\n \"items\": [\n {\n \"description\": null,\n \"quantity\": null,\n \"unitPrice\": null\n }\n ],\n \"schedule\": {\n \"frequency\": \"weekly\",\n \"startDate\": \"2026-09-23\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Same content as an invoice (buyer, items, texts) plus a schedule and automation flags. Created as draft unless status is active." } }, { "name": "Get a recurring invoice", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/recurring-invoices/:id", "host": [ "{{baseUrl}}" ], "path": [ "recurring-invoices", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Update a recurring invoice (items replace the lines)", "request": { "method": "PATCH", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/recurring-invoices/:id", "host": [ "{{baseUrl}}" ], "path": [ "recurring-invoices", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"buyer\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"\",\n \"trn\": \"\"\n },\n \"items\": [\n {\n \"description\": null,\n \"quantity\": null,\n \"unitPrice\": null\n }\n ],\n \"schedule\": {\n \"frequency\": \"weekly\",\n \"startDate\": \"2026-09-23\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a recurring invoice (generated invoices are kept)", "request": { "method": "DELETE", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/recurring-invoices/:id", "host": [ "{{baseUrl}}" ], "path": [ "recurring-invoices", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Activate (or resume) the schedule", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/recurring-invoices/:id/activate", "host": [ "{{baseUrl}}" ], "path": [ "recurring-invoices", ":id", "activate" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Pause the schedule", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/recurring-invoices/:id/pause", "host": [ "{{baseUrl}}" ], "path": [ "recurring-invoices", ":id", "pause" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Cancel the schedule permanently", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/recurring-invoices/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "recurring-invoices", ":id", "cancel" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Generate the invoice now", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/recurring-invoices/:id/run", "host": [ "{{baseUrl}}" ], "path": [ "recurring-invoices", ":id", "run" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"date\": \"2026-09-23\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates the invoice for today (or body.date) through the same path as POST /invoices, records a run and advances the schedule. 422 when generation failed (details in the run)." } }, { "name": "List runs (generated invoices and failures)", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/recurring-invoices/:id/runs?page=&perPage=", "host": [ "{{baseUrl}}" ], "path": [ "recurring-invoices", ":id", "runs" ], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "perPage", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Preview upcoming dates, billed periods and the next payload", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/recurring-invoices/:id/preview?count=", "host": [ "{{baseUrl}}" ], "path": [ "recurring-invoices", ":id", "preview" ], "query": [ { "key": "count", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "" } ] } } } ] }, { "name": "Incoming invoices", "item": [ { "name": "List simulation scenarios and sample suppliers", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/incoming/simulate", "host": [ "{{baseUrl}}" ], "path": [ "incoming", "simulate" ], "variable": [] } } }, { "name": "Simulate received Peppol invoices (Test mode only)", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/incoming/simulate", "host": [ "{{baseUrl}}" ], "path": [ "incoming", "simulate" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"scenario\": \"standard\",\n \"supplier\": \"office\",\n \"contactId\": \"00000000-0000-0000-0000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Only while the organization's e-invoicing connection is in Test (simulated) mode (409 otherwise). Generates PINT AE supplier invoices for the chosen scenario and runs them through the same receiving pipeline as a real Peppol delivery: validation, duplicate checks, notifications and webhooks. Scenarios: standard, with_pdf, mixed_vat, reverse_charge, credit_note, foreign_currency, wrong_buyer, totals_mismatch, duplicate." } }, { "name": "Import a received invoice (UBL XML, PDF or image)", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/import/incoming", "host": [ "{{baseUrl}}" ], "path": [ "import", "incoming" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"filename\": \"\",\n \"mime\": \"\",\n \"xml\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Send multipart/form-data with a \"file\" field, raw application/xml or application/pdf, or JSON with xml / base64. Returns 202 when the document was recorded, 422 when it failed validation (the import is still logged)." } }, { "name": "List imports", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/import/incoming?page=&perPage=&sort=&order=&status=&channel=&keyword=&startDate=&endDate=", "host": [ "{{baseUrl}}" ], "path": [ "import", "incoming" ], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "perPage", "value": "", "disabled": true }, { "key": "sort", "value": "", "disabled": true }, { "key": "order", "value": "", "disabled": true }, { "key": "status", "value": "", "disabled": true }, { "key": "channel", "value": "", "disabled": true }, { "key": "keyword", "value": "", "disabled": true }, { "key": "startDate", "value": "", "disabled": true }, { "key": "endDate", "value": "", "disabled": true } ], "variable": [] } } }, { "name": "List incoming invoices", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/incoming?page=&perPage=&status=&paymentStatus=&supplierId=&keyword=&startIssueDate=&endIssueDate=&includeArchived=", "host": [ "{{baseUrl}}" ], "path": [ "incoming" ], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "perPage", "value": "", "disabled": true }, { "key": "status", "value": "", "disabled": true }, { "key": "paymentStatus", "value": "", "disabled": true }, { "key": "supplierId", "value": "", "disabled": true }, { "key": "keyword", "value": "", "disabled": true }, { "key": "startIssueDate", "value": "", "disabled": true }, { "key": "endIssueDate", "value": "", "disabled": true }, { "key": "includeArchived", "value": "", "disabled": true } ], "variable": [] } } }, { "name": "Get an import", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/import/incoming/:id", "host": [ "{{baseUrl}}" ], "path": [ "import", "incoming", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Edit, accept, reject, archive or annotate the incoming invoice", "request": { "method": "PATCH", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/import/incoming/:id", "host": [ "{{baseUrl}}" ], "path": [ "import", "incoming", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"accepted\",\n \"rejectionReason\": \"\",\n \"archiveNote\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Partial update. Header, parties, lines, VAT breakdown and payment fields can change while the invoice is draft or review (409 otherwise); lineItems, vatBreakdown and paymentMeans replace what is stored. Category, cost centre, notes and custom fields can change at any time. Send the decision (status) separately from content edits." } }, { "name": "Delete an import that was not accepted", "request": { "method": "DELETE", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/import/incoming/:id", "host": [ "{{baseUrl}}" ], "path": [ "import", "incoming", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Get import status", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/import/incoming/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "import", "incoming", ":id", "status" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Get the validation report", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/import/incoming/:id/validation", "host": [ "{{baseUrl}}" ], "path": [ "import", "incoming", ":id", "validation" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Get the parsed invoice content", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/import/incoming/:id/content", "host": [ "{{baseUrl}}" ], "path": [ "import", "incoming", ":id", "content" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Get one part of the content (summary, lineitems, seller, buyer, taxes, paymentterms, paymentmeans, delivery, pdf)", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/import/incoming/:id/content/:part", "host": [ "{{baseUrl}}" ], "path": [ "import", "incoming", ":id", "content", ":part" ], "variable": [ { "key": "id", "value": "" }, { "key": "part", "value": "" } ] } } }, { "name": "Download the original file", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/import/incoming/:id/source", "host": [ "{{baseUrl}}" ], "path": [ "import", "incoming", ":id", "source" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "List attachments", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/import/incoming/:id/attachments", "host": [ "{{baseUrl}}" ], "path": [ "import", "incoming", ":id", "attachments" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Get attachment metadata", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/import/incoming/:id/attachment/:attachmentId", "host": [ "{{baseUrl}}" ], "path": [ "import", "incoming", ":id", "attachment", ":attachmentId" ], "variable": [ { "key": "id", "value": "" }, { "key": "attachmentId", "value": "" } ] } } }, { "name": "Download an attachment", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/import/incoming/:id/attachment/:attachmentId/file", "host": [ "{{baseUrl}}" ], "path": [ "import", "incoming", ":id", "attachment", ":attachmentId", "file" ], "variable": [ { "key": "id", "value": "" }, { "key": "attachmentId", "value": "" } ] } } }, { "name": "List payments to the supplier", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/import/incoming/:id/payments", "host": [ "{{baseUrl}}" ], "path": [ "import", "incoming", ":id", "payments" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Record a payment to the supplier", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/import/incoming/:id/payments", "host": [ "{{baseUrl}}" ], "path": [ "import", "incoming", ":id", "payments" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 0\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Customers", "item": [ { "name": "List customers", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/customers?page=&perPage=&sort=&order=&keyword=&type=&trn=&isActive=", "host": [ "{{baseUrl}}" ], "path": [ "customers" ], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "perPage", "value": "", "disabled": true }, { "key": "sort", "value": "", "disabled": true }, { "key": "order", "value": "", "disabled": true }, { "key": "keyword", "value": "", "disabled": true }, { "key": "type", "value": "", "disabled": true }, { "key": "trn", "value": "", "disabled": true }, { "key": "isActive", "value": "", "disabled": true } ], "variable": [] } } }, { "name": "Create a customer", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/customers", "host": [ "{{baseUrl}}" ], "path": [ "customers" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get the next customer number", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/customers/next-number", "host": [ "{{baseUrl}}" ], "path": [ "customers", "next-number" ], "variable": [] } } }, { "name": "Verify a customer number", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/customers/verify-number?value=", "host": [ "{{baseUrl}}" ], "path": [ "customers", "verify-number" ], "query": [ { "key": "value", "value": "", "disabled": false } ], "variable": [] } } }, { "name": "Import customers (batch)", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/customers/import", "host": [ "{{baseUrl}}" ], "path": [ "customers", "import" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"customers\": [\n {\n \"name\": null\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Look up a Peppol participant (format check + SML registration)", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/customers/peppol-lookup?participantId=&test=", "host": [ "{{baseUrl}}" ], "path": [ "customers", "peppol-lookup" ], "query": [ { "key": "participantId", "value": "", "disabled": false }, { "key": "test", "value": "", "disabled": true } ], "variable": [] }, "description": "participantId is scheme:identifier (0235:, the TIN being the first 10 digits of the TRN) or a bare TRN, which is converted to 0235:. registered is true/false when the Peppol SML could be queried, null otherwise." } }, { "name": "Get a customer", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/customers/:id", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Update a customer", "request": { "method": "PATCH", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/customers/:id", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete (or deactivate) a customer", "request": { "method": "DELETE", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/customers/:id", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Verify the customer's Peppol registration and store the result", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/customers/:id/verify-peppol", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "verify-peppol" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"participantId\": \"\",\n \"save\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List contact persons", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/customers/:id/contact-persons", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "contact-persons" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Add a contact person", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/customers/:id/contact-persons", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "contact-persons" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"lastName\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a contact person", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/customers/:id/contact-persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "contact-persons", ":personId" ], "variable": [ { "key": "id", "value": "" }, { "key": "personId", "value": "" } ] } } }, { "name": "Update a contact person", "request": { "method": "PATCH", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/customers/:id/contact-persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "contact-persons", ":personId" ], "variable": [ { "key": "id", "value": "" }, { "key": "personId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"lastName\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a contact person", "request": { "method": "DELETE", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/customers/:id/contact-persons/:personId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "contact-persons", ":personId" ], "variable": [ { "key": "id", "value": "" }, { "key": "personId", "value": "" } ] } } }, { "name": "List delivery and billing addresses", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/customers/:id/addresses", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "addresses" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Add an address", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/customers/:id/addresses", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "addresses" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"kind\": \"delivery\",\n \"label\": \"\",\n \"recipientName\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get an address", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/customers/:id/addresses/:addressId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "addresses", ":addressId" ], "variable": [ { "key": "id", "value": "" }, { "key": "addressId", "value": "" } ] } } }, { "name": "Update an address", "request": { "method": "PATCH", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/customers/:id/addresses/:addressId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "addresses", ":addressId" ], "variable": [ { "key": "id", "value": "" }, { "key": "addressId", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"kind\": \"delivery\",\n \"label\": \"\",\n \"recipientName\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete an address", "request": { "method": "DELETE", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/customers/:id/addresses/:addressId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":id", "addresses", ":addressId" ], "variable": [ { "key": "id", "value": "" }, { "key": "addressId", "value": "" } ] } } } ] }, { "name": "Products", "item": [ { "name": "List products", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/products?page=&perPage=&sort=&order=&keyword=&type=&sku=&isActive=", "host": [ "{{baseUrl}}" ], "path": [ "products" ], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "perPage", "value": "", "disabled": true }, { "key": "sort", "value": "", "disabled": true }, { "key": "order", "value": "", "disabled": true }, { "key": "keyword", "value": "", "disabled": true }, { "key": "type", "value": "", "disabled": true }, { "key": "sku", "value": "", "disabled": false }, { "key": "isActive", "value": "", "disabled": true } ], "variable": [] } } }, { "name": "Create a product", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/products", "host": [ "{{baseUrl}}" ], "path": [ "products" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Check whether a SKU is free", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/products/valid-code?sku=", "host": [ "{{baseUrl}}" ], "path": [ "products", "valid-code" ], "query": [ { "key": "sku", "value": "", "disabled": false } ], "variable": [] } } }, { "name": "Import products (batch)", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/products/import", "host": [ "{{baseUrl}}" ], "path": [ "products", "import" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"products\": [\n {\n \"name\": null\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a product", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/products/:id", "host": [ "{{baseUrl}}" ], "path": [ "products", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Update a product", "request": { "method": "PATCH", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/products/:id", "host": [ "{{baseUrl}}" ], "path": [ "products", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete (or deactivate) a product", "request": { "method": "DELETE", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/products/:id", "host": [ "{{baseUrl}}" ], "path": [ "products", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Resolve the price for a customer, quantity and date (price lists)", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/products/:id/price?customerId=&quantity=&date=", "host": [ "{{baseUrl}}" ], "path": [ "products", ":id", "price" ], "query": [ { "key": "customerId", "value": "", "disabled": true }, { "key": "quantity", "value": "", "disabled": true }, { "key": "date", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "List product bundles", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/bundles?page=&perPage=&sort=&order=&keyword=&isActive=", "host": [ "{{baseUrl}}" ], "path": [ "bundles" ], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "perPage", "value": "", "disabled": true }, { "key": "sort", "value": "", "disabled": true }, { "key": "order", "value": "", "disabled": true }, { "key": "keyword", "value": "", "disabled": true }, { "key": "isActive", "value": "", "disabled": true } ], "variable": [] } } }, { "name": "Create a bundle", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/bundles", "host": [ "{{baseUrl}}" ], "path": [ "bundles" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a bundle", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/bundles/:id", "host": [ "{{baseUrl}}" ], "path": [ "bundles", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Update a bundle (items replace the component list)", "request": { "method": "PATCH", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/bundles/:id", "host": [ "{{baseUrl}}" ], "path": [ "bundles", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a bundle", "request": { "method": "DELETE", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/bundles/:id", "host": [ "{{baseUrl}}" ], "path": [ "bundles", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Expand a bundle into invoice line inputs", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/bundles/:id/lines?quantity=&customerId=&date=&split=", "host": [ "{{baseUrl}}" ], "path": [ "bundles", ":id", "lines" ], "query": [ { "key": "quantity", "value": "", "disabled": true }, { "key": "customerId", "value": "", "disabled": true }, { "key": "date", "value": "", "disabled": true }, { "key": "split", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Splittable bundles return one line per component priced through the customer's price lists; others return a single line at the bundle price." } }, { "name": "List price lists", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/price-lists?page=&perPage=&sort=&order=&isActive=&customerId=", "host": [ "{{baseUrl}}" ], "path": [ "price-lists" ], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "perPage", "value": "", "disabled": true }, { "key": "sort", "value": "", "disabled": true }, { "key": "order", "value": "", "disabled": true }, { "key": "isActive", "value": "", "disabled": true }, { "key": "customerId", "value": "", "disabled": true } ], "variable": [] } } }, { "name": "Create a price list", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/price-lists", "host": [ "{{baseUrl}}" ], "path": [ "price-lists" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a price list with prices and assigned customers", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/price-lists/:id", "host": [ "{{baseUrl}}" ], "path": [ "price-lists", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Update a price list", "request": { "method": "PATCH", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/price-lists/:id", "host": [ "{{baseUrl}}" ], "path": [ "price-lists", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a price list", "request": { "method": "DELETE", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/price-lists/:id", "host": [ "{{baseUrl}}" ], "path": [ "price-lists", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Replace the prices of a price list", "request": { "method": "PUT", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/price-lists/:id/items", "host": [ "{{baseUrl}}" ], "path": [ "price-lists", ":id", "items" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"itemId\": \"00000000-0000-0000-0000-000000000000\",\n \"unitPrice\": 0\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Replace the customers assigned to a price list", "request": { "method": "PUT", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/price-lists/:id/customers", "host": [ "{{baseUrl}}" ], "path": [ "price-lists", ":id", "customers" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"customerIds\": [\n \"00000000-0000-0000-0000-000000000000\"\n ]\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Projects", "item": [ { "name": "List projects with totals", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/projects?page=&perPage=&sort=&order=&keyword=&status=&customerId=&includeArchived=&includeTotals=", "host": [ "{{baseUrl}}" ], "path": [ "projects" ], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "perPage", "value": "", "disabled": true }, { "key": "sort", "value": "", "disabled": true }, { "key": "order", "value": "", "disabled": true }, { "key": "keyword", "value": "", "disabled": true }, { "key": "status", "value": "", "disabled": true }, { "key": "customerId", "value": "", "disabled": true }, { "key": "includeArchived", "value": "", "disabled": true }, { "key": "includeTotals", "value": "", "disabled": true } ], "variable": [] } } }, { "name": "Create a project (code allocated when omitted)", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/projects", "host": [ "{{baseUrl}}" ], "path": [ "projects" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a project with totals", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/projects/:id", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Update a project", "request": { "method": "PATCH", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/projects/:id", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a project (archived instead when documents are linked)", "request": { "method": "DELETE", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/projects/:id", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "List the project's invoices", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/projects/:id/invoices?page=&perPage=&sort=&order=&status=&paymentStatus=", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":id", "invoices" ], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "perPage", "value": "", "disabled": true }, { "key": "sort", "value": "", "disabled": true }, { "key": "order", "value": "", "disabled": true }, { "key": "status", "value": "", "disabled": true }, { "key": "paymentStatus", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Everything linked to the project: invoices, quotes, proformas, incoming invoices", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/projects/:id/documents", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":id", "documents" ], "variable": [ { "key": "id", "value": "" } ] } } } ] }, { "name": "Settings", "item": [ { "name": "List email templates per document kind and language (custom or default)", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/settings/email-templates", "host": [ "{{baseUrl}}" ], "path": [ "settings", "email-templates" ], "variable": [] } } }, { "name": "Save an email template", "request": { "method": "PUT", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/settings/email-templates/:kind/:locale", "host": [ "{{baseUrl}}" ], "path": [ "settings", "email-templates", ":kind", ":locale" ], "variable": [ { "key": "kind", "value": "" }, { "key": "locale", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"subject\": \"\",\n \"body\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "kind: invoice, credit_note, debit_note, proforma, quote, order_confirmation, reminder, cover_letter, letter. locale: en or ar. Placeholders use {{name}}; unknown placeholders are rejected." } }, { "name": "Reset an email template to the default", "request": { "method": "DELETE", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/settings/email-templates/:kind/:locale", "host": [ "{{baseUrl}}" ], "path": [ "settings", "email-templates", ":kind", ":locale" ], "variable": [ { "key": "kind", "value": "" }, { "key": "locale", "value": "" } ] } } }, { "name": "Organization options (modules, numbering, inventory, customer numbers, default copies)", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/settings/options", "host": [ "{{baseUrl}}" ], "path": [ "settings", "options" ], "variable": [] } } }, { "name": "Update organization options", "request": { "method": "PATCH", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/settings/options", "host": [ "{{baseUrl}}" ], "path": [ "settings", "options" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"hiddenModules\": [\n \"\"\n ],\n \"reserveNumbersInDrafts\": false,\n \"defaultPaymentTermsDays\": 0\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "VAT", "item": [ { "name": "List VAT rates and categories", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/settings/tax-rates?isActive=", "host": [ "{{baseUrl}}" ], "path": [ "settings", "tax-rates" ], "query": [ { "key": "isActive", "value": "", "disabled": true } ], "variable": [] } } }, { "name": "Create a VAT rate", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/settings/tax-rates", "host": [ "{{baseUrl}}" ], "path": [ "settings", "tax-rates" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update a VAT rate", "request": { "method": "PATCH", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/settings/tax-rates/:id", "host": [ "{{baseUrl}}" ], "path": [ "settings", "tax-rates", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a VAT rate (not the default)", "request": { "method": "DELETE", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/settings/tax-rates/:id", "host": [ "{{baseUrl}}" ], "path": [ "settings", "tax-rates", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Recent tax periods with filing status", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/vat/periods?count=", "host": [ "{{baseUrl}}" ], "path": [ "vat", "periods" ], "query": [ { "key": "count", "value": "", "disabled": true } ], "variable": [] } } }, { "name": "VAT 201 worksheet for a period (JSON or CSV)", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/vat/worksheet?from=&to=&date=&format=", "host": [ "{{baseUrl}}" ], "path": [ "vat", "worksheet" ], "query": [ { "key": "from", "value": "", "disabled": true }, { "key": "to", "value": "", "disabled": true }, { "key": "date", "value": "", "disabled": true }, { "key": "format", "value": "", "disabled": true } ], "variable": [] }, "description": "Boxes 1a–14 of the UAE VAT 201 from issued invoices (standard-rated per emirate, zero-rated, exempt) and accepted incoming invoices (standard-rated expenses, reverse charge). Give from/to, or date to pick the tax period containing it. Manual figures of a saved return for the same period are included." } }, { "name": "List saved VAT returns", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/vat/returns?page=&perPage=", "host": [ "{{baseUrl}}" ], "path": [ "vat", "returns" ], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "perPage", "value": "", "disabled": true } ], "variable": [] } } }, { "name": "Save the return of a period (draft or filed)", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/vat/returns", "host": [ "{{baseUrl}}" ], "path": [ "vat", "returns" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"periodStart\": \"2026-09-23\",\n \"periodEnd\": \"2026-09-23\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Recomputes the worksheet, stores the manual figures and, with status filed, records the filing date and EmaraTax reference and locks the period: invoices, lines and accepted incoming invoices dated in it can no longer be created, changed or deleted (409 period_locked). One return per period; to change a filed return, reopen it first (POST /vat/returns/{id}/reopen)." } }, { "name": "Reopen a filed VAT return", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/vat/returns/:id/reopen", "host": [ "{{baseUrl}}" ], "path": [ "vat", "returns", ":id", "reopen" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"\",\n \"acknowledgeVoluntaryDisclosure\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Unlocks the period so documents dated in it can change again, until the return is filed again. Needs a reason (at least 5 characters) and acknowledgeVoluntaryDisclosure: true. Refused (409 lock_date_covers_period) while the lock date for everyone covers the period." } }, { "name": "Check whether a date is in a locked period", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/vat/check-date?date=", "host": [ "{{baseUrl}}" ], "path": [ "vat", "check-date" ], "query": [ { "key": "date", "value": "", "disabled": true } ], "variable": [] }, "description": "locked: a lock covers the date; blocked: it applies to this API key (the soft lock is passed with the periods:manage scope); firstOpenDate: the first date documents can use." } }, { "name": "Get a saved VAT return", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/vat/returns/:id", "host": [ "{{baseUrl}}" ], "path": [ "vat", "returns", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Delete a draft VAT return", "request": { "method": "DELETE", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/vat/returns/:id", "host": [ "{{baseUrl}}" ], "path": [ "vat", "returns", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } } ] }, { "name": "Accounting exports", "item": [ { "name": "Supported accounting systems and default tax codes", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/exports/accounting/systems", "host": [ "{{baseUrl}}" ], "path": [ "exports", "accounting", "systems" ], "variable": [] } } }, { "name": "Export issued invoices or accepted incoming invoices for Zoho Books, Xero, QuickBooks Online or Tally", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/exports/accounting?system=&kind=&from=&to=&date=&includeTest=&accountCode=&vatLedger=&format=", "host": [ "{{baseUrl}}" ], "path": [ "exports", "accounting" ], "query": [ { "key": "system", "value": "", "disabled": false }, { "key": "kind", "value": "", "disabled": true }, { "key": "from", "value": "", "disabled": true }, { "key": "to", "value": "", "disabled": true }, { "key": "date", "value": "", "disabled": true }, { "key": "includeTest", "value": "", "disabled": true }, { "key": "accountCode", "value": "", "disabled": true }, { "key": "vatLedger", "value": "", "disabled": true }, { "key": "format", "value": "", "disabled": true } ], "variable": [] }, "description": "system: zoho, xero, quickbooks (CSV) or tally (XML). kind: sales (issued invoices, credit notes negative) or purchases (accepted incoming invoices). Override tax code labels with taxCode.standard=…, taxCode.zero_rated=… etc. format=json wraps the file in a JSON object (for MCP clients)." } } ] }, { "name": "Integrations", "item": [ { "name": "List accounting connectors (credentials omitted)", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/connectors", "host": [ "{{baseUrl}}" ], "path": [ "connectors" ], "variable": [] } } }, { "name": "Run a sync on a QuickBooks, Xero or Odoo connector", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/connectors/:id/sync", "host": [ "{{baseUrl}}" ], "path": [ "connectors", ":id", "sync" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"mode\": \"full\",\n \"dateFrom\": \"2026-09-23\",\n \"dateTo\": \"2026-09-23\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Pulls contacts and invoices into this account (mode full, incremental or date_range) and, with pushInvoices, pushes issued invoices out. Zoho Books and Tally keep their own functions." } }, { "name": "List the local ↔ remote record links of a connector", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/connectors/:id/links?page=&perPage=&entityType=", "host": [ "{{baseUrl}}" ], "path": [ "connectors", ":id", "links" ], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "perPage", "value": "", "disabled": true }, { "key": "entityType", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "" } ] } } } ] }, { "name": "Payments", "item": [ { "name": "List payment gateways (no credentials) and supported providers", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-gateways", "host": [ "{{baseUrl}}" ], "path": [ "payment-gateways" ], "variable": [] } } }, { "name": "Create (or reuse) a pay-by-link for the outstanding amount", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/payment-link", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "payment-link" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"gatewayId\": \"00000000-0000-0000-0000-000000000000\",\n \"expiresInDays\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "Needs an active payment gateway (Settings → Payments). Test invoices can only use test-mode or simulated gateways. The url is the public pay page; share it or let the invoice email include it." } }, { "name": "List the payment links of an invoice", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/invoices/:id/payment-links", "host": [ "{{baseUrl}}" ], "path": [ "invoices", ":id", "payment-links" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "List payment links", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-links?page=&perPage=&status=", "host": [ "{{baseUrl}}" ], "path": [ "payment-links" ], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "perPage", "value": "", "disabled": true }, { "key": "status", "value": "", "disabled": true } ], "variable": [] } } }, { "name": "Cancel a pending payment link", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/payment-links/:linkId/cancel", "host": [ "{{baseUrl}}" ], "path": [ "payment-links", ":linkId", "cancel" ], "variable": [ { "key": "linkId", "value": "" } ] } } } ] }, { "name": "Bank feeds", "item": [ { "name": "List bank connections and accounts", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/bank/accounts", "host": [ "{{baseUrl}}" ], "path": [ "bank", "accounts" ], "variable": [] } } }, { "name": "List bank transactions with match suggestions", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/bank/transactions?page=&perPage=&status=&accountId=&from=&to=", "host": [ "{{baseUrl}}" ], "path": [ "bank", "transactions" ], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "perPage", "value": "", "disabled": true }, { "key": "status", "value": "", "disabled": true }, { "key": "accountId", "value": "", "disabled": true }, { "key": "from", "value": "", "disabled": true }, { "key": "to", "value": "", "disabled": true } ], "variable": [] } } }, { "name": "Confirm a match: records the payment and links the transaction", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/bank/transactions/:id/match", "host": [ "{{baseUrl}}" ], "path": [ "bank", "transactions", ":id", "match" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"invoiceId\": \"00000000-0000-0000-0000-000000000000\",\n \"incomingInvoiceId\": \"00000000-0000-0000-0000-000000000000\",\n \"amount\": 0\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Undo a match (removes the bank-feed payment)", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/bank/transactions/:id/unmatch", "host": [ "{{baseUrl}}" ], "path": [ "bank", "transactions", ":id", "unmatch" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Ignore a transaction (fees, transfers)", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/bank/transactions/:id/ignore", "host": [ "{{baseUrl}}" ], "path": [ "bank", "transactions", ":id", "ignore" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Import statement rows (CSV columns as objects) and run the matcher", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/bank/import", "host": [ "{{baseUrl}}" ], "path": [ "bank", "import" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"rows\": [\n {}\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Rows are objects keyed by the bank's column names (date, amount or credit/debit, description, reference, counterparty…). Re-importing the same rows does not duplicate transactions." } }, { "name": "Pull the live bank connections now and re-run matching", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/bank/sync", "host": [ "{{baseUrl}}" ], "path": [ "bank", "sync" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"connectionId\": \"00000000-0000-0000-0000-000000000000\",\n \"rematch\": false\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Webhooks", "item": [ { "name": "List webhook subscriptions", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ], "variable": [] } } }, { "name": "Create a webhook subscription", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"targetUrl\": \"\",\n \"events\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "The signing secret is returned once. Every delivery carries X-Webhook-Signature: t=,v1=.\">." } }, { "name": "List supported events", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/webhooks/events", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "events" ], "variable": [] } } }, { "name": "Get a webhook", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/webhooks/:id", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Update a webhook", "request": { "method": "PATCH", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/webhooks/:id", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"targetUrl\": \"\",\n \"events\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a webhook", "request": { "method": "DELETE", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/webhooks/:id", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Send a test event", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/webhooks/:id/test", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":id", "test" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Rotate the signing secret", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/webhooks/:id/rotate-secret", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":id", "rotate-secret" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "List deliveries", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/webhooks/:id/deliveries?page=&perPage=&status=&event=&includePayload=", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":id", "deliveries" ], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "perPage", "value": "", "disabled": true }, { "key": "status", "value": "", "disabled": true }, { "key": "event", "value": "", "disabled": true }, { "key": "includePayload", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Get a delivery with its payload", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/webhooks/:id/deliveries/:deliveryId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":id", "deliveries", ":deliveryId" ], "variable": [ { "key": "id", "value": "" }, { "key": "deliveryId", "value": "" } ] } } }, { "name": "Retry a delivery now", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/webhooks/:id/deliveries/:deliveryId/retry", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":id", "deliveries", ":deliveryId", "retry" ], "variable": [ { "key": "id", "value": "" }, { "key": "deliveryId", "value": "" } ] } } } ] }, { "name": "ERP intake", "item": [ { "name": "Receive a pushed ERP message (CargoWise UniversalTransaction XML, or JSON) and create the invoice", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/erp/:connector/messages?ack=", "host": [ "{{baseUrl}}" ], "path": [ "erp", ":connector", "messages" ], "query": [ { "key": "ack", "value": "", "disabled": true } ], "variable": [ { "key": "connector", "value": "" } ] }, "description": "connector: cargowise (application/xml, SOAP envelope allowed) or json (one InvoiceInput). The message is stored with its raw body, mapped through the organisation's charge map (PUT /erp/connectors/{type}), and created and submitted like POST /invoices. A resend of the same document answers 200 with status duplicate and nothing is created. Mapping or validation failures answer 400 (E_VALIDATION) with the stored message in extra.message; with ?ack=always (or the connector's alwaysAck setting) they answer 202 so push transports do not retry. Basic authentication with the API key as password is accepted on every route." } }, { "name": "List received ERP messages", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/erp/messages?page=&perPage=&status=&connector=&keyword=", "host": [ "{{baseUrl}}" ], "path": [ "erp", "messages" ], "query": [ { "key": "page", "value": "", "disabled": true }, { "key": "perPage", "value": "", "disabled": true }, { "key": "status", "value": "", "disabled": true }, { "key": "connector", "value": "", "disabled": true }, { "key": "keyword", "value": "", "disabled": true } ], "variable": [] } } }, { "name": "Get a received message with its raw body and outcome", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/erp/messages/:id?includeRaw=", "host": [ "{{baseUrl}}" ], "path": [ "erp", "messages", ":id" ], "query": [ { "key": "includeRaw", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Process a failed message again after the mapping or master data was fixed", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/erp/messages/:id/replay", "host": [ "{{baseUrl}}" ], "path": [ "erp", "messages", ":id", "replay" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "List ERP connectors, their endpoints and this organisation's settings", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/erp/connectors", "host": [ "{{baseUrl}}" ], "path": [ "erp", "connectors" ], "variable": [] } } }, { "name": "Set the charge map, defaults and sign-off for a connector", "request": { "method": "PUT", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/erp/connectors/:type", "host": [ "{{baseUrl}}" ], "path": [ "erp", "connectors", ":type" ], "variable": [ { "key": "type", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"mode\": \"replace\",\n \"removeChargeCodes\": [\n \"\"\n ],\n \"removeVatCodes\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Fields sent replace the same fields; others are kept. chargeMap and vatCodeMap replace the stored maps unless mode is merge, which adds or changes the codes sent and keeps the rest (removeChargeCodes / removeVatCodes delete codes); scripts and assistants should use merge. The previous maps are kept in the audit log. chargeMap keys are the ERP's charge codes; a message whose charge code is unmapped falls back to vatCodeMap, then the built-in VAT code list, then defaultCategory, and fails when none decides." } } ] }, { "name": "Custom fields", "item": [ { "name": "List custom field definitions", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/metadata/fields?level=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "fields" ], "query": [ { "key": "level", "value": "", "disabled": true } ], "variable": [] } } }, { "name": "Create a custom field", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/metadata/fields", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "fields" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"label\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a custom field", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/metadata/fields/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "fields", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Update a custom field", "request": { "method": "PATCH", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/metadata/fields/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "fields", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"label\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a custom field", "request": { "method": "DELETE", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/metadata/fields/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "fields", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "List templates", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/metadata/templates?documentKind=&isActive=", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "templates" ], "query": [ { "key": "documentKind", "value": "", "disabled": true }, { "key": "isActive", "value": "", "disabled": true } ], "variable": [] } } }, { "name": "Create a template", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/metadata/templates", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "templates" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get a template", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/metadata/templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "templates", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Update a template", "request": { "method": "PATCH", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/metadata/templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "templates", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete a template", "request": { "method": "DELETE", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/metadata/templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "templates", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Make this the active template for its document kind", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/metadata/templates/:id/activate", "host": [ "{{baseUrl}}" ], "path": [ "metadata", "templates", ":id", "activate" ], "variable": [ { "key": "id", "value": "" } ] } } } ] }, { "name": "MCP", "item": [ { "name": "MCP server (Streamable HTTP, stateless)", "request": { "method": "POST", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/mcp", "host": [ "{{baseUrl}}" ], "path": [ "mcp" ], "variable": [] }, "description": "Model Context Protocol endpoint. Send JSON-RPC 2.0 messages (initialize, tools/list, tools/call, resources/list, resources/read) with the same X-API-KEY header; responses are JSON, no SSE stream is opened. Tools mirror the REST routes and respect the key's scopes." } } ] }, { "name": "Account", "item": [ { "name": "Describe the API key and organization", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/me", "host": [ "{{baseUrl}}" ], "path": [ "me" ], "variable": [] } } }, { "name": "List client organizations this key may act for (X-Organization-Id)", "request": { "method": "GET", "header": [ { "key": "X-API-KEY", "value": "{{apiKey}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/organizations/managed", "host": [ "{{baseUrl}}" ], "path": [ "organizations", "managed" ], "variable": [] } } } ] } ] }