{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/dukanam.com" } ], "info": { "name": "Dukanam Mobile API", "_postman_id": "419c784a-79bf-483d-b1fb-70428a51c650", "description": "Interactive reference for the versioned Dukanam API, covering authentication, billing, POS, inventory, GST, compliance, exports, and team access.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Authentication", "description": "\nCreate and manage mobile bearer tokens.", "item": [ { "name": "POST api\/v1\/auth\/register", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/register", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/register" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"email\":\"zbailey@example.net\",\"phone\":\"i\",\"business_name\":\"y\",\"password\":\"pBNvYg\",\"device_name\":\"Scribe API Docs\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "POST api\/v1\/auth\/login", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/login", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/login" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"gbailey@example.net\",\"password\":\"|]|{+-\",\"remember\":false,\"device_name\":\"Scribe API Docs\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Email a password reset link.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/forgot-password", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/forgot-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"owner@example.com\"}" }, "description": "Always returns the same response so callers cannot discover registered email addresses.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"If an account exists for that email address, a password reset link has been sent.\"}", "name": "" } ] }, { "name": "Reset an account password.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/reset-password", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/reset-password" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"token\":\"reset-token\",\"email\":\"owner@example.com\",\"password\":\"new-secure-password\",\"password_confirmation\":\"new-secure-password\"}" }, "description": "A successful reset revokes every mobile bearer token and sends a security notification.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Password reset successfully. Sign in with your new password.\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"email\":[\"This password reset token is invalid.\"]}}", "name": "" } ] }, { "name": "Return the current user and active workspaces available under each plan and seat assignment.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/me", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/me" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "DELETE api\/v1\/auth\/token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/token", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/token" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "DELETE api\/v1\/auth\/tokens", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/tokens", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/tokens" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Businesses", "description": "", "item": [ { "name": "List the active workspaces available under the caller's current plan and seat assignment.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET api\/v1\/businesses\/{business}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update business settings.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/settings", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/settings", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"legal_name\":\"n\",\"phone\":\"g\",\"email\":\"rowan.gulgowski@example.com\",\"gst_registration_type\":\"unregistered\",\"gstin\":\"dljnikhwaykcmyu\",\"address_line_1\":\"w\",\"address_line_2\":\"p\",\"city\":\"w\",\"state_code\":1,\"pincode\":\"569775\",\"default_place_of_supply\":1,\"invoice_prefix\":\"HAWIOT\\\/26-27\\\/\",\"prices_include_tax\":false,\"authorized_signatory\":\"g\",\"bank_details\":\"z\",\"upi_id\":\"m\",\"theme\":\"blue\",\"default_locale\":\"en\",\"reminder_message_template\":\"i\",\"reminder_email_subject_template\":\"y\",\"invoice_share_subject_template\":\"v\",\"invoice_share_message_template\":\"d\"}" }, "description": "The `default_locale` field may only be changed by workspace owners and admins. Manual-sharing\ntemplates may only be changed by those roles when the paid feature is enabled for the business." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 1,\n \"name\": \"Anika Stores\",\n \"slug\": \"anika-stores\",\n \"role\": \"owner\",\n \"phone\": \"9876543210\",\n \"email\": \"anika@example.com\",\n \"legal_name\": \"Anika Stores Private Limited\",\n \"gstin\": \"27AAPFU0939F1ZV\",\n \"gst_registration_type\": \"regular\",\n \"currency\": \"INR\",\n \"timezone\": \"Asia\/Kolkata\",\n \"address\": {\n \"line_1\": \"12 Market Road\",\n \"line_2\": null,\n \"city\": \"Pune\",\n \"state_code\": \"27\",\n \"pincode\": \"411001\"\n },\n \"default_place_of_supply\": \"27\",\n \"invoice_prefix\": \"INV\",\n \"prices_include_tax\": true,\n \"upi_id\": \"anikastores@bank\",\n \"theme\": \"indigo\",\n \"default_locale\": \"hi\",\n \"is_active\": true,\n \"manual_sharing\": {\n \"enabled\": true,\n \"reminder_message_template\": \"Hello {customer_name}, your current balance is {amount_due}.\",\n \"reminder_email_subject_template\": \"Payment reminder from {business_name}\",\n \"invoice_share_subject_template\": \"Invoice {invoice_number} from {business_name}\",\n \"invoice_share_message_template\": \"Hello {customer_name}, invoice {invoice_number} for {invoice_total} is ready.\"\n },\n \"subscription\": {\n \"status\": \"active\",\n \"billing_interval\": \"monthly\",\n \"trial_ends_at\": null,\n \"renews_at\": \"2026-09-19T00:00:00.000000Z\",\n \"ends_at\": null,\n \"cancelled_at\": null,\n \"plan\": {\n \"id\": 2,\n \"name\": \"Smart\",\n \"slug\": \"smart\",\n \"features\": [\"inventory\", \"pos\", \"expenses\"],\n \"limits\": []\n }\n }\n }\n}\n", "name": "" } ] }, { "name": "GET api\/v1\/businesses\/{business}\/dashboard", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/dashboard", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/dashboard", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Business onboarding", "description": "\nComplete the resumable setup required after registering a new business. Until onboarding finishes,\nclients may resubmit a completed required step to correct saved data without moving the current step backwards.", "item": [ { "name": "GET api\/v1\/businesses\/{business}\/onboarding", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/onboarding", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/onboarding", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "PATCH api\/v1\/businesses\/{business}\/onboarding\/language", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/onboarding\/language", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/onboarding\/language", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"locale\":\"hi\"}" }, "description": "" }, "response": [] }, { "name": "POST api\/v1\/businesses\/{business}\/onboarding\/business", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/onboarding\/business", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/onboarding\/business", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Veera Stores", "type": "text", "description": "Public business name." }, { "key": "store_type", "value": "kirana-store", "type": "text", "description": "Store type key." }, { "key": "supply_type", "value": "goods", "type": "text", "description": "goods, services, or both." }, { "key": "phone", "value": "9876543210", "type": "text", "description": "Public phone in E.164 or a 10-digit Indian local format." }, { "key": "logo", "src": [], "type": "file" } ] }, "description": "" }, "response": [] }, { "name": "PATCH api\/v1\/businesses\/{business}\/onboarding\/tax", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/onboarding\/tax", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/onboarding\/tax", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"gst_status\":\"registered\",\"gst_registration_type\":\"normal\",\"gstin\":\"29ABCDE1234F1Z5\",\"legal_name\":\"a\",\"address_line_1\":\"12 Market Road\",\"address_line_2\":\"k\",\"city\":\"Bengaluru\",\"state_code\":\"29\",\"pincode\":\"560001\"}" }, "description": "" }, "response": [] }, { "name": "POST api\/v1\/businesses\/{business}\/onboarding\/steps\/{step}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/onboarding\/steps\/:step", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/onboarding\/steps\/:step", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "step", "key": "step", "value": "architecto", "description": "The step." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"skip\":true}" }, "description": "" }, "response": [] }, { "name": "POST api\/v1\/businesses\/{business}\/onboarding\/product-imports", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/onboarding\/product-imports", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/onboarding\/product-imports", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "file", "src": [], "type": "file" } ] }, "description": "" }, "response": [] }, { "name": "Import every validated product row without exceeding the current plan's total item allowance.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/onboarding\/product-imports\/:itemImport_id\/confirm", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/onboarding\/product-imports\/:itemImport_id\/confirm", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "itemImport_id", "key": "itemImport_id", "value": 1, "description": "The ID of the itemImport." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 422, "body": "{\"message\":\"Your current plan includes up to 5 items. Upgrade to Smart Books to add more.\",\"errors\":{\"plan\":[\"Your current plan includes up to 5 items. Upgrade to Smart Books to add more.\"]}}", "name": "" } ] } ] }, { "name": "Contacts", "description": "", "item": [ { "name": "GET api\/v1\/businesses\/{business}\/contacts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/contacts", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/contacts", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"customer\",\"search\":\"b\",\"per_page\":22}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create a contact and post its opening balance.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/contacts", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/contacts", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"customer\",\"profile_type\":\"consumer\",\"name\":\"b\",\"company_name\":\"n\",\"contact_person\":\"g\",\"phone\":\"z\",\"email\":\"rempel.chadrick@example.org\",\"gst_treatment\":\"unregistered\",\"gstin\":\"ljnikhwaykcmyuw\",\"pan\":\"pwlvqwrsit\",\"address\":\"c\",\"billing_address_line_1\":\"p\",\"billing_address_line_2\":\"s\",\"billing_city\":\"c\",\"billing_state_code\":1,\"billing_pincode\":\"569775\",\"shipping_same_as_billing\":false,\"shipping_address_line_1\":\"n\",\"shipping_address_line_2\":\"g\",\"shipping_city\":\"z\",\"shipping_state_code\":1,\"shipping_pincode\":\"569775\",\"opening_balance\":22,\"opening_balance_side\":\"receivable\",\"opening_balance_date\":\"2026-01-15\"}" }, "description": "Customer openings post to Accounts receivable; supplier openings post to Accounts payable, offset by Owner equity." }, "response": [] }, { "name": "GET api\/v1\/businesses\/{business}\/contacts\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/contacts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/contacts\/:id", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "id", "key": "id", "value": 1, "description": "The ID of the contact." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update a contact and replace its opening-balance journal.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/contacts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/contacts\/:id", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "id", "key": "id", "value": 1, "description": "The ID of the contact." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"customer\",\"profile_type\":\"consumer\",\"name\":\"b\",\"company_name\":\"n\",\"contact_person\":\"g\",\"phone\":\"z\",\"email\":\"rempel.chadrick@example.org\",\"gst_treatment\":\"unregistered\",\"gstin\":\"ljnikhwaykcmyuw\",\"pan\":\"pwlvqwrsit\",\"address\":\"c\",\"billing_address_line_1\":\"p\",\"billing_address_line_2\":\"s\",\"billing_city\":\"c\",\"billing_state_code\":1,\"billing_pincode\":\"569775\",\"shipping_same_as_billing\":false,\"shipping_address_line_1\":\"n\",\"shipping_address_line_2\":\"g\",\"shipping_city\":\"z\",\"shipping_state_code\":1,\"shipping_pincode\":\"569775\",\"opening_balance\":22,\"opening_balance_side\":\"receivable\",\"opening_balance_date\":\"2026-01-15\"}" }, "description": "" }, "response": [] }, { "name": "DELETE api\/v1\/businesses\/{business}\/contacts\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/contacts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/contacts\/:id", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "id", "key": "id", "value": 1, "description": "The ID of the contact." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Khata ledger", "description": "", "item": [ { "name": "GET api\/v1\/businesses\/{business}\/ledger-entries", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/ledger-entries", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/ledger-entries", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"contact_id\":16,\"kind\":\"n\",\"from\":\"2026-01-15\",\"to\":\"2026-01-15\",\"per_page\":22}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Post a manual khata adjustment.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/ledger-entries", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/ledger-entries", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"contact_id\":16,\"kind\":\"customer_credit\",\"amount\":22,\"occurred_on\":\"2026-01-15\",\"reference\":\"g\",\"note\":\"z\"}" }, "description": "The receivable or payable adjustment is offset to Owner equity. Use invoice, purchase, expense, and payment endpoints for operational transactions." }, "response": [] }, { "name": "GET api\/v1\/businesses\/{business}\/ledger-entries\/{ledgerEntry_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/ledger-entries\/:ledgerEntry_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/ledger-entries\/:ledgerEntry_id", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "ledgerEntry_id", "key": "ledgerEntry_id", "value": 1, "description": "The ID of the ledgerEntry." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Reverse a manual khata adjustment and its journal.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/ledger-entries\/:ledgerEntry_id\/reverse", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/ledger-entries\/:ledgerEntry_id\/reverse", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "ledgerEntry_id", "key": "ledgerEntry_id", "value": 1, "description": "The ID of the ledgerEntry." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"b\"}" }, "description": "" }, "response": [] } ] }, { "name": "Inventory", "description": "", "item": [ { "name": "GET api\/v1\/businesses\/{business}\/items", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/items", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/items", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"search\":\"b\",\"low_stock\":false,\"per_page\":22}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create an item and post opening inventory.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/items", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/items", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "b", "type": "text", "description": "Must not be greater than 128 characters." }, { "key": "sku", "value": "n", "type": "text", "description": "Must not be greater than 64 characters." }, { "key": "barcode", "value": "g", "type": "text", "description": "Must not be greater than 64 characters." }, { "key": "item_type", "value": "goods", "type": "text", "description": "" }, { "key": "hsn_sac", "value": "zmiyvdljnikhwayk", "type": "text", "description": "Must match the regex \/^[0-9A-Z.\\-]+$\/. Must not be greater than 16 characters." }, { "key": "unit", "value": "cmyuwpwlvqwrsitc", "type": "text", "description": "Must not be greater than 24 characters." }, { "key": "uqc", "value": "pscqldzsnrwtujwv", "type": "text", "description": "Must not be greater than 16 characters." }, { "key": "gst_taxability", "value": "taxable", "type": "text", "description": "" }, { "key": "sale_price", "value": "24", "type": "text", "description": "Must be at least 0. Must not be greater than 999999999." }, { "key": "purchase_price", "value": "9", "type": "text", "description": "Must be at least 0. Must not be greater than 999999999." }, { "key": "mrp", "value": "15", "type": "text", "description": "Must be at least 0. Must not be greater than 999999999." }, { "key": "tax_rate", "value": "21", "type": "text", "description": "Must be at least 0. Must not be greater than 100." }, { "key": "cess_rate", "value": "7", "type": "text", "description": "Must be at least 0. Must not be greater than 100." }, { "key": "stock_quantity", "value": "8", "type": "text", "description": "Must be at least 0. Must not be greater than 999999999." }, { "key": "reorder_level", "value": "10", "type": "text", "description": "Must be at least 0. Must not be greater than 999999999." }, { "key": "track_inventory", "value": "", "type": "text", "description": "" }, { "key": "price_includes_tax", "value": "", "type": "text", "description": "" }, { "key": "remove_photos[0]", "value": "16", "type": "text", "description": "" }, { "key": "photos[]", "src": [], "type": "file" } ] }, "description": "Tracked opening stock creates a balanced Inventory \/ Owner equity journal at purchase cost.\nStock and reorder quantities accept up to three decimal places." }, "response": [ { "header": [], "code": 422, "body": "{\"message\":\"Your current plan includes up to 5 items. Upgrade to Smart Books to add more.\",\"errors\":{\"plan\":[\"Your current plan includes up to 5 items. Upgrade to Smart Books to add more.\"]}}", "name": "" } ] }, { "name": "GET api\/v1\/businesses\/{business}\/items\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/items\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/items\/:id", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "id", "key": "id", "value": 1, "description": "The ID of the item." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update an item and account for stock corrections.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/items\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/items\/:id", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "id", "key": "id", "value": 1, "description": "The ID of the item." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "b", "type": "text", "description": "Must not be greater than 128 characters." }, { "key": "sku", "value": "n", "type": "text", "description": "Must not be greater than 64 characters." }, { "key": "barcode", "value": "g", "type": "text", "description": "Must not be greater than 64 characters." }, { "key": "item_type", "value": "goods", "type": "text", "description": "" }, { "key": "hsn_sac", "value": "zmiyvdljnikhwayk", "type": "text", "description": "Must match the regex \/^[0-9A-Z.\\-]+$\/. Must not be greater than 16 characters." }, { "key": "unit", "value": "cmyuwpwlvqwrsitc", "type": "text", "description": "Must not be greater than 24 characters." }, { "key": "uqc", "value": "pscqldzsnrwtujwv", "type": "text", "description": "Must not be greater than 16 characters." }, { "key": "gst_taxability", "value": "taxable", "type": "text", "description": "" }, { "key": "sale_price", "value": "24", "type": "text", "description": "Must be at least 0. Must not be greater than 999999999." }, { "key": "purchase_price", "value": "9", "type": "text", "description": "Must be at least 0. Must not be greater than 999999999." }, { "key": "mrp", "value": "15", "type": "text", "description": "Must be at least 0. Must not be greater than 999999999." }, { "key": "tax_rate", "value": "21", "type": "text", "description": "Must be at least 0. Must not be greater than 100." }, { "key": "cess_rate", "value": "7", "type": "text", "description": "Must be at least 0. Must not be greater than 100." }, { "key": "stock_quantity", "value": "8", "type": "text", "description": "Must be at least 0. Must not be greater than 999999999." }, { "key": "reorder_level", "value": "10", "type": "text", "description": "Must be at least 0. Must not be greater than 999999999." }, { "key": "track_inventory", "value": "", "type": "text", "description": "" }, { "key": "price_includes_tax", "value": "", "type": "text", "description": "" }, { "key": "remove_photos[0]", "value": "16", "type": "text", "description": "" }, { "key": "photos[]", "src": [], "type": "file" }, { "key": "_method", "value": "PUT", "type": "text" } ] }, "description": "Quantity increases post inventory-adjustment income; decreases post an operating expense.\nStock and reorder quantities accept up to three decimal places." }, "response": [] }, { "name": "DELETE api\/v1\/businesses\/{business}\/items\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/items\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/items\/:id", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "id", "key": "id", "value": 1, "description": "The ID of the item." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Sales invoices", "description": "", "item": [ { "name": "GET api\/v1\/businesses\/{business}\/invoices", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/invoices", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/invoices", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"status\":\"posted\",\"contact_id\":16,\"from\":\"2026-01-15\",\"to\":\"2026-01-15\",\"search\":\"n\",\"per_page\":7}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create a sales invoice.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/invoices", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/invoices", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"contact_id\":16,\"issue_date\":\"2026-01-15\",\"due_date\":\"2026-01-15\",\"notes\":\"n\",\"place_of_supply_state_code\":\"gz\",\"reverse_charge\":false,\"prices_include_tax\":false,\"channel\":\"backoffice\",\"idempotency_key\":\"977e5426-8d13-3824-86aa-b092f8ae52c5\",\"lines\":[{\"item_id\":16,\"description\":\"Et animi quos velit et fugiat.\",\"quantity\":1,\"unit_price\":5,\"tax_rate\":19,\"cess_rate\":17,\"discount\":5,\"price_includes_tax\":false}]}" }, "description": "" }, "response": [] }, { "name": "GET api\/v1\/businesses\/{business}\/invoices\/{invoice_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/invoices\/:invoice_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/invoices\/:invoice_id", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "invoice_id", "key": "invoice_id", "value": 1, "description": "The ID of the invoice." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST api\/v1\/businesses\/{business}\/invoices\/{invoice_id}\/payments", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/invoices\/:invoice_id\/payments", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/invoices\/:invoice_id\/payments", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "invoice_id", "key": "invoice_id", "value": 1, "description": "The ID of the invoice." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"amount\":1,\"method\":\"cash\",\"payment_account_id\":16,\"paid_on\":\"2026-01-15\",\"reference\":\"n\",\"notes\":\"g\"}" }, "description": "" }, "response": [] }, { "name": "Void an unpaid invoice that has no returns.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/invoices\/:invoice_id\/void", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/invoices\/:invoice_id\/void", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "invoice_id", "key": "invoice_id", "value": 1, "description": "The ID of the invoice." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"b\"}" }, "description": "Invoices with a payment or a sales return must be settled through the corresponding payment or return workflow and cannot be voided." }, "response": [ { "header": [], "code": 422, "body": "{\"message\":\"Only unpaid, active invoices without returns can be voided.\",\"errors\":{\"invoice\":[\"Only unpaid, active invoices without returns can be voided.\"]}}", "name": "" } ] } ] }, { "name": "Business documents", "description": "", "item": [ { "name": "GET api\/v1\/businesses\/{business}\/documents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/documents", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/documents", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"quote\",\"status\":\"b\",\"contact_id\":16,\"per_page\":22}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST api\/v1\/businesses\/{business}\/documents\/{document_type}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/documents\/:document_type", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/documents\/:document_type", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "document_type", "key": "document_type", "value": "quote|purchase_order|purchase_invoice|recurring_invoice|sales_return|purchase_return", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"contact_id\":16,\"source_invoice_id\":16,\"source_document_id\":16,\"issue_date\":\"2026-01-15\",\"due_date\":\"2026-01-15\",\"frequency\":\"weekly\",\"next_issue_date\":\"2026-01-15\",\"end_date\":\"2026-01-15\",\"notes\":\"n\",\"external_reference\":\"g\",\"place_of_supply_state_code\":\"zm\",\"reverse_charge\":false,\"prices_include_tax\":false,\"lines\":[{\"item_id\":16,\"source_invoice_line_id\":16,\"source_document_line_id\":16,\"description\":\"Et animi quos velit et fugiat.\",\"quantity\":1,\"unit_price\":5,\"tax_rate\":19,\"cess_rate\":17,\"discount\":5,\"price_includes_tax\":false}]}" }, "description": "" }, "response": [] }, { "name": "GET api\/v1\/businesses\/{business}\/documents\/{document_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/documents\/:document_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/documents\/:document_id", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "document_id", "key": "document_id", "value": 1, "description": "The ID of the document." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST api\/v1\/businesses\/{business}\/documents\/{document_id}\/convert", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/documents\/:document_id\/convert", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/documents\/:document_id\/convert", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "document_id", "key": "document_id", "value": 1, "description": "The ID of the document." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Payments", "description": "", "item": [ { "name": "GET api\/v1\/businesses\/{business}\/payments", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/payments", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/payments", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"direction\":\"received\",\"from\":\"2026-01-15\",\"to\":\"2026-01-15\",\"per_page\":22}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST api\/v1\/businesses\/{business}\/payments", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/payments", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/payments", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"invoice_id\":16,\"business_document_id\":16,\"amount\":22,\"paid_on\":\"2026-01-15\",\"method\":\"cash\",\"payment_account_id\":16,\"reference\":\"n\",\"notes\":\"g\"}" }, "description": "" }, "response": [] } ] }, { "name": "Expenses", "description": "\nExpense records are a core Purchases capability on every plan. Workspace purchase permissions still apply.", "item": [ { "name": "List expenses.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/expenses", "query": [ { "key": "q", "value": "internet", "description": "Search category, payee, or description.", "disabled": false }, { "key": "category", "value": "Utilities", "description": "Filter by an exact category.", "disabled": false }, { "key": "payment_account_id", "value": "9", "description": "Filter by the payment account used.", "disabled": false }, { "key": "from", "value": "2026-08-01", "description": "Include expenses on or after this date (`YYYY-MM-DD`).", "disabled": false }, { "key": "to", "value": "2026-08-31", "description": "Include expenses on or before this date (`YYYY-MM-DD`).", "disabled": false }, { "key": "status", "value": "active", "description": "Filter by posting status.", "disabled": false }, { "key": "per_page", "value": "20", "description": "Results per page, from 1 to 100.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/expenses?q=internet&category=Utilities&payment_account_id=9&from=2026-08-01&to=2026-08-31&status=active&per_page=20", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Search and filter business expenses. The response includes totals for the current\nresult, the current month, and the retained voided audit trail." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 41,\n \"category\": \"Utilities\",\n \"payee\": \"City Internet Services\",\n \"amount_paise\": 249900,\n \"occurred_on\": \"2026-08-12\",\n \"payment_method\": \"bank\",\n \"payment_account_id\": 9,\n \"payment_account_name\": \"HDFC Current Account\",\n \"note\": \"August internet bill for the main shop\",\n \"voided_at\": null,\n \"void_reason\": null,\n \"created_at\": \"2026-08-12T10:30:00.000000Z\"\n }\n ],\n \"links\": {\n \"first\": \"https:\/\/example.com\/api\/v1\/businesses\/1\/expenses?page=1\",\n \"last\": \"https:\/\/example.com\/api\/v1\/businesses\/1\/expenses?page=1\",\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 1,\n \"path\": \"https:\/\/example.com\/api\/v1\/businesses\/1\/expenses\",\n \"per_page\": 20,\n \"to\": 1,\n \"total\": 1\n },\n \"summary\": {\n \"filtered_total_paise\": 249900,\n \"month_total_paise\": 384900,\n \"month_count\": 3,\n \"voided_count\": 1\n }\n}\n", "name": "" } ] }, { "name": "Post an expense atomically.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/expenses", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/expenses", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"category\":\"b\",\"payee\":\"n\",\"amount\":7,\"occurred_on\":\"2026-01-15\",\"payment_method\":\"cash\",\"payment_account_id\":16,\"note\":\"n\",\"idempotency_key\":\"6d61f406-f07d-482d-a284-3e06edfd7f55\"}" }, "description": "The expense, general-ledger journal, cash-drawer movement, and audit record either all commit or all roll back." }, "response": [] }, { "name": "GET api\/v1\/businesses\/{business}\/expenses\/{expense_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/expenses\/:expense_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/expenses\/:expense_id", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "expense_id", "key": "expense_id", "value": 1, "description": "The ID of the expense." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Void an expense atomically.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/expenses\/:expense_id\/void", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/expenses\/:expense_id\/void", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "expense_id", "key": "expense_id", "value": 1, "description": "The ID of the expense." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"b\"}" }, "description": "The void marker, journal reversal, cash-drawer reversal, and audit record either all commit or all roll back." }, "response": [] } ] }, { "name": "POS", "description": "", "item": [ { "name": "GET api\/v1\/businesses\/{business}\/pos\/items", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/pos\/items", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/pos\/items", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"q\":\"b\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET api\/v1\/businesses\/{business}\/pos\/upi", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/pos\/upi", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/pos\/upi", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"amount\":1,\"payment_account_id\":16}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "List held POS carts for the business.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/pos\/carts", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/pos\/carts", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Hold a POS cart for later checkout.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/pos\/carts", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/pos\/carts", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"contact_id\":16,\"lines\":[{\"item_id\":16,\"quantity\":4326.41688}]}" }, "description": "" }, "response": [] }, { "name": "POST api\/v1\/businesses\/{business}\/pos\/checkout", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/pos\/checkout", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/pos\/checkout", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"contact_id\":16,\"idempotency_key\":\"a4855dc5-0acb-33c3-b921-f4291f719ca0\",\"cart_id\":16,\"lines\":[{\"item_id\":16,\"quantity\":4326.41688,\"discount\":77}],\"payments\":[{\"method\":\"cash\",\"payment_account_id\":16,\"amount\":4326.41688}]}" }, "description": "" }, "response": [] } ] }, { "name": "Cash register", "description": "", "item": [ { "name": "GET api\/v1\/businesses\/{business}\/cash-register", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/cash-register", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/cash-register", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"cash_register_id\":16}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST api\/v1\/businesses\/{business}\/cash-register\/open", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/cash-register\/open", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/cash-register\/open", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"cash_register_id\":16,\"opening_float\":22}" }, "description": "" }, "response": [] }, { "name": "POST api\/v1\/businesses\/{business}\/cash-register\/movements", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/cash-register\/movements", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/cash-register\/movements", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"cash_in\",\"cash_register_id\":16,\"amount\":22,\"notes\":\"g\"}" }, "description": "" }, "response": [] }, { "name": "POST api\/v1\/businesses\/{business}\/cash-register\/close", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/cash-register\/close", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/cash-register\/close", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"counted_cash\":1,\"cash_register_id\":16,\"closing_notes\":\"n\"}" }, "description": "" }, "response": [] } ] }, { "name": "Reports", "description": "", "item": [ { "name": "GET api\/v1\/businesses\/{business}\/reports", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/reports", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/reports", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"from\":\"2026-01-15\",\"to\":\"2026-01-15\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Business compliance guidance", "description": "", "item": [ { "name": "Get the compliance profile, registrations, evidence metadata and assessed obligations.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business_id\/compliance", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business_id\/compliance", "variable": [ { "id": "business_id", "key": "business_id", "value": 1, "description": "The ID of the business." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"business_id\": 16,\n \"state_code\": \"29\",\n \"profile\": {\n \"constitution\": \"proprietorship\",\n \"masked_pan\": \"ABC****34F\",\n \"district\": \"Bengaluru Urban\",\n \"local_body\": \"BBMP\",\n \"premises_type\": \"rented\",\n \"supply_type\": \"both\",\n \"gst_registration_status\": \"not_registered\",\n \"previous_year_turnover_paise\": 180000000,\n \"other_pan_turnover_paise\": 25000000,\n \"employee_count\": 4,\n \"contract_worker_count\": 0,\n \"female_employee_count\": 2,\n \"interstate_sales\": false,\n \"ecommerce_sales\": true,\n \"imports\": false,\n \"exports\": false,\n \"manufactures\": false,\n \"food_business\": true,\n \"uses_weighing_scale\": true,\n \"packs_or_imports_goods\": false,\n \"pharmacy\": false,\n \"serves_alcohol\": false,\n \"fire_risk\": false,\n \"pollution_activity\": false,\n \"reminder_days\": [90, 60, 30, 7, 0],\n \"assessment_completed_at\": \"2026-08-20T12:00:00+05:30\",\n \"next_review_at\": \"2026-11-20T12:00:00+05:30\"\n },\n \"categories\": [{\"id\": 13, \"slug\": \"food-service\", \"name\": \"Restaurant, caf\u00e9 and food service\", \"nic_section\": \"I\"}],\n \"gst_registrations\": [],\n \"obligations\": [{\n \"id\": 81,\n \"rule_code\": \"fssai-registration-licence\",\n \"rule_version\": 1,\n \"title\": \"FSSAI registration or food licence\",\n \"applicability_reason\": \"Every food business operator must hold the matching registration or licence. Matched using Guidance Shop facts.\",\n \"applicability_level\": \"required\",\n \"obligation_type\": \"licence\",\n \"authority_name\": \"Food Safety and Standards Authority of India\",\n \"source_url\": \"https:\/\/fssai.gov.in\/business\/registration\",\n \"application_url\": \"https:\/\/foscos.fssai.gov.in\/\",\n \"status\": \"action_required\",\n \"reference_number\": null,\n \"issued_on\": null,\n \"due_on\": null,\n \"expires_on\": null,\n \"notes\": null,\n \"manual_override\": false,\n \"last_assessed_at\": \"2026-08-20T12:00:00+05:30\",\n \"documents\": []\n }],\n \"guidance_notice\": \"Guidance is generated from configurable rules and recorded business facts. Review items marked professional review and verify official sources before relying on them.\",\n \"options\": {\n \"constitutions\": {\n \"proprietorship\": \"Proprietorship\",\n \"partnership\": \"Partnership firm\",\n \"llp\": \"Limited Liability Partnership\",\n \"private_limited\": \"Private limited company\",\n \"public_limited\": \"Public limited company\",\n \"opc\": \"One Person Company\",\n \"huf\": \"Hindu Undivided Family\",\n \"trust_society\": \"Trust \/ society\",\n \"cooperative\": \"Co-operative society\",\n \"government\": \"Government entity\",\n \"other\": \"Other\"\n },\n \"supply_types\": {\"goods\": \"Goods only\", \"services\": \"Services only\", \"both\": \"Goods and services\"},\n \"gst_statuses\": {\n \"not_assessed\": \"Not assessed\",\n \"not_registered\": \"Not registered\",\n \"pending\": \"Application pending\",\n \"active\": \"Registered \/ active\",\n \"suspended\": \"Suspended\",\n \"cancelled\": \"Cancelled \/ surrendered\"\n },\n \"gst_registration_types\": {\n \"normal\": \"Normal taxpayer\",\n \"composition\": \"Composition taxpayer\",\n \"casual\": \"Casual taxable person\",\n \"non_resident\": \"Non-resident taxable person\",\n \"isd\": \"Input Service Distributor (ISD)\",\n \"tds\": \"Tax Deductor (TDS)\",\n \"tcs\": \"Tax Collector \/ e-commerce operator (TCS)\",\n \"sez_unit\": \"SEZ unit\",\n \"sez_developer\": \"SEZ developer\",\n \"oidar\": \"OIDAR \/ online money gaming supplier\",\n \"uin\": \"Unique Identity Number holder\",\n \"temporary\": \"Temporary registration\"\n }\n }\n },\n \"meta\": {\n \"available_categories\": [{\"id\": 13, \"slug\": \"food-service\", \"name\": \"Restaurant, caf\u00e9 and food service\", \"nic_section\": \"I\", \"description\": \"Restaurants, caf\u00e9s, caterers, cloud kitchens and mobile food service.\"}]\n }\n}\n", "name": "" } ] }, { "name": "Update business facts and immediately run the deterministic compliance assessment.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business_id\/compliance\/profile", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business_id\/compliance\/profile", "variable": [ { "id": "business_id", "key": "business_id", "value": 1, "description": "The ID of the business." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"state_code\":\"29\",\"category_ids\":[13],\"constitution\":\"proprietorship\",\"pan\":\"ABCDE1234F\",\"district\":\"Bengaluru Urban\",\"local_body\":\"BBMP\",\"premises_type\":\"rented\",\"supply_type\":\"both\",\"gst_registration_status\":\"not_registered\",\"previous_year_turnover\":1800000,\"other_pan_turnover\":250000,\"employee_count\":4,\"contract_worker_count\":0,\"female_employee_count\":2,\"interstate_sales\":false,\"ecommerce_sales\":true,\"imports\":false,\"exports\":false,\"manufactures\":false,\"food_business\":true,\"uses_weighing_scale\":true,\"packs_or_imports_goods\":false,\"pharmacy\":false,\"serves_alcohol\":false,\"fire_risk\":false,\"pollution_activity\":false,\"reminder_days\":[90,60,30,7,0]}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"business_id\": 16,\n \"state_code\": \"29\",\n \"profile\": {\n \"constitution\": \"proprietorship\",\n \"masked_pan\": \"ABC****34F\",\n \"district\": \"Bengaluru Urban\",\n \"local_body\": \"BBMP\",\n \"premises_type\": \"rented\",\n \"supply_type\": \"both\",\n \"gst_registration_status\": \"not_registered\",\n \"previous_year_turnover_paise\": 180000000,\n \"other_pan_turnover_paise\": 25000000,\n \"employee_count\": 4,\n \"contract_worker_count\": 0,\n \"female_employee_count\": 2,\n \"interstate_sales\": false,\n \"ecommerce_sales\": true,\n \"imports\": false,\n \"exports\": false,\n \"manufactures\": false,\n \"food_business\": true,\n \"uses_weighing_scale\": true,\n \"packs_or_imports_goods\": false,\n \"pharmacy\": false,\n \"serves_alcohol\": false,\n \"fire_risk\": false,\n \"pollution_activity\": false,\n \"reminder_days\": [90, 60, 30, 7, 0],\n \"assessment_completed_at\": \"2026-08-20T12:00:00+05:30\",\n \"next_review_at\": \"2026-11-20T12:00:00+05:30\"\n },\n \"categories\": [{\"id\": 13, \"slug\": \"food-service\", \"name\": \"Restaurant, caf\u00e9 and food service\", \"nic_section\": \"I\"}],\n \"gst_registrations\": [],\n \"obligations\": [{\n \"id\": 81,\n \"rule_code\": \"fssai-registration-licence\",\n \"rule_version\": 1,\n \"title\": \"FSSAI registration or food licence\",\n \"applicability_reason\": \"Every food business operator must hold the matching registration or licence. Matched using Guidance Shop facts.\",\n \"applicability_level\": \"required\",\n \"obligation_type\": \"licence\",\n \"authority_name\": \"Food Safety and Standards Authority of India\",\n \"source_url\": \"https:\/\/fssai.gov.in\/business\/registration\",\n \"application_url\": \"https:\/\/foscos.fssai.gov.in\/\",\n \"status\": \"action_required\",\n \"reference_number\": null,\n \"issued_on\": null,\n \"due_on\": null,\n \"expires_on\": null,\n \"notes\": null,\n \"manual_override\": false,\n \"last_assessed_at\": \"2026-08-20T12:00:00+05:30\",\n \"documents\": []\n }],\n \"guidance_notice\": \"Guidance is generated from configurable rules and recorded business facts. Review items marked professional review and verify official sources before relying on them.\",\n \"options\": {\n \"constitutions\": {\n \"proprietorship\": \"Proprietorship\",\n \"partnership\": \"Partnership firm\",\n \"llp\": \"Limited Liability Partnership\",\n \"private_limited\": \"Private limited company\",\n \"public_limited\": \"Public limited company\",\n \"opc\": \"One Person Company\",\n \"huf\": \"Hindu Undivided Family\",\n \"trust_society\": \"Trust \/ society\",\n \"cooperative\": \"Co-operative society\",\n \"government\": \"Government entity\",\n \"other\": \"Other\"\n },\n \"supply_types\": {\"goods\": \"Goods only\", \"services\": \"Services only\", \"both\": \"Goods and services\"},\n \"gst_statuses\": {\n \"not_assessed\": \"Not assessed\",\n \"not_registered\": \"Not registered\",\n \"pending\": \"Application pending\",\n \"active\": \"Registered \/ active\",\n \"suspended\": \"Suspended\",\n \"cancelled\": \"Cancelled \/ surrendered\"\n },\n \"gst_registration_types\": {\n \"normal\": \"Normal taxpayer\",\n \"composition\": \"Composition taxpayer\",\n \"casual\": \"Casual taxable person\",\n \"non_resident\": \"Non-resident taxable person\",\n \"isd\": \"Input Service Distributor (ISD)\",\n \"tds\": \"Tax Deductor (TDS)\",\n \"tcs\": \"Tax Collector \/ e-commerce operator (TCS)\",\n \"sez_unit\": \"SEZ unit\",\n \"sez_developer\": \"SEZ developer\",\n \"oidar\": \"OIDAR \/ online money gaming supplier\",\n \"uin\": \"Unique Identity Number holder\",\n \"temporary\": \"Temporary registration\"\n }\n }\n },\n \"meta\": {\n \"available_categories\": [{\"id\": 13, \"slug\": \"food-service\", \"name\": \"Restaurant, caf\u00e9 and food service\", \"nic_section\": \"I\", \"description\": \"Restaurants, caf\u00e9s, caterers, cloud kitchens and mobile food service.\"}]\n }\n}\n", "name": "" } ] }, { "name": "Re-run assessment against the latest published rule revisions.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business_id\/compliance\/assess", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business_id\/compliance\/assess", "variable": [ { "id": "business_id", "key": "business_id", "value": 1, "description": "The ID of the business." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"matched\":8,\"closed\":1}}", "name": "" } ] }, { "name": "POST api\/v1\/businesses\/{business_id}\/compliance\/gst-registrations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business_id\/compliance\/gst-registrations", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business_id\/compliance\/gst-registrations", "variable": [ { "id": "business_id", "key": "business_id", "value": 1, "description": "The ID of the business." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"registration_type\":\"composition\",\"registration_status\":\"active\",\"gstin\":\"29ABCDE1234F1Z5\",\"uin\":null,\"state_code\":\"29\",\"is_primary\":true,\"valid_from\":\"2026-04-01\",\"valid_until\":null}" }, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"data\": {\n \"id\": 32,\n \"business_id\": 16,\n \"registration_type\": \"composition\",\n \"registration_status\": \"active\",\n \"gstin\": \"29ABCDE1234F1Z5\",\n \"uin\": null,\n \"state_code\": \"29\",\n \"is_primary\": true,\n \"valid_from\": \"2026-04-01T00:00:00.000000Z\",\n \"valid_until\": null,\n \"created_at\": \"2026-08-20T06:30:00.000000Z\",\n \"updated_at\": \"2026-08-20T06:30:00.000000Z\"\n }\n}\n", "name": "" } ] }, { "name": "DELETE api\/v1\/businesses\/{business_id}\/compliance\/gst-registrations\/{gstRegistration_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business_id\/compliance\/gst-registrations\/:gstRegistration_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business_id\/compliance\/gst-registrations\/:gstRegistration_id", "variable": [ { "id": "business_id", "key": "business_id", "value": 1, "description": "The ID of the business." }, { "id": "gstRegistration_id", "key": "gstRegistration_id", "value": 1, "description": "The ID of the gstRegistration." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "GET api\/v1\/businesses\/{business_id}\/compliance\/obligations\/{complianceObligation_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business_id\/compliance\/obligations\/:complianceObligation_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business_id\/compliance\/obligations\/:complianceObligation_id", "variable": [ { "id": "business_id", "key": "business_id", "value": 1, "description": "The ID of the business." }, { "id": "complianceObligation_id", "key": "complianceObligation_id", "value": 1, "description": "The ID of the complianceObligation." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 81,\n \"rule_code\": \"fssai-registration-licence\",\n \"rule_version\": 1,\n \"title\": \"FSSAI registration or food licence\",\n \"applicability_reason\": \"Every food business operator must hold the matching registration or licence. Matched using Guidance Shop facts.\",\n \"applicability_level\": \"required\",\n \"obligation_type\": \"licence\",\n \"authority_name\": \"Food Safety and Standards Authority of India\",\n \"source_url\": \"https:\/\/fssai.gov.in\/business\/registration\",\n \"application_url\": \"https:\/\/foscos.fssai.gov.in\/\",\n \"status\": \"obtained\",\n \"reference_number\": \"FSSAI-10010022000123\",\n \"issued_on\": \"2026-04-01\",\n \"due_on\": null,\n \"expires_on\": \"2027-03-31\",\n \"notes\": \"Certificate verified.\",\n \"manual_override\": false,\n \"last_assessed_at\": \"2026-08-20T12:00:00+05:30\",\n \"documents\": [{\n \"id\": 44,\n \"original_name\": \"fssai-certificate.pdf\",\n \"mime_type\": \"application\/pdf\",\n \"size\": 102400,\n \"document_number\": \"FSSAI-10010022000123\",\n \"issued_on\": \"2026-04-01\",\n \"expires_on\": \"2027-03-31\",\n \"is_current\": true,\n \"download_url\": \"https:\/\/billing.example.com\/api\/v1\/businesses\/16\/compliance\/documents\/44\/download\"\n }]\n }\n}\n", "name": "" } ] }, { "name": "PATCH api\/v1\/businesses\/{business_id}\/compliance\/obligations\/{complianceObligation_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business_id\/compliance\/obligations\/:complianceObligation_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business_id\/compliance\/obligations\/:complianceObligation_id", "variable": [ { "id": "business_id", "key": "business_id", "value": 1, "description": "The ID of the business." }, { "id": "complianceObligation_id", "key": "complianceObligation_id", "value": 1, "description": "The ID of the complianceObligation." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"status\":\"obtained\",\"reference_number\":\"LIC-2026-1001\",\"issued_on\":\"2026-04-01\",\"due_on\":null,\"expires_on\":\"2027-03-31\",\"notes\":\"Renewal filed by the accountant.\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 81,\n \"rule_code\": \"fssai-registration-licence\",\n \"rule_version\": 1,\n \"title\": \"FSSAI registration or food licence\",\n \"applicability_reason\": \"Every food business operator must hold the matching registration or licence. Matched using Guidance Shop facts.\",\n \"applicability_level\": \"required\",\n \"obligation_type\": \"licence\",\n \"authority_name\": \"Food Safety and Standards Authority of India\",\n \"source_url\": \"https:\/\/fssai.gov.in\/business\/registration\",\n \"application_url\": \"https:\/\/foscos.fssai.gov.in\/\",\n \"status\": \"obtained\",\n \"reference_number\": \"FSSAI-10010022000123\",\n \"issued_on\": \"2026-04-01\",\n \"due_on\": null,\n \"expires_on\": \"2027-03-31\",\n \"notes\": \"Certificate verified.\",\n \"manual_override\": false,\n \"last_assessed_at\": \"2026-08-20T12:00:00+05:30\",\n \"documents\": [{\n \"id\": 44,\n \"original_name\": \"fssai-certificate.pdf\",\n \"mime_type\": \"application\/pdf\",\n \"size\": 102400,\n \"document_number\": \"FSSAI-10010022000123\",\n \"issued_on\": \"2026-04-01\",\n \"expires_on\": \"2027-03-31\",\n \"is_current\": true,\n \"download_url\": \"https:\/\/billing.example.com\/api\/v1\/businesses\/16\/compliance\/documents\/44\/download\"\n }]\n }\n}\n", "name": "" } ] }, { "name": "POST api\/v1\/businesses\/{business_id}\/compliance\/obligations\/{complianceObligation_id}\/documents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business_id\/compliance\/obligations\/:complianceObligation_id\/documents", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business_id\/compliance\/obligations\/:complianceObligation_id\/documents", "variable": [ { "id": "business_id", "key": "business_id", "value": 1, "description": "The ID of the business." }, { "id": "complianceObligation_id", "key": "complianceObligation_id", "value": 1, "description": "The ID of the complianceObligation." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "document_number", "value": "FSSAI-10010022000123", "type": "text", "description": "Certificate or licence number. Must not be greater than 128 characters." }, { "key": "issued_on", "value": "2026-04-01", "type": "text", "description": "Must be a valid date." }, { "key": "expires_on", "value": "2027-03-31", "type": "text", "description": "Must be a valid date. Must be a date after or equal to issued_on<\/code>." }, { "key": "document", "src": [], "type": "file" } ] }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 81,\n \"rule_code\": \"fssai-registration-licence\",\n \"rule_version\": 1,\n \"title\": \"FSSAI registration or food licence\",\n \"applicability_reason\": \"Every food business operator must hold the matching registration or licence. Matched using Guidance Shop facts.\",\n \"applicability_level\": \"required\",\n \"obligation_type\": \"licence\",\n \"authority_name\": \"Food Safety and Standards Authority of India\",\n \"source_url\": \"https:\/\/fssai.gov.in\/business\/registration\",\n \"application_url\": \"https:\/\/foscos.fssai.gov.in\/\",\n \"status\": \"obtained\",\n \"reference_number\": \"FSSAI-10010022000123\",\n \"issued_on\": \"2026-04-01\",\n \"due_on\": null,\n \"expires_on\": \"2027-03-31\",\n \"notes\": \"Certificate verified.\",\n \"manual_override\": false,\n \"last_assessed_at\": \"2026-08-20T12:00:00+05:30\",\n \"documents\": [{\n \"id\": 44,\n \"original_name\": \"fssai-certificate.pdf\",\n \"mime_type\": \"application\/pdf\",\n \"size\": 102400,\n \"document_number\": \"FSSAI-10010022000123\",\n \"issued_on\": \"2026-04-01\",\n \"expires_on\": \"2027-03-31\",\n \"is_current\": true,\n \"download_url\": \"https:\/\/billing.example.com\/api\/v1\/businesses\/16\/compliance\/documents\/44\/download\"\n }]\n }\n}\n", "name": "" } ] }, { "name": "GET api\/v1\/businesses\/{business_id}\/compliance\/documents\/{complianceDocument_id}\/download", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business_id\/compliance\/documents\/:complianceDocument_id\/download", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business_id\/compliance\/documents\/:complianceDocument_id\/download", "variable": [ { "id": "business_id", "key": "business_id", "value": 1, "description": "The ID of the business." }, { "id": "complianceDocument_id", "key": "complianceDocument_id", "value": 1, "description": "The ID of the complianceDocument." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "GST compliance", "description": "", "item": [ { "name": "GET api\/v1\/businesses\/{business}\/gst", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/gst", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/gst", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET api\/v1\/businesses\/{business}\/gst\/gstr1", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/gst\/gstr1", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/gst\/gstr1", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST api\/v1\/businesses\/{business}\/gst\/gstr2b", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/gst\/gstr2b", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/gst\/gstr2b", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Billing", "description": "", "item": [ { "name": "List plans and activation availability", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/billing", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/billing", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Use `razorpay_checkout_enabled` for paid checkout. `paid_plan_activation_enabled` refers only to the\nsupport-only manual activation fallback, while each plan's `activation_available` covers either path." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "List subscription payments", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/billing\/payments", "query": [ { "key": "per_page", "value": "20", "description": "Results per page.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/billing\/payments?per_page=20", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns successful subscription charges and mandate authorisations for the business owner.\nOnly captured recurring charges expose an invoice download URL." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Download a subscription invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/billing\/payments\/:subscriptionPayment_id\/invoice", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/billing\/payments\/:subscriptionPayment_id\/invoice", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "subscriptionPayment_id", "key": "subscriptionPayment_id", "value": 1, "description": "The ID of the subscriptionPayment." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Downloads the immutable PDF invoice for a captured recurring subscription charge." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Change the current plan", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/billing\/change", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/billing\/change", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"plan_id\":\"architecto\",\"billing_interval\":\"monthly\"}" }, "description": "Paid plans return HTTP 422 while online paid-plan activation is disabled. The free plan remains selectable.\nChanging away from a Razorpay-backed plan cancels that provider subscription immediately before the new\nplan is activated, so mobile clients must confirm an immediate loss of paid access before submitting. If\nRazorpay cannot confirm cancellation, the endpoint returns HTTP 422 and leaves the current plan unchanged." }, "response": [ { "header": [], "code": 422, "body": "{\"message\":\"Online paid-plan activation is not configured. Contact support to change this plan.\",\"errors\":{\"plan_id\":[\"Online paid-plan activation is not configured. Contact support to change this plan.\"]}}", "name": "" } ] }, { "name": "Start Razorpay subscription checkout", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/billing\/checkout", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/billing\/checkout", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"plan_id\":\"architecto\",\"billing_interval\":\"monthly\"}" }, "description": "Creates a price-versioned Razorpay subscription. Mobile clients must pass the returned `subscription_id`\nto Razorpay Standard Checkout and then send the signed result to the confirm endpoint." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"checkout_id\":1,\"key\":\"rzp_test_example\",\"subscription_id\":\"sub_example\",\"name\":\"Dukanam\",\"description\":\"Smart Books \u00b7 Monthly\",\"amount_paise\":99900,\"currency\":\"INR\",\"trial_days\":14,\"prefill\":{\"name\":\"Shop Owner\",\"email\":\"owner@example.com\",\"contact\":\"9876543210\"}}}", "name": "" } ] }, { "name": "Confirm Razorpay subscription authorisation", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/billing\/checkouts\/:billingCheckout_id\/confirm", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/billing\/checkouts\/:billingCheckout_id\/confirm", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "billingCheckout_id", "key": "billingCheckout_id", "value": 1, "description": "The ID of the billingCheckout." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"razorpay_payment_id\":\"b\",\"razorpay_subscription_id\":\"n\",\"razorpay_signature\":\"gzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtn\"}" }, "description": "The server verifies the Razorpay HMAC signature and fetches provider state before granting access.\nTrial access starts only after successful payment-method authorisation; a plan without a trial waits\nfor Razorpay to report the subscription as active. When the checkout replaces another Razorpay plan,\nthe previous provider subscription is cancelled immediately before the replacement is activated." }, "response": [] }, { "name": "POST api\/v1\/businesses\/{business}\/billing\/cancel", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/billing\/cancel", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/billing\/cancel", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Data exports", "description": "", "item": [ { "name": "Export business data", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/exports", "query": [ { "key": "type", "value": "invoices", "description": "Export type.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/exports?type=invoices", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"contacts\"}" }, "description": "CSV exports are intended for reporting and use `dukanam-{type}-YYYY-MM-DD.csv` filenames. The legacy\n`business-backup` type returns a `dukanam-business-export-v2` owner\/admin-only customer-data portability\nexport named `dukanam-business-export-YYYY-MM-DD.json`. It includes item photos and compliance evidence\ncontent, but is not a restorable platform backup." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Team access", "description": "\nOwners and administrators can manage workspace members. Smart Books supports one accountant seat in addition to the owner. Business supports all documented roles, with five total seats including the owner and pending invitations.", "item": [ { "name": "List team members, pending invitations, and the 25 most recent expired invitations.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/team", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/team", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"members\":[{\"id\":2,\"name\":\"Priya Rao\",\"email\":\"priya@example.com\",\"role\":\"cashier\",\"status\":\"active\",\"joined_at\":\"2026-08-21T12:00:00.000000Z\"}],\"invitations\":[],\"roles\":{\"cashier\":{\"label\":\"Cashier\",\"description\":\"POS, sales, and cash register access.\"},\"accountant\":{\"label\":\"Accountant\",\"description\":\"Sales, purchases, inventory, accounting, reports, compliance, and exports.\"}},\"seats\":{\"used\":2,\"limit\":5,\"active\":2,\"pending\":0}}}", "name": "" } ] }, { "name": "Invite a team member.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/team\/invitations", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/team\/invitations", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"cashier@example.com\",\"role\":\"cashier\"}" }, "description": "Pending invitations reserve a seat and expire after seven days." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":12,\"email\":\"cashier@example.com\",\"role\":\"cashier\",\"status\":\"pending\",\"expires_at\":\"2026-08-28T12:00:00.000000Z\",\"accepted_at\":null,\"invited_by\":{\"id\":1,\"name\":\"Workspace Owner\"}}}", "name": "" } ] }, { "name": "Resend a pending or expired invitation with a new secure token.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/team\/invitations\/:teamInvitation_id\/resend", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/team\/invitations\/:teamInvitation_id\/resend", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "teamInvitation_id", "key": "teamInvitation_id", "value": 1, "description": "The ID of the teamInvitation." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":12,\"email\":\"cashier@example.com\",\"role\":\"cashier\",\"status\":\"pending\",\"expires_at\":\"2026-08-28T12:00:00.000000Z\",\"accepted_at\":null,\"invited_by\":{\"id\":1,\"name\":\"Workspace Owner\"}}}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"All 2 workspace seats are already assigned or reserved.\",\"errors\":{\"email\":[\"All 2 workspace seats are already assigned or reserved.\"]}}", "name": "" } ] }, { "name": "Cancel a pending invitation and release its reserved seat.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/team\/invitations\/:teamInvitation_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/team\/invitations\/:teamInvitation_id", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "teamInvitation_id", "key": "teamInvitation_id", "value": 1, "description": "The ID of the teamInvitation." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" }, { "header": [], "code": 403, "body": "{\"message\":\"Only the owner can manage administrator invitations.\"}", "name": "" } ] }, { "name": "Change a member's role or suspend\/reactivate access.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/team\/members\/:member_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/team\/members\/:member_id", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "member_id", "key": "member_id", "value": 1, "description": "The ID of the member." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"role\":\"manager\",\"status\":\"active\"}" }, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":2,\"name\":\"Priya Rao\",\"email\":\"priya@example.com\",\"role\":\"manager\",\"status\":\"active\",\"joined_at\":\"2026-08-21T12:00:00.000000Z\"}}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"All 2 workspace seats are already assigned or reserved.\",\"errors\":{\"role\":[\"All 2 workspace seats are already assigned or reserved.\"],\"status\":[\"All 2 workspace seats are already assigned or reserved.\"]}}", "name": "" } ] }, { "name": "Remove a member's workspace access without deleting their user account.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/team\/members\/:member_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/team\/members\/:member_id", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "member_id", "key": "member_id", "value": 1, "description": "The ID of the member." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] } ] }, { "name": "Team invitations", "description": "", "item": [ { "name": "Accept a team invitation as an existing user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/team-invitations\/:token\/accept", "query": [], "raw": "{{baseUrl}}\/api\/v1\/team-invitations\/:token\/accept", "variable": [ { "id": "token", "key": "token", "value": "4WvBr4F8Dmcx3FJkL1nEz7PcQs2Yu9Aa", "description": "The opaque token from the invitation email." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Send a valid Sanctum bearer token belonging to the invited email. This endpoint does not create a new token." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"user\":{\"id\":2,\"name\":\"Priya Rao\",\"email\":\"cashier@example.com\"},\"business\":{\"id\":1,\"name\":\"Anika Stores\",\"role\":\"cashier\"}}}", "name": "" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"email\":[\"Sign in with the email address that received this invitation.\"],\"invitation\":[\"This workspace is no longer available.\"]}}", "name": "" } ] }, { "name": "Inspect a team invitation.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/team-invitations\/:token", "query": [], "raw": "{{baseUrl}}\/api\/v1\/team-invitations\/:token", "variable": [ { "id": "token", "key": "token", "value": "4WvBr4F8Dmcx3FJkL1nEz7PcQs2Yu9Aa", "description": "The opaque token from the invitation email." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint does not require authentication. The opaque token is supplied by the invitation email.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"business\":{\"id\":1,\"name\":\"Anika Stores\"},\"email\":\"cashier@example.com\",\"role\":\"cashier\",\"role_label\":\"Cashier\",\"status\":\"pending\",\"expires_at\":\"2026-08-28T12:00:00.000000Z\",\"existing_account\":false}}", "name": "" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "" } ] }, { "name": "Create an account and accept a team invitation.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/team-invitations\/:token\/register-and-accept", "query": [], "raw": "{{baseUrl}}\/api\/v1\/team-invitations\/:token\/register-and-accept", "variable": [ { "id": "token", "key": "token", "value": "4WvBr4F8Dmcx3FJkL1nEz7PcQs2Yu9Aa", "description": "The opaque token from the invitation email." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Priya Rao\",\"password\":\"secret-pass-123\",\"device_name\":\"Priya's phone\",\"password_confirmation\":\"secret-pass-123\"}" }, "description": "Use this unauthenticated endpoint only when the invited email does not already belong to a Dukanam user. The response includes a new Sanctum device token.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"user\":{\"id\":2,\"name\":\"Priya Rao\",\"email\":\"cashier@example.com\"},\"business\":{\"id\":1,\"name\":\"Anika Stores\",\"role\":\"cashier\"},\"token\":\"1|new-mobile-token\"}}", "name": "" }, { "header": [], "code": 403, "body": "{\"message\":\"Sign in as the invited user to accept this invitation.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\":\"This invitation has expired or is no longer available.\",\"errors\":{\"invitation\":[\"This invitation has expired or is no longer available.\"]}}", "name": "" } ] } ] }, { "name": "Billing webhooks", "description": "", "item": [ { "name": "Receive Razorpay subscription events", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/webhooks\/razorpay", "query": [], "raw": "{{baseUrl}}\/api\/v1\/webhooks\/razorpay" }, "method": "POST", "header": [ { "key": "X-Razorpay-Signature", "value": "string required Razorpay webhook HMAC signature. Example: 0123456789abcdef" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This public provider callback requires a valid `X-Razorpay-Signature` HMAC header and is idempotent.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"received\":true}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Invalid webhook signature.\"}", "name": "" } ] } ] }, { "name": "Lookups", "description": "\nSearch tenant-scoped values for lookup controls. Results are limited to the active business and the caller's workspace permissions and plan features.", "item": [ { "name": "Search lookup values.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/lookups", "query": [ { "key": "source", "value": "customers", "description": "Lookup source.", "disabled": false }, { "key": "q", "value": "priya", "description": "Search text, up to 100 characters.", "disabled": false }, { "key": "method", "value": "upi", "description": "Payment method used to filter compatible payment accounts.", "disabled": false }, { "key": "direction", "value": "received", "description": "Document or account direction.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/lookups?source=customers&q=priya&method=upi&direction=received", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"value\":\"42\",\"label\":\"Priya Sharma\",\"meta\":\"Customer \u00b7 9876543210\",\"attributes\":{\"type\":\"customer\",\"phone\":\"9876543210\"}}],\"meta\":{\"source\":\"customers\",\"query\":\"priya\",\"has_more\":false}}", "name": "" } ] } ] }, { "name": "Payment accounts", "description": "", "item": [ { "name": "GET api\/v1\/businesses\/{business}\/payment-accounts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/payment-accounts", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/payment-accounts", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST api\/v1\/businesses\/{business}\/payment-accounts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/payment-accounts", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/payment-accounts", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "PATCH api\/v1\/businesses\/{business}\/payment-accounts\/{paymentAccount_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/payment-accounts\/:paymentAccount_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/payment-accounts\/:paymentAccount_id", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "paymentAccount_id", "key": "paymentAccount_id", "value": 1, "description": "The ID of the paymentAccount." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "POST api\/v1\/businesses\/{business}\/payment-accounts\/transfer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/payment-accounts\/transfer", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/payment-accounts\/transfer", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"from_payment_account_id\":16,\"to_payment_account_id\":16,\"amount\":4326.41688,\"transferred_on\":\"2026-01-15\",\"reference\":\"m\",\"notes\":\"i\"}" }, "description": "" }, "response": [] }, { "name": "Show eligible transactions and statement-reconciliation history.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/payment-accounts\/:paymentAccount_id\/reconciliation", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/payment-accounts\/:paymentAccount_id\/reconciliation", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "paymentAccount_id", "key": "paymentAccount_id", "value": 1, "description": "The ID of the paymentAccount." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"statement_date\":\"2026-01-15\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-content-type-options", "value": "nosniff" }, { "key": "x-frame-options", "value": "DENY" }, { "key": "referrer-policy", "value": "strict-origin-when-cross-origin" }, { "key": "permissions-policy", "value": "camera=(), microphone=(), geolocation=()" }, { "key": "cross-origin-opener-policy", "value": "same-origin" }, { "key": "x-robots-tag", "value": "noindex, nofollow" }, { "key": "strict-transport-security", "value": "max-age=31536000; includeSubDomains" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Complete and lock a statement reconciliation.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/payment-accounts\/:paymentAccount_id\/reconciliation", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/payment-accounts\/:paymentAccount_id\/reconciliation", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "paymentAccount_id", "key": "paymentAccount_id", "value": 1, "description": "The ID of the paymentAccount." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"statement_date\":\"2026-01-15\",\"statement_balance\":-999999998,\"transaction_ids\":[16],\"notes\":\"n\"}" }, "description": "" }, "response": [] }, { "name": "POST api\/v1\/businesses\/{business}\/payment-accounts\/{paymentAccount_id}\/reconcile\/{journalLine_id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/businesses\/:business\/payment-accounts\/:paymentAccount_id\/reconcile\/:journalLine_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/businesses\/:business\/payment-accounts\/:paymentAccount_id\/reconcile\/:journalLine_id", "variable": [ { "id": "business", "key": "business", "value": 1, "description": "The business." }, { "id": "paymentAccount_id", "key": "paymentAccount_id", "value": 1, "description": "The ID of the paymentAccount." }, { "id": "journalLine_id", "key": "journalLine_id", "value": 1, "description": "The ID of the journalLine." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }