{ "item": [ { "id": "928bfd2d-49e2-4a24-8afc-e090c9753528", "name": "Customers", "description": { "content": "Customers are the people and businesses you invoice. A customer carries its contact details, billing and shipping addresses, contacts, and tax settings.", "type": "text/plain" }, "item": [ { "id": "51726c29-0949-4057-ad1a-b991ac101589", "name": "Returns a paginated list of customers in the workspace.", "request": { "name": "Returns a paginated list of customers in the workspace.", "description": { "content": "Customers are returned with their billing/shipping addresses, contacts, taxes, and sales rep embedded. Use search, status, and ordering to narrow the results. The response includes a `filters` object echoing applied query parameters.", "type": "text/plain" }, "url": { "path": [ "partners", "customers" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "search", "value": "", "description": "Partial, case-insensitive match across the customer name, contact name, and contact phone numbers." }, { "disabled": false, "key": "status", "value": "", "description": "Filters by customer status." }, { "disabled": false, "key": "orderBy", "value": "", "description": "Field to sort results by. Defaults to customer." }, { "disabled": false, "key": "orderDirection", "value": "", "description": "Sort direction. Defaults to ASC." }, { "disabled": false, "key": "page", "value": "", "description": "Page number for pagination. The first page is 1." }, { "disabled": false, "key": "limit", "value": "", "description": "Records to return per page." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "abbd3bd2-1953-4235-8370-b4c88f95a359", "name": "Paginated list of customers.", "originalRequest": { "url": { "path": [ "partners", "customers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "acme" }, { "key": "status", "value": "" }, { "key": "orderBy", "value": "" }, { "key": "orderDirection", "value": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on fetching customers.\",\n \"data\": {\n \"page\": 1,\n \"limit\": 20,\n \"totalRecords\": 1,\n \"totalPages\": 1,\n \"records\": [\n {\n \"id\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\",\n \"email\": \"contact@acme.com\",\n \"mainPhone\": \"+1234567890\",\n \"website\": \"https://acme.com\",\n \"status\": \"active\",\n \"notes\": \"Preferred customer. Net-30 terms.\",\n \"paymentTerm\": \"net30\",\n \"taxNumber\": null,\n \"taxAutoCalculate\": false,\n \"taxExcluded\": false,\n \"contactName\": \"John Doe\",\n \"billingAddress\": {\n \"id\": \"0b2c1f5e-7a9d-4f2b-9c1e-2a4b6d8e0f12\",\n \"street\": \"123 Main St\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zipCode\": \"94102\",\n \"country\": \"USA\"\n },\n \"shippingAddress\": null,\n \"contacts\": [\n {\n \"id\": \"a5da3577-bf85-4e3a-aa73-df85ca69bc67\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john@acme.com\",\n \"phone\": \"+1234567890\",\n \"isPrimary\": true\n }\n ],\n \"taxes\": [],\n \"salesRep\": null,\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n ],\n \"filters\": {\n \"search\": null,\n \"status\": null,\n \"orderBy\": \"customer\",\n \"orderDirection\": \"ASC\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60ec04e4-2c3b-4f85-8d85-8d3850c21b6e", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "customers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "acme" }, { "key": "status", "value": "" }, { "key": "orderBy", "value": "" }, { "key": "orderDirection", "value": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a50cc2d4-fdd8-45de-815a-bbdf04149793", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "customers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "acme" }, { "key": "status", "value": "" }, { "key": "orderBy", "value": "" }, { "key": "orderDirection", "value": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3dd50e5a-8c5f-4dab-9d96-9f3d1bd679c3", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "customers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "acme" }, { "key": "status", "value": "" }, { "key": "orderBy", "value": "" }, { "key": "orderDirection", "value": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "19e8ae15-3b1a-4973-bacc-31eee585d929", "name": "Creates a new customer in the workspace.", "request": { "name": "Creates a new customer in the workspace.", "description": { "content": "Only customer (the name) is required. Addresses, contacts, and taxes can be created inline.", "type": "text/plain" }, "url": { "path": [ "partners", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"customer\": \"\",\n \"email\": \"\",\n \"mainPhone\": \"\",\n \"website\": \"\",\n \"notes\": \"\",\n \"status\": \"\",\n \"paymentTerm\": \"\",\n \"taxNumber\": \"\",\n \"salesRepId\": \"\",\n \"taxAutoCalculate\": \"\",\n \"taxExcluded\": \"\",\n \"billingAddress\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"country\": \"\"\n },\n \"shippingAddress\": \"\",\n \"contacts\": [\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"isPrimary\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ec9e39ad-6cc2-44ff-b426-8fd61d34f7dc", "name": "Customer created successfully.", "originalRequest": { "url": { "path": [ "partners", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customer\": \"Acme Corporation\",\n \"email\": \"contact@acme.com\",\n \"mainPhone\": \"+1234567890\",\n \"website\": \"https://acme.com\",\n \"status\": \"active\",\n \"paymentTerm\": \"net30\",\n \"billingAddress\": {\n \"street\": \"123 Main St\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zipCode\": \"94102\",\n \"country\": \"USA\"\n },\n \"contacts\": [\n {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john@acme.com\",\n \"isPrimary\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"success on creating customer\",\n \"data\": {\n \"customer\": {\n \"id\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\",\n \"email\": \"contact@acme.com\",\n \"mainPhone\": \"+1234567890\",\n \"website\": \"https://acme.com\",\n \"status\": \"active\",\n \"notes\": \"Preferred customer. Net-30 terms.\",\n \"paymentTerm\": \"net30\",\n \"taxNumber\": null,\n \"taxAutoCalculate\": false,\n \"taxExcluded\": false,\n \"contactName\": \"John Doe\",\n \"billingAddress\": {\n \"id\": \"0b2c1f5e-7a9d-4f2b-9c1e-2a4b6d8e0f12\",\n \"street\": \"123 Main St\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zipCode\": \"94102\",\n \"country\": \"USA\"\n },\n \"shippingAddress\": null,\n \"contacts\": [\n {\n \"id\": \"a5da3577-bf85-4e3a-aa73-df85ca69bc67\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john@acme.com\",\n \"phone\": \"+1234567890\",\n \"isPrimary\": true\n }\n ],\n \"taxes\": [],\n \"salesRep\": null,\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37f5b794-3f8d-470f-9c42-716c4431f336", "name": "Bad request — validation failed.", "originalRequest": { "url": { "path": [ "partners", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customer\": \"Acme Corporation\",\n \"email\": \"contact@acme.com\",\n \"mainPhone\": \"+1234567890\",\n \"website\": \"https://acme.com\",\n \"status\": \"active\",\n \"paymentTerm\": \"net30\",\n \"billingAddress\": {\n \"street\": \"123 Main St\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zipCode\": \"94102\",\n \"country\": \"USA\"\n },\n \"contacts\": [\n {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john@acme.com\",\n \"isPrimary\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5f520b0d-5794-49a8-82e4-af47e12f798e", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customer\": \"Acme Corporation\",\n \"email\": \"contact@acme.com\",\n \"mainPhone\": \"+1234567890\",\n \"website\": \"https://acme.com\",\n \"status\": \"active\",\n \"paymentTerm\": \"net30\",\n \"billingAddress\": {\n \"street\": \"123 Main St\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zipCode\": \"94102\",\n \"country\": \"USA\"\n },\n \"contacts\": [\n {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john@acme.com\",\n \"isPrimary\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "246412e6-329b-459b-bb37-58641a79e82e", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customer\": \"Acme Corporation\",\n \"email\": \"contact@acme.com\",\n \"mainPhone\": \"+1234567890\",\n \"website\": \"https://acme.com\",\n \"status\": \"active\",\n \"paymentTerm\": \"net30\",\n \"billingAddress\": {\n \"street\": \"123 Main St\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zipCode\": \"94102\",\n \"country\": \"USA\"\n },\n \"contacts\": [\n {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john@acme.com\",\n \"isPrimary\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fe429c48-8b02-4122-836b-38bb7bc84b54", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "customers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customer\": \"Acme Corporation\",\n \"email\": \"contact@acme.com\",\n \"mainPhone\": \"+1234567890\",\n \"website\": \"https://acme.com\",\n \"status\": \"active\",\n \"paymentTerm\": \"net30\",\n \"billingAddress\": {\n \"street\": \"123 Main St\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zipCode\": \"94102\",\n \"country\": \"USA\"\n },\n \"contacts\": [\n {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john@acme.com\",\n \"isPrimary\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0b3c9f7a-3d42-4e96-95f7-51c76ae76d0f", "name": "Retrieves a single customer by its id (UUID).", "request": { "name": "Retrieves a single customer by its id (UUID).", "description": { "content": "Returns the customer with its contacts and addresses embedded. Pass include=balance to also return the customer’s outstanding balance.", "type": "text/plain" }, "url": { "path": [ "partners", "customers", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "include", "value": "", "description": "Comma-separated extras to embed. Supports balance to add the outstanding balance." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The customer UUID as returned in responses." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "479e275c-151b-4cb8-9b9e-6584f048e00e", "name": "The requested customer.", "originalRequest": { "url": { "path": [ "partners", "customers", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "include", "value": "balance" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The customer UUID as returned in responses." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on fetching customer data.\",\n \"data\": {\n \"customer\": {\n \"id\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\",\n \"email\": \"contact@acme.com\",\n \"mainPhone\": \"+1234567890\",\n \"website\": \"https://acme.com\",\n \"status\": \"active\",\n \"notes\": \"Preferred customer. Net-30 terms.\",\n \"paymentTerm\": \"net30\",\n \"taxNumber\": null,\n \"taxAutoCalculate\": false,\n \"taxExcluded\": false,\n \"contactName\": \"John Doe\",\n \"billingAddress\": {\n \"id\": \"0b2c1f5e-7a9d-4f2b-9c1e-2a4b6d8e0f12\",\n \"street\": \"123 Main St\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zipCode\": \"94102\",\n \"country\": \"USA\"\n },\n \"shippingAddress\": null,\n \"contacts\": [\n {\n \"id\": \"a5da3577-bf85-4e3a-aa73-df85ca69bc67\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john@acme.com\",\n \"phone\": \"+1234567890\",\n \"isPrimary\": true\n }\n ],\n \"taxes\": [],\n \"salesRep\": null,\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6248c31f-256a-4b57-99e1-5bdc95303f34", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "customers", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "include", "value": "balance" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The customer UUID as returned in responses." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "97172b44-ea7d-4251-a5c9-ea9eedee4ca5", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "customers", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "include", "value": "balance" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The customer UUID as returned in responses." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4b5e0fa0-8f88-4c08-9f38-9b0c66b4e353", "name": "Customer not found.", "originalRequest": { "url": { "path": [ "partners", "customers", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "include", "value": "balance" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The customer UUID as returned in responses." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "09281921-0f1a-41a0-8902-d2a09f17fe27", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "customers", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "include", "value": "balance" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The customer UUID as returned in responses." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "34bd8d13-7256-4e6b-a977-b94b9bb3681a", "name": "Updates an existing customer. Only the fields you send are changed.", "request": { "name": "Updates an existing customer. Only the fields you send are changed.", "description": { "content": "Send any subset of the writable fields. Fields belonging to firm-managed (system-created) customers, and internal fields such as originalClientId, are ignored.", "type": "text/plain" }, "url": { "path": [ "partners", "customers", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The customer UUID to update." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"customer\": \"\",\n \"email\": \"\",\n \"mainPhone\": \"\",\n \"website\": \"\",\n \"notes\": \"\",\n \"status\": \"\",\n \"paymentTerm\": \"\",\n \"billingAddress\": \"\",\n \"shippingAddress\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f7e516af-b22b-46d3-9300-874c764267aa", "name": "Customer updated successfully.", "originalRequest": { "url": { "path": [ "partners", "customers", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The customer UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"mainPhone\": \"+1987654321\",\n \"status\": \"inactive\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on updating a customer\",\n \"data\": {\n \"updatedCustomer\": {\n \"id\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\",\n \"email\": \"contact@acme.com\",\n \"mainPhone\": \"+1234567890\",\n \"website\": \"https://acme.com\",\n \"status\": \"inactive\",\n \"notes\": \"Preferred customer. Net-30 terms.\",\n \"paymentTerm\": \"net30\",\n \"taxNumber\": null,\n \"taxAutoCalculate\": false,\n \"taxExcluded\": false,\n \"contactName\": \"John Doe\",\n \"billingAddress\": {\n \"id\": \"0b2c1f5e-7a9d-4f2b-9c1e-2a4b6d8e0f12\",\n \"street\": \"123 Main St\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zipCode\": \"94102\",\n \"country\": \"USA\"\n },\n \"shippingAddress\": null,\n \"contacts\": [\n {\n \"id\": \"a5da3577-bf85-4e3a-aa73-df85ca69bc67\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john@acme.com\",\n \"phone\": \"+1234567890\",\n \"isPrimary\": true\n }\n ],\n \"taxes\": [],\n \"salesRep\": null,\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a503597f-fbb3-4b76-ae47-6eb06824777f", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "customers", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The customer UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"mainPhone\": \"+1987654321\",\n \"status\": \"inactive\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "84d1d39f-96bb-4808-ae01-8d7792cec422", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "customers", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The customer UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"mainPhone\": \"+1987654321\",\n \"status\": \"inactive\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b9a2b7fc-5ba9-4f44-ad9c-822e8955bf7a", "name": "Customer not found.", "originalRequest": { "url": { "path": [ "partners", "customers", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The customer UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"mainPhone\": \"+1987654321\",\n \"status\": \"inactive\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5ebcd4ee-7fee-4223-9729-e29a82cadbf3", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "customers", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The customer UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"mainPhone\": \"+1987654321\",\n \"status\": \"inactive\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3df02258-a5d2-465c-a8fb-3e6caf5a2b2e", "name": "Soft-deletes a customer (sets its status to inactive).", "request": { "name": "Soft-deletes a customer (sets its status to inactive).", "description": { "content": "Returns 204 No Content on success with an empty body. A customer cannot be deleted if it is linked to an invoice, project, or transaction, or if it is a firm-managed customer.", "type": "text/plain" }, "url": { "path": [ "partners", "customers", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The customer UUID to delete." } ] }, "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "75ca3707-2113-4f00-960a-49b28a64874a", "name": "Customer deleted successfully. No response body.", "originalRequest": { "url": { "path": [ "partners", "customers", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The customer UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aff8b366-e1f4-4dac-b60e-b6298e479cdb", "name": "Customer is linked to an invoice, project, or transaction, or is firm-managed.", "originalRequest": { "url": { "path": [ "partners", "customers", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The customer UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "28e2659a-10d4-48f1-8c62-60e965a25f8f", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "customers", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The customer UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f18cc654-5814-481f-b9de-ced647936a90", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "customers", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The customer UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a5782bec-44a0-4720-8ce5-5dfa66e45d63", "name": "Customer not found.", "originalRequest": { "url": { "path": [ "partners", "customers", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The customer UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "de58890f-a933-42d1-9060-7dabbffd796e", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "customers", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The customer UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d0bf452b-cd46-4602-b552-913d23593a87", "name": "Creates up to 100 customers in one request with partial-success semantics.", "request": { "name": "Creates up to 100 customers in one request with partial-success semantics.", "description": { "content": "Each row uses the same shape as Add a customer. Rows are processed independently — one failure does not roll back others. Returns the bulk batch shape documented in Response shapes (HTTP 201). Recommended batch size ~25 for large migrations.", "type": "text/plain" }, "url": { "path": [ "partners", "customers", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"customers\": []\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d7ec5756-007d-4e91-9557-8746c30789c7", "name": "Batch accepted. Check successCount and per-row results.", "originalRequest": { "url": { "path": [ "partners", "customers", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customers\": [\n {\n \"customer\": \"Acme Corporation\",\n \"email\": \"billing@acme.com\"\n },\n {\n \"customer\": \"Beta LLC\",\n \"mainPhone\": \"+1234567890\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"successCount\": 2,\n \"errorCount\": 0,\n \"results\": [\n {\n \"index\": 0,\n \"success\": true,\n \"customer\": {\n \"id\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\",\n \"email\": \"contact@acme.com\",\n \"mainPhone\": \"+1234567890\",\n \"website\": \"https://acme.com\",\n \"status\": \"active\",\n \"notes\": \"Preferred customer. Net-30 terms.\",\n \"paymentTerm\": \"net30\",\n \"taxNumber\": null,\n \"taxAutoCalculate\": false,\n \"taxExcluded\": false,\n \"contactName\": \"John Doe\",\n \"billingAddress\": {\n \"id\": \"0b2c1f5e-7a9d-4f2b-9c1e-2a4b6d8e0f12\",\n \"street\": \"123 Main St\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zipCode\": \"94102\",\n \"country\": \"USA\"\n },\n \"shippingAddress\": null,\n \"contacts\": [\n {\n \"id\": \"a5da3577-bf85-4e3a-aa73-df85ca69bc67\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john@acme.com\",\n \"phone\": \"+1234567890\",\n \"isPrimary\": true\n }\n ],\n \"taxes\": [],\n \"salesRep\": null,\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b10760bb-b8fb-43d2-ba74-79936352d255", "name": "Batch-level validation failed (empty array, over 100 rows, etc.).", "originalRequest": { "url": { "path": [ "partners", "customers", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customers\": [\n {\n \"customer\": \"Acme Corporation\",\n \"email\": \"billing@acme.com\"\n },\n {\n \"customer\": \"Beta LLC\",\n \"mainPhone\": \"+1234567890\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1939eb94-6b55-4fb1-b2d7-503defb7fb1a", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "customers", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customers\": [\n {\n \"customer\": \"Acme Corporation\",\n \"email\": \"billing@acme.com\"\n },\n {\n \"customer\": \"Beta LLC\",\n \"mainPhone\": \"+1234567890\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e1ce485d-44cb-4dbb-800a-48d5f7af8e54", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "customers", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customers\": [\n {\n \"customer\": \"Acme Corporation\",\n \"email\": \"billing@acme.com\"\n },\n {\n \"customer\": \"Beta LLC\",\n \"mainPhone\": \"+1234567890\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a8fc61c9-eb40-4d04-9f8f-cd142feeb8f1", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "customers", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customers\": [\n {\n \"customer\": \"Acme Corporation\",\n \"email\": \"billing@acme.com\"\n },\n {\n \"customer\": \"Beta LLC\",\n \"mainPhone\": \"+1234567890\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9fd38528-43c6-421a-a0e9-6908c4243a5e", "name": "Updates up to 100 customers in one request with partial-success semantics.", "request": { "name": "Updates up to 100 customers in one request with partial-success semantics.", "description": { "content": "Each row must include `uuid` (same value as `id` from API responses) plus fields to patch. Returns the bulk batch shape documented in Response shapes (HTTP 201).", "type": "text/plain" }, "url": { "path": [ "partners", "customers", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"customers\": []\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7aaebcab-698f-4e83-868c-6d2f596e6801", "name": "Batch accepted. Check successCount and per-row results.", "originalRequest": { "url": { "path": [ "partners", "customers", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"customers\": [\n {\n \"uuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"email\": \"updated@acme.com\"\n },\n {\n \"uuid\": \"00000000-0000-4000-8000-000000000099\",\n \"mainPhone\": \"+1987654321\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"successCount\": 1,\n \"errorCount\": 1,\n \"results\": [\n {\n \"index\": 0,\n \"success\": true,\n \"customer\": {\n \"id\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\",\n \"email\": \"contact@acme.com\",\n \"mainPhone\": \"+1234567890\",\n \"website\": \"https://acme.com\",\n \"status\": \"active\",\n \"notes\": \"Preferred customer. Net-30 terms.\",\n \"paymentTerm\": \"net30\",\n \"taxNumber\": null,\n \"taxAutoCalculate\": false,\n \"taxExcluded\": false,\n \"contactName\": \"John Doe\",\n \"billingAddress\": {\n \"id\": \"0b2c1f5e-7a9d-4f2b-9c1e-2a4b6d8e0f12\",\n \"street\": \"123 Main St\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zipCode\": \"94102\",\n \"country\": \"USA\"\n },\n \"shippingAddress\": null,\n \"contacts\": [\n {\n \"id\": \"a5da3577-bf85-4e3a-aa73-df85ca69bc67\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john@acme.com\",\n \"phone\": \"+1234567890\",\n \"isPrimary\": true\n }\n ],\n \"taxes\": [],\n \"salesRep\": null,\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n },\n {\n \"index\": 1,\n \"success\": false,\n \"error\": \"Customer not found\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3490166-82e0-405b-bd5f-51305a5f808e", "name": "Batch-level validation failed.", "originalRequest": { "url": { "path": [ "partners", "customers", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"customers\": [\n {\n \"uuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"email\": \"updated@acme.com\"\n },\n {\n \"uuid\": \"00000000-0000-4000-8000-000000000099\",\n \"mainPhone\": \"+1987654321\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d80c21f7-74ce-4b7f-98c0-feb8424dd7f8", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "customers", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"customers\": [\n {\n \"uuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"email\": \"updated@acme.com\"\n },\n {\n \"uuid\": \"00000000-0000-4000-8000-000000000099\",\n \"mainPhone\": \"+1987654321\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cf9c3da5-bc99-4ca5-884e-82fb338a16f8", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "customers", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"customers\": [\n {\n \"uuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"email\": \"updated@acme.com\"\n },\n {\n \"uuid\": \"00000000-0000-4000-8000-000000000099\",\n \"mainPhone\": \"+1987654321\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "319995ef-beba-46bb-b59f-668e865703bd", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "customers", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"customers\": [\n {\n \"uuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"email\": \"updated@acme.com\"\n },\n {\n \"uuid\": \"00000000-0000-4000-8000-000000000099\",\n \"mainPhone\": \"+1987654321\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "834421c7-27a1-4c53-88e8-89a30004e676", "name": "Invoices", "description": { "content": "Invoices, estimates, and credit memos share the same routes, distinguished by invoiceType. Every invoice object includes a derived status field (draft, approved, sent, unpaid, partial, paid, overdue, void) alongside the raw isDraft / approved / isSent / paymentStatus flags. All references use UUIDs.", "type": "text/plain" }, "item": [ { "id": "d3f8eef9-ec9d-4a48-b108-45cae6e309d5", "name": "Emails the invoice to the customer. Requires a non-draft invoice with a customer and products.", "request": { "name": "Emails the invoice to the customer. Requires a non-draft invoice with a customer and products.", "description": {}, "url": { "path": [ "partners", "invoices", ":uuid", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"message\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d205005c-fe09-4315-bfac-a41b74a004ff", "name": "Invoice sent.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": [\n \"contact@acme.com\"\n ],\n \"message\": \"Thanks for your business!\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"invoice\": {\n \"id\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"invoiceNumber\": \"INV-1042\",\n \"invoiceType\": \"invoice\",\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"date\": \"2026-03-01\",\n \"dueDate\": \"2026-03-31\",\n \"currency\": \"USD\",\n \"status\": \"sent\",\n \"isDraft\": false,\n \"approved\": true,\n \"isSent\": true,\n \"paymentStatus\": \"unpaid\",\n \"subtotal\": 1000,\n \"taxTotal\": 85,\n \"total\": 1085,\n \"amountDue\": 1085,\n \"products\": [\n {\n \"productUuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Consulting services\",\n \"quantity\": 10,\n \"unitPrice\": 100,\n \"nonTaxable\": false\n }\n ],\n \"createdAt\": \"2026-03-01T09:00:00.000Z\",\n \"updatedAt\": \"2026-03-02T11:15:00.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ad4fb1c-483d-4c38-8cfb-983025d4712e", "name": "Bad request — invoice is still a draft or missing required data.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": [\n \"contact@acme.com\"\n ],\n \"message\": \"Thanks for your business!\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "663b037b-1d2b-455b-ac37-72c2e4080ae3", "name": "Returns a shareable public link for the invoice, creating the public token if needed.", "request": { "name": "Returns a shareable public link for the invoice, creating the public token if needed.", "description": {}, "url": { "path": [ "partners", "invoices", ":uuid", "public-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "e6801ee8-c91a-4e67-8007-a6cce4454076", "name": "The public token and URL.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "public-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"publicToken\": \"pub_3fa85f64\",\n \"publicUrl\": \"https://app.getcount.com/public/invoice-estimate/pub_3fa85f64\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1fa6bfc-157f-4c93-84cf-1508839ef5f5", "name": "Invoice not found.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "public-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "14a92b3b-5084-48f2-b63e-945ef69c2f0f", "name": "Returns the audit history for an invoice, estimate, or credit memo.", "request": { "name": "Returns the audit history for an invoice, estimate, or credit memo.", "description": {}, "url": { "path": [ "partners", "invoices", ":uuid", "audit-log" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "71974cd6-d11e-4aa9-b010-3a291c6bc94f", "name": "Audit log entries for the invoice.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "audit-log" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"auditLog\": [\n {\n \"action\": \"created\",\n \"timestamp\": \"2026-03-01T09:00:00.000Z\",\n \"userId\": null\n },\n {\n \"action\": \"approved\",\n \"timestamp\": \"2026-03-01T10:00:00.000Z\",\n \"userId\": null\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ed5a202-2c30-4c18-8591-dbebc3570228", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "audit-log" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9e1e6a3b-2ee2-4328-a769-c0c4b698f844", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "audit-log" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "29c7b419-51dd-48b3-95e6-cb8719d29d80", "name": "Invoice not found.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "audit-log" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "00c634f4-8c04-44b1-ad18-67f58f407f5a", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "audit-log" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "95c4e85a-9c4e-4fd8-aa49-9306b7726d6b", "name": "Returns email send history and public-view analytics for an invoice, estimate, or credit memo.", "request": { "name": "Returns email send history and public-view analytics for an invoice, estimate, or credit memo.", "description": { "content": "Queued in-flight send stubs are excluded from the `sends` array. Rows with `deliveryStatus: \"sent\"` but no MailerSend message id are surfaced as `failed`.", "type": "text/plain" }, "url": { "path": [ "partners", "invoices", ":uuid", "send-history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "510123af-a3f4-4c1e-b583-a9ff6b3a0688", "name": "Send history and public view summary.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "send-history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"isSent\": true,\n \"lastSendDate\": \"2026-03-02T14:30:00.000Z\",\n \"sendCount\": 1,\n \"sends\": [\n {\n \"id\": \"send-uuid-001\",\n \"recipientEmail\": \"contact@acme.com\",\n \"sentAt\": \"2026-03-02T14:30:00.000Z\",\n \"deliveryStatus\": \"delivered\",\n \"delivered\": true,\n \"firstOpenedAt\": \"2026-03-02T15:00:00.000Z\",\n \"openCount\": 2,\n \"firstClickedAt\": null,\n \"clickCount\": 0\n }\n ],\n \"publicViews\": {\n \"count\": 3,\n \"firstViewedAt\": \"2026-03-02T16:00:00.000Z\",\n \"lastViewedAt\": \"2026-03-03T09:00:00.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5e08748-fa23-4449-b6b5-5380f2c80809", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "send-history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f9b8baa2-d2e8-47fb-b7e8-e776cf7d2716", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "send-history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "12ddbe3f-5913-43e3-9005-208133739333", "name": "Invoice not found.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "send-history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1f67a9c8-015b-4a12-a12f-fbb9171251d9", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "send-history" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "52ef6b78-d52d-49be-9e35-19e2101b4f31", "name": "Attaches files to an invoice by URL.", "request": { "name": "Attaches files to an invoice by URL.", "description": {}, "url": { "path": [ "partners", "invoices", ":uuid", "attachments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"attachments\": [\n {\n \"url\": \"\",\n \"title\": \"\"\n },\n {\n \"url\": \"\",\n \"title\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "76a94dfb-acf6-432d-8879-4e402163bbf6", "name": "Attachments added.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "attachments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"attachments\": [\n {\n \"url\": \"https://cdn.example.com/contract.pdf\",\n \"title\": \"Signed contract\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"invoice\": {\n \"id\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"invoiceNumber\": \"INV-1042\",\n \"invoiceType\": \"invoice\",\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"date\": \"2026-03-01\",\n \"dueDate\": \"2026-03-31\",\n \"currency\": \"USD\",\n \"status\": \"sent\",\n \"isDraft\": false,\n \"approved\": true,\n \"isSent\": true,\n \"paymentStatus\": \"unpaid\",\n \"subtotal\": 1000,\n \"taxTotal\": 85,\n \"total\": 1085,\n \"amountDue\": 1085,\n \"products\": [\n {\n \"productUuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Consulting services\",\n \"quantity\": 10,\n \"unitPrice\": 100,\n \"nonTaxable\": false\n }\n ],\n \"createdAt\": \"2026-03-01T09:00:00.000Z\",\n \"updatedAt\": \"2026-03-02T11:15:00.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de59d807-3205-4cc0-9200-ffb7717c4096", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "attachments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"attachments\": [\n {\n \"url\": \"https://cdn.example.com/contract.pdf\",\n \"title\": \"Signed contract\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "79fe6173-2d53-4dc2-a607-e0d0de265e88", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "attachments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"attachments\": [\n {\n \"url\": \"https://cdn.example.com/contract.pdf\",\n \"title\": \"Signed contract\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4bf58966-0b15-4ddf-a5b3-534fb337863e", "name": "Invoice not found.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "attachments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"attachments\": [\n {\n \"url\": \"https://cdn.example.com/contract.pdf\",\n \"title\": \"Signed contract\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6f8d111b-056b-456b-9b43-81297bca29d2", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "attachments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"attachments\": [\n {\n \"url\": \"https://cdn.example.com/contract.pdf\",\n \"title\": \"Signed contract\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cc330fd7-9e5a-4ee3-bf36-3e205977d553", "name": "Uploads a file attachment via multipart form data.", "request": { "name": "Uploads a file attachment via multipart form data.", "description": { "content": "Send multipart/form-data with a `documents` field. Sign the request with an empty-object body hash.", "type": "text/plain" }, "url": { "path": [ "partners", "invoices", ":uuid", "attachments", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "75327b8b-3e76-4af3-a0c5-38d5ae2faafc", "name": "Attachment uploaded.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "attachments", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"invoice\": {\n \"id\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"invoiceNumber\": \"INV-1042\",\n \"invoiceType\": \"invoice\",\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"date\": \"2026-03-01\",\n \"dueDate\": \"2026-03-31\",\n \"currency\": \"USD\",\n \"status\": \"sent\",\n \"isDraft\": false,\n \"approved\": true,\n \"isSent\": true,\n \"paymentStatus\": \"unpaid\",\n \"subtotal\": 1000,\n \"taxTotal\": 85,\n \"total\": 1085,\n \"amountDue\": 1085,\n \"products\": [\n {\n \"productUuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Consulting services\",\n \"quantity\": 10,\n \"unitPrice\": 100,\n \"nonTaxable\": false\n }\n ],\n \"createdAt\": \"2026-03-01T09:00:00.000Z\",\n \"updatedAt\": \"2026-03-02T11:15:00.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aebd9c2a-7449-4ad9-b5de-f1d445ab0bf7", "name": "Missing file or validation error.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "attachments", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4b6b0564-6e8a-49ee-b1c8-5ca71860a3a4", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "attachments", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7289b2ab-43d4-4e2d-a363-e308306984cb", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "attachments", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "62ea1d31-147f-488c-85a4-76f6cd95e4cb", "name": "Invoice not found.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "attachments", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f9901894-ea94-45b0-bd16-27357f3d7515", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "attachments", "upload" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "be22e651-b65a-4fc9-8cdf-d6aa81358c54", "name": "Unassigns a payment transaction from an invoice.", "request": { "name": "Unassigns a payment transaction from an invoice.", "description": {}, "url": { "path": [ "partners", "invoices", ":uuid", "remove-transaction" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"transactionId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "54dbd975-001a-400f-a574-60722b7a1bf4", "name": "Transaction removed from invoice.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "remove-transaction" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"transactionId\": \"b7c8d9e0-f1a2-3456-bcde-678901234567\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"invoice\": {\n \"id\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"invoiceNumber\": \"INV-1042\",\n \"invoiceType\": \"invoice\",\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"date\": \"2026-03-01\",\n \"dueDate\": \"2026-03-31\",\n \"currency\": \"USD\",\n \"status\": \"sent\",\n \"isDraft\": false,\n \"approved\": true,\n \"isSent\": true,\n \"paymentStatus\": \"unpaid\",\n \"subtotal\": 1000,\n \"taxTotal\": 85,\n \"total\": 1085,\n \"amountDue\": 1085,\n \"products\": [\n {\n \"productUuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Consulting services\",\n \"quantity\": 10,\n \"unitPrice\": 100,\n \"nonTaxable\": false\n }\n ],\n \"createdAt\": \"2026-03-01T09:00:00.000Z\",\n \"updatedAt\": \"2026-03-02T11:15:00.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "def03237-1560-4c42-99d4-112718f8975a", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "remove-transaction" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"transactionId\": \"b7c8d9e0-f1a2-3456-bcde-678901234567\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1c6ce751-885e-495a-b523-874f432da861", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "remove-transaction" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"transactionId\": \"b7c8d9e0-f1a2-3456-bcde-678901234567\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "215aea5e-50b4-42f8-90fe-eb15ccc8e36e", "name": "Invoice or transaction not found.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "remove-transaction" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"transactionId\": \"b7c8d9e0-f1a2-3456-bcde-678901234567\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b85d8328-4402-43ec-a0ef-dc82d474a020", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "remove-transaction" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the invoice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"transactionId\": \"b7c8d9e0-f1a2-3456-bcde-678901234567\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "e8978f4d-a774-4719-a349-ba6197e4aded", "name": "Credit Memos", "description": { "content": "Credit memos reduce what a customer owes. They are invoice records with invoiceType memo and use the same /partners/invoices routes as invoices and estimates. Apply approved memos to open invoices with the credit-application endpoints.", "type": "text/plain" }, "item": [ { "id": "bad4a360-9953-48ef-8279-8f0b6ab4fb29", "name": "Returns a paginated list of credit memos in the workspace.", "request": { "name": "Returns a paginated list of credit memos in the workspace.", "description": { "content": "Pass invoiceType=memo to return only credit memos. Other filters match the Invoices API list.", "type": "text/plain" }, "url": { "path": [ "partners", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Page number for pagination. The first page is 1." }, { "disabled": false, "key": "limit", "value": "", "description": "Records to return per page." }, { "disabled": false, "key": "invoiceType", "value": "", "description": "(Required) Must be memo to list credit memos only." }, { "disabled": false, "key": "status", "value": "", "description": "Comma-separated lifecycle statuses." }, { "disabled": false, "key": "paymentStatus", "value": "", "description": "Comma-separated payment statuses." }, { "disabled": false, "key": "approvalStatus", "value": "", "description": "Filter by approval state." }, { "disabled": false, "key": "startDate", "value": "", "description": "Filter on memo date (ISO)." }, { "disabled": false, "key": "endDate", "value": "", "description": "Filter on memo date (ISO)." }, { "disabled": false, "key": "isDraft", "value": "", "description": "Explicit draft filter." }, { "disabled": false, "key": "search", "value": "", "description": "Free-text search." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "89e3e413-159e-4e31-89ed-7afded246c8c", "name": "Paginated list of credit memos.", "originalRequest": { "url": { "path": [ "partners", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "invoiceType", "value": "" }, { "key": "status", "value": "" }, { "key": "paymentStatus", "value": "" }, { "key": "approvalStatus", "value": "" }, { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" }, { "key": "isDraft", "value": "" }, { "key": "search", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on fetching invoices.\",\n \"results\": 1,\n \"totalRecords\": 1,\n \"page\": 1,\n \"limit\": 50,\n \"data\": {\n \"invoices\": [\n {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"invoiceNumber\": \"CM-0042\",\n \"invoiceType\": \"memo\",\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"appliedToInvoiceUuid\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"date\": \"2026-03-01\",\n \"dueDate\": null,\n \"currency\": \"USD\",\n \"status\": \"approved\",\n \"isDraft\": false,\n \"approved\": true,\n \"isSent\": false,\n \"paymentStatus\": \"unpaid\",\n \"subtotal\": 500,\n \"taxTotal\": 0,\n \"total\": 500,\n \"amountDue\": 500,\n \"products\": [\n {\n \"productUuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Credit for overbilling on prior invoice\",\n \"quantity\": 1,\n \"unitPrice\": 500,\n \"nonTaxable\": true\n }\n ],\n \"createdAt\": \"2026-03-01T09:00:00.000Z\",\n \"updatedAt\": \"2026-03-02T11:15:00.000Z\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75627574-7eb8-4c68-a2fb-e9c086f77941", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "invoiceType", "value": "" }, { "key": "status", "value": "" }, { "key": "paymentStatus", "value": "" }, { "key": "approvalStatus", "value": "" }, { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" }, { "key": "isDraft", "value": "" }, { "key": "search", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9bf70c5c-2ae0-4ef6-b168-5e3b6ad7698b", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "invoiceType", "value": "" }, { "key": "status", "value": "" }, { "key": "paymentStatus", "value": "" }, { "key": "approvalStatus", "value": "" }, { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" }, { "key": "isDraft", "value": "" }, { "key": "search", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "51c749a7-b100-499f-b04f-17f62e32b7ce", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "invoiceType", "value": "" }, { "key": "status", "value": "" }, { "key": "paymentStatus", "value": "" }, { "key": "approvalStatus", "value": "" }, { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" }, { "key": "isDraft", "value": "" }, { "key": "search", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4cd956bf-e0fb-41d3-ac0c-31f94cde51fb", "name": "Creates a credit memo for a customer.", "request": { "name": "Creates a credit memo for a customer.", "description": { "content": "Set invoiceType to memo. Optionally pass appliedToInvoiceUuid to link the memo to an open invoice at create time. Line item rules match invoice create. invoiceNumber is required.", "type": "text/plain" }, "url": { "path": [ "partners", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"customerUuid\": \"\",\n \"invoiceType\": \"\",\n \"invoiceNumber\": \"\",\n \"date\": \"\",\n \"products\": [\n {\n \"productUuid\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"unitPrice\": \"\",\n \"nonTaxable\": \"\"\n },\n {\n \"productUuid\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"unitPrice\": \"\",\n \"nonTaxable\": \"\"\n }\n ],\n \"appliedToInvoiceUuid\": \"\",\n \"currency\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "64a3d02e-05b1-4a53-97ad-1a6ad6a243fb", "name": "Credit memo created.", "originalRequest": { "url": { "path": [ "partners", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"invoiceType\": \"memo\",\n \"invoiceNumber\": \"CM-0042\",\n \"date\": \"2026-03-01\",\n \"appliedToInvoiceUuid\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"currency\": \"USD\",\n \"products\": [\n {\n \"productUuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Credit for overbilling on prior invoice\",\n \"quantity\": 1,\n \"unitPrice\": 500,\n \"nonTaxable\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"invoice\": {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"invoiceNumber\": \"CM-0042\",\n \"invoiceType\": \"memo\",\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"appliedToInvoiceUuid\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"date\": \"2026-03-01\",\n \"dueDate\": null,\n \"currency\": \"USD\",\n \"status\": \"draft\",\n \"isDraft\": true,\n \"approved\": false,\n \"isSent\": false,\n \"paymentStatus\": \"unpaid\",\n \"subtotal\": 500,\n \"taxTotal\": 0,\n \"total\": 500,\n \"amountDue\": 500,\n \"products\": [\n {\n \"productUuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Credit for overbilling on prior invoice\",\n \"quantity\": 1,\n \"unitPrice\": 500,\n \"nonTaxable\": true\n }\n ],\n \"createdAt\": \"2026-03-01T09:00:00.000Z\",\n \"updatedAt\": \"2026-03-02T11:15:00.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ebd93a9-69cf-492a-ba6a-4664e6e5f476", "name": "Validation failed.", "originalRequest": { "url": { "path": [ "partners", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"invoiceType\": \"memo\",\n \"invoiceNumber\": \"CM-0042\",\n \"date\": \"2026-03-01\",\n \"appliedToInvoiceUuid\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"currency\": \"USD\",\n \"products\": [\n {\n \"productUuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Credit for overbilling on prior invoice\",\n \"quantity\": 1,\n \"unitPrice\": 500,\n \"nonTaxable\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2661c0e4-e86f-4e2b-88cf-c481a26ba2e4", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"invoiceType\": \"memo\",\n \"invoiceNumber\": \"CM-0042\",\n \"date\": \"2026-03-01\",\n \"appliedToInvoiceUuid\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"currency\": \"USD\",\n \"products\": [\n {\n \"productUuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Credit for overbilling on prior invoice\",\n \"quantity\": 1,\n \"unitPrice\": 500,\n \"nonTaxable\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8e33efdd-13d3-4a9f-8f0c-5700d5d87088", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"invoiceType\": \"memo\",\n \"invoiceNumber\": \"CM-0042\",\n \"date\": \"2026-03-01\",\n \"appliedToInvoiceUuid\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"currency\": \"USD\",\n \"products\": [\n {\n \"productUuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Credit for overbilling on prior invoice\",\n \"quantity\": 1,\n \"unitPrice\": 500,\n \"nonTaxable\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7e9c3e06-0116-4ea7-aaea-ba7eaf255350", "name": "Customer, product, or applied invoice not found.", "originalRequest": { "url": { "path": [ "partners", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"invoiceType\": \"memo\",\n \"invoiceNumber\": \"CM-0042\",\n \"date\": \"2026-03-01\",\n \"appliedToInvoiceUuid\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"currency\": \"USD\",\n \"products\": [\n {\n \"productUuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Credit for overbilling on prior invoice\",\n \"quantity\": 1,\n \"unitPrice\": 500,\n \"nonTaxable\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bb7189f7-b6d1-4fd8-9f98-146d6f77f158", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"invoiceType\": \"memo\",\n \"invoiceNumber\": \"CM-0042\",\n \"date\": \"2026-03-01\",\n \"appliedToInvoiceUuid\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"currency\": \"USD\",\n \"products\": [\n {\n \"productUuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Credit for overbilling on prior invoice\",\n \"quantity\": 1,\n \"unitPrice\": 500,\n \"nonTaxable\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "247733fe-67b6-4f5c-8511-68e9fdaf7535", "name": "Retrieves a single credit memo by its UUID.", "request": { "name": "Retrieves a single credit memo by its UUID.", "description": {}, "url": { "path": [ "partners", "invoices", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID (the id field on memo objects)." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "8cbda229-6be1-43eb-a6df-45924ef799a5", "name": "The requested credit memo.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID (the id field on memo objects)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"invoice\": {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"invoiceNumber\": \"CM-0042\",\n \"invoiceType\": \"memo\",\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"appliedToInvoiceUuid\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"date\": \"2026-03-01\",\n \"dueDate\": null,\n \"currency\": \"USD\",\n \"status\": \"approved\",\n \"isDraft\": false,\n \"approved\": true,\n \"isSent\": false,\n \"paymentStatus\": \"unpaid\",\n \"subtotal\": 500,\n \"taxTotal\": 0,\n \"total\": 500,\n \"amountDue\": 500,\n \"products\": [\n {\n \"productUuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Credit for overbilling on prior invoice\",\n \"quantity\": 1,\n \"unitPrice\": 500,\n \"nonTaxable\": true\n }\n ],\n \"createdAt\": \"2026-03-01T09:00:00.000Z\",\n \"updatedAt\": \"2026-03-02T11:15:00.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3b98ce1-5bc0-497b-ad95-360c84206e52", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID (the id field on memo objects)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "534ea358-fcd1-4ff2-b756-2099ef94e3e1", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID (the id field on memo objects)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d96458d0-076c-4859-a14c-aa1d5012fe63", "name": "Credit memo not found.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID (the id field on memo objects)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "32b96d6b-3b72-4144-9b30-7cfed53a42de", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID (the id field on memo objects)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b8034cb1-8169-4bae-9bf5-ba8209ac5a20", "name": "Updates a credit memo. Edits to non-draft memos are field-specific and may be rejected.", "request": { "name": "Updates a credit memo. Edits to non-draft memos are field-specific and may be rejected.", "description": {}, "url": { "path": [ "partners", "invoices", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID to update." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"date\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d1b117c7-92c1-4ed4-b1a2-e0e6c17654bd", "name": "Credit memo updated.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notes\": \"Adjusted credit reason\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"invoice\": {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"invoiceNumber\": \"CM-0042\",\n \"invoiceType\": \"memo\",\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"appliedToInvoiceUuid\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"date\": \"2026-03-01\",\n \"dueDate\": null,\n \"currency\": \"USD\",\n \"status\": \"approved\",\n \"isDraft\": false,\n \"approved\": true,\n \"isSent\": false,\n \"paymentStatus\": \"unpaid\",\n \"subtotal\": 500,\n \"taxTotal\": 0,\n \"total\": 500,\n \"amountDue\": 500,\n \"products\": [\n {\n \"productUuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Credit for overbilling on prior invoice\",\n \"quantity\": 1,\n \"unitPrice\": 500,\n \"nonTaxable\": true\n }\n ],\n \"createdAt\": \"2026-03-01T09:00:00.000Z\",\n \"updatedAt\": \"2026-03-02T11:15:00.000Z\",\n \"notes\": \"Adjusted credit reason\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28170294-6b58-45f4-a3da-2b55bac266c2", "name": "Change not allowed on approved memo.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notes\": \"Adjusted credit reason\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "75cb90f9-d755-4865-bb37-214aac5ff905", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notes\": \"Adjusted credit reason\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "377226da-f0c3-4f53-9f0a-9ac220dcb717", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notes\": \"Adjusted credit reason\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "192f4059-29e6-4ea4-a225-be51c9964ef7", "name": "Credit memo not found.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notes\": \"Adjusted credit reason\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f2ae932d-c9de-4541-bb08-766dd6cf6149", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"notes\": \"Adjusted credit reason\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3accf0b9-ae7b-4754-a985-ba653134655f", "name": "Deletes a credit memo.", "request": { "name": "Deletes a credit memo.", "description": { "content": "Memos with applied credit or payments may be restricted — expect 400 when deletion is not allowed.", "type": "text/plain" }, "url": { "path": [ "partners", "invoices", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID to delete." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "f9e683b8-9501-4ae2-b834-b96e1c198fd5", "name": "Credit memo deleted.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Invoice deleted.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "676bb2ca-370b-434e-a743-bd63cb6eb0b5", "name": "Memo cannot be deleted in its current state.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "075656ca-c7ba-4a4b-b1d6-ae13f2845512", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cb785e33-8f54-4ebc-a977-ce45024c2fbb", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2b8c8c38-53c5-4ec7-9077-048b3a5b5e07", "name": "Credit memo not found.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cfb95180-6eb8-4764-b1a8-eb1533f2e1ab", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "503c8b8d-cd4e-4014-a583-62bfd5e57a39", "name": "Approves a draft credit memo so its balance can be applied to invoices.", "request": { "name": "Approves a draft credit memo so its balance can be applied to invoices.", "description": {}, "url": { "path": [ "partners", "invoices", ":uuid", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID to approve." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"skipJesOnboarding\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c39fe1a5-d86e-4e92-87e4-e8c506e7b90e", "name": "Credit memo approved.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID to approve." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"skipJesOnboarding\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"invoice\": {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"invoiceNumber\": \"CM-0042\",\n \"invoiceType\": \"memo\",\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"appliedToInvoiceUuid\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"date\": \"2026-03-01\",\n \"dueDate\": null,\n \"currency\": \"USD\",\n \"status\": \"approved\",\n \"isDraft\": false,\n \"approved\": true,\n \"isSent\": false,\n \"paymentStatus\": \"unpaid\",\n \"subtotal\": 500,\n \"taxTotal\": 0,\n \"total\": 500,\n \"amountDue\": 500,\n \"products\": [\n {\n \"productUuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Credit for overbilling on prior invoice\",\n \"quantity\": 1,\n \"unitPrice\": 500,\n \"nonTaxable\": true\n }\n ],\n \"createdAt\": \"2026-03-01T09:00:00.000Z\",\n \"updatedAt\": \"2026-03-02T11:15:00.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "551061af-f062-42cc-9f9c-f8ff3e2026ce", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID to approve." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"skipJesOnboarding\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "edac1c2e-1a64-43ed-8fc7-81e2806adfd5", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID to approve." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"skipJesOnboarding\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7cdea6e3-d6cd-4302-b8f4-3ad2c9aaf8c6", "name": "Credit memo not found.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID to approve." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"skipJesOnboarding\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e17c6931-528f-4cd8-bdf4-3ed982ac72c6", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID to approve." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"skipJesOnboarding\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f21e0be6-9abb-4323-8b1c-e24a4a8214ac", "name": "Applies one or more credit memos to the target invoice.", "request": { "name": "Applies one or more credit memos to the target invoice.", "description": { "content": "Path is the target invoice UUID. Each creditMemos[].id is a credit memo UUID.", "type": "text/plain" }, "url": { "path": [ "partners", "invoices", ":uuid", "apply-multiple-credit-to-invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The target invoice UUID." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"creditMemos\": [\n {\n \"id\": \"\",\n \"amount\": \"\"\n },\n {\n \"id\": \"\",\n \"amount\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "993014a1-8dbc-4d66-91a0-65a97aa84163", "name": "Credits applied to the invoice.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "apply-multiple-credit-to-invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The target invoice UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"creditMemos\": [\n {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"amount\": 500\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"invoice\": {\n \"id\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"invoiceNumber\": \"INV-1042\",\n \"invoiceType\": \"invoice\",\n \"amountDue\": 585,\n \"total\": 1085\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cc801c9-3bbf-4532-92fa-e581b85874c2", "name": "Invalid credit amount or memo not approved.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "apply-multiple-credit-to-invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The target invoice UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"creditMemos\": [\n {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"amount\": 500\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "64020042-91a0-4882-b2fb-9dc9963a7beb", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "apply-multiple-credit-to-invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The target invoice UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"creditMemos\": [\n {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"amount\": 500\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c70c8380-a2d9-4687-b1d4-2d4672fb8696", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "apply-multiple-credit-to-invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The target invoice UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"creditMemos\": [\n {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"amount\": 500\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "82c92f9f-090e-4869-ab03-0d83f26c5380", "name": "Invoice or credit memo not found.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "apply-multiple-credit-to-invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The target invoice UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"creditMemos\": [\n {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"amount\": 500\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7403613a-e633-4af8-a233-2a7ec516cbb5", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "apply-multiple-credit-to-invoice" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The target invoice UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"creditMemos\": [\n {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"amount\": 500\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9e1ff70b-caf0-466a-ae90-108a07040b74", "name": "Applies a credit memo to one or more target invoices.", "request": { "name": "Applies a credit memo to one or more target invoices.", "description": { "content": "Path is the credit memo UUID. Each invoices[].id is a target invoice UUID.", "type": "text/plain" }, "url": { "path": [ "partners", "invoices", ":uuid", "apply-credit-to-multiple-invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"invoices\": [\n {\n \"id\": \"\",\n \"amount\": \"\"\n },\n {\n \"id\": \"\",\n \"amount\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "19f225fc-051d-4f14-b63f-9be5011fe2f3", "name": "Credit applied to invoices.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "apply-credit-to-multiple-invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"invoices\": [\n {\n \"id\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"amount\": 500\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"invoice\": {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"invoiceNumber\": \"CM-0042\",\n \"invoiceType\": \"memo\",\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"appliedToInvoiceUuid\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"date\": \"2026-03-01\",\n \"dueDate\": null,\n \"currency\": \"USD\",\n \"status\": \"approved\",\n \"isDraft\": false,\n \"approved\": true,\n \"isSent\": false,\n \"paymentStatus\": \"paid\",\n \"subtotal\": 500,\n \"taxTotal\": 0,\n \"total\": 500,\n \"amountDue\": 0,\n \"products\": [\n {\n \"productUuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Credit for overbilling on prior invoice\",\n \"quantity\": 1,\n \"unitPrice\": 500,\n \"nonTaxable\": true\n }\n ],\n \"createdAt\": \"2026-03-01T09:00:00.000Z\",\n \"updatedAt\": \"2026-03-02T11:15:00.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d031f18-bba2-49e0-9d40-b70c4fdb44df", "name": "Invalid credit amount or invoice state.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "apply-credit-to-multiple-invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"invoices\": [\n {\n \"id\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"amount\": 500\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ace583c9-6c1f-4807-ae22-9c0138e92607", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "apply-credit-to-multiple-invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"invoices\": [\n {\n \"id\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"amount\": 500\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b5c120ce-62fc-4773-beda-6d9ad5a524a7", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "apply-credit-to-multiple-invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"invoices\": [\n {\n \"id\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"amount\": 500\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "68e2b8ed-19fd-43ff-a279-e733d5ec4a59", "name": "Credit memo or invoice not found.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "apply-credit-to-multiple-invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"invoices\": [\n {\n \"id\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"amount\": 500\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d1b16d09-07d2-48d6-b26c-d1363f78ff76", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "apply-credit-to-multiple-invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The credit memo UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"invoices\": [\n {\n \"id\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"amount\": 500\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d17c1ccb-f54c-4a8f-a6f4-672fafa8920c", "name": "Unapplies a credit memo from an invoice.", "request": { "name": "Unapplies a credit memo from an invoice.", "description": {}, "url": { "path": [ "partners", "invoices", ":uuid", "remove-credit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The invoice UUID the credit was applied to." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"memoId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "48f5324e-d163-467f-b767-10469f3e6ab0", "name": "Credit removed from invoice.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "remove-credit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The invoice UUID the credit was applied to." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"memoId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"invoice\": {\n \"id\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"invoiceNumber\": \"INV-1042\",\n \"amountDue\": 1085\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42eab14c-ca4f-41c1-be6d-839cce00aff8", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "remove-credit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The invoice UUID the credit was applied to." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"memoId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "73028160-be9d-41e0-808c-8fc7ee52b2b4", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "remove-credit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The invoice UUID the credit was applied to." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"memoId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6db144b3-6ab5-4edc-8291-ef6c1ce69632", "name": "Invoice or credit memo not found.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "remove-credit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The invoice UUID the credit was applied to." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"memoId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3b2fe299-a0f6-4085-9234-f36ef50de7e0", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "invoices", ":uuid", "remove-credit" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The invoice UUID the credit was applied to." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"memoId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d6291146-17ce-431a-8519-bde9b5b2c3a1", "name": "Recurring Invoice Templates", "description": { "content": "Recurring invoice templates define a schedule that automatically generates invoices (or estimates) in a workspace. Each template stores the invoice payload, recurrence cadence, and next run date. Credit memos cannot be recurring.", "type": "text/plain" }, "item": [ { "id": "215141d8-20c8-48bb-8980-fc22eee80840", "name": "Returns a paginated list of recurring invoice templates in the workspace.", "request": { "name": "Returns a paginated list of recurring invoice templates in the workspace.", "description": { "content": "Defaults to non-draft templates. Pass isDraft=true to retrieve templates still seeded from a draft invoice, or isDraft=all for both. Results embed the customer and line items. Use search and ordering to narrow the list.", "type": "text/plain" }, "url": { "path": [ "partners", "recurring-invoice-templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Page number for pagination. The first page is 1." }, { "disabled": false, "key": "limit", "value": "", "description": "Records to return per page." }, { "disabled": false, "key": "search", "value": "", "description": "Partial, case-insensitive match across invoice title, summary, email, customer name, and total amount." }, { "disabled": false, "key": "orderBy", "value": "", "description": "Field to sort by. Defaults to nextInvoiceDate." }, { "disabled": false, "key": "orderDirection", "value": "", "description": "Sort direction. Defaults to DESC." }, { "disabled": false, "key": "isDraft", "value": "", "description": "Draft filter: true returns only templates still seeded from a draft invoice, false (default) returns only active templates, all returns both." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "28461685-bd68-410e-ab6f-79477d15f47a", "name": "Paginated list of recurring invoice templates.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "retainer" }, { "key": "orderBy", "value": "" }, { "key": "orderDirection", "value": "" }, { "key": "isDraft", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on fetching recurring invoice templates\",\n \"data\": {\n \"result\": [\n {\n \"id\": \"c4d5e6f7-a8b9-0123-cdef-456789012345\",\n \"invoiceTitle\": \"Monthly consulting retainer\",\n \"summary\": \"Recurring monthly invoice for Acme Corporation\",\n \"email\": \"contact@acme.com\",\n \"currency\": \"USD\",\n \"subtotal\": 1000,\n \"taxTotal\": 85,\n \"total\": 1085,\n \"invoiceType\": \"invoice\",\n \"customer\": {\n \"id\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\",\n \"email\": \"contact@acme.com\",\n \"contactName\": \"John Doe\"\n },\n \"invoiceProducts\": [\n {\n \"id\": \"d5e6f7a8-b9c0-1234-defa-567890123456\",\n \"productServiceId\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Consulting services\",\n \"quantity\": 10,\n \"unitPrice\": 100,\n \"price\": 100,\n \"nonTaxable\": false\n }\n ],\n \"createdInvoiceTemplate\": {\n \"recurrencePattern\": \"monthly\",\n \"recurrenceInterval\": 1,\n \"occurrenceCount\": null,\n \"remainingOccurrence\": null,\n \"recurrenceEndDate\": null,\n \"nextInvoiceDate\": \"2026-04-01\",\n \"inAdvanceCreationDays\": 0,\n \"creationDate\": \"2026-04-01\",\n \"emailCustomer\": true\n },\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n ],\n \"page\": 1,\n \"limit\": 20,\n \"totalPages\": 1,\n \"totalRecords\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31eb9378-1ee7-4bf8-b450-8703210e9e06", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "retainer" }, { "key": "orderBy", "value": "" }, { "key": "orderDirection", "value": "" }, { "key": "isDraft", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c8f4c7a1-4c79-428c-b2d3-2d6451f1889f", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "retainer" }, { "key": "orderBy", "value": "" }, { "key": "orderDirection", "value": "" }, { "key": "isDraft", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7443f8c8-c4ca-473e-8d9c-5c878890d424", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "retainer" }, { "key": "orderBy", "value": "" }, { "key": "orderDirection", "value": "" }, { "key": "isDraft", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6e98ffbc-dfb7-44e6-af3d-b252ac7f53e9", "name": "Creates a draft invoice plus a recurring template with the supplied schedule.", "request": { "name": "Creates a draft invoice plus a recurring template with the supplied schedule.", "description": { "content": "Same UUID payload rules as invoice create, plus required `recurrencePattern`. `invoiceType` defaults to invoice; memo is rejected, which also makes `dueDate` effectively required. `isDraft` defaults to true, so `customerUuid` is not required unless `isDraft` is set to false — resume the template to start generation.", "type": "text/plain" }, "url": { "path": [ "partners", "recurring-invoice-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"recurrencePattern\": \"\",\n \"invoiceNumber\": \"\",\n \"date\": \"\",\n \"dueDate\": \"\",\n \"products\": [\n {\n \"productUuid\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"unitPrice\": \"\",\n \"nonTaxable\": \"\"\n },\n {\n \"productUuid\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"unitPrice\": \"\",\n \"nonTaxable\": \"\"\n }\n ],\n \"customerUuid\": \"\",\n \"invoiceType\": \"\",\n \"currency\": \"\",\n \"recurrenceInterval\": \"\",\n \"recurrenceEndDate\": \"\",\n \"occurrenceCount\": \"\",\n \"inAdvanceCreationDays\": \"\",\n \"emailCustomer\": \"\",\n \"isDraft\": \"\",\n \"projectUuid\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "34b954ec-e31e-4dbe-ba56-63b17b6a0a24", "name": "Template and draft invoice created.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"invoiceType\": \"invoice\",\n \"invoiceNumber\": \"INV-1042\",\n \"date\": \"2026-03-01\",\n \"dueDate\": \"2026-03-31\",\n \"currency\": \"USD\",\n \"recurrencePattern\": \"monthly\",\n \"recurrenceInterval\": 1,\n \"inAdvanceCreationDays\": 0,\n \"emailCustomer\": true,\n \"isDraft\": true,\n \"products\": [\n {\n \"productUuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Consulting services\",\n \"quantity\": 10,\n \"unitPrice\": 100,\n \"nonTaxable\": false\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Invoice and recurring template created\",\n \"data\": {\n \"invoice\": {\n \"id\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"invoiceNumber\": \"INV-1042\"\n },\n \"recurringTemplate\": {\n \"id\": \"c4d5e6f7-a8b9-0123-cdef-456789012345\",\n \"invoiceTitle\": \"Monthly consulting retainer\",\n \"summary\": \"Recurring monthly invoice for Acme Corporation\",\n \"email\": \"contact@acme.com\",\n \"currency\": \"USD\",\n \"subtotal\": 1000,\n \"taxTotal\": 85,\n \"total\": 1085,\n \"invoiceType\": \"invoice\",\n \"customer\": {\n \"id\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\",\n \"email\": \"contact@acme.com\",\n \"contactName\": \"John Doe\"\n },\n \"invoiceProducts\": [\n {\n \"id\": \"d5e6f7a8-b9c0-1234-defa-567890123456\",\n \"productServiceId\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Consulting services\",\n \"quantity\": 10,\n \"unitPrice\": 100,\n \"price\": 100,\n \"nonTaxable\": false\n }\n ],\n \"createdInvoiceTemplate\": {\n \"recurrencePattern\": \"monthly\",\n \"recurrenceInterval\": 1,\n \"occurrenceCount\": null,\n \"remainingOccurrence\": null,\n \"recurrenceEndDate\": null,\n \"nextInvoiceDate\": \"2026-04-01\",\n \"inAdvanceCreationDays\": 0,\n \"creationDate\": \"2026-04-01\",\n \"emailCustomer\": true\n },\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91fe5bb3-ff02-470b-a82d-07380c067db8", "name": "Validation failed — missing recurrencePattern, invoiceNumber, date, or dueDate; memo invoiceType; or invalid UUID references.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"invoiceType\": \"invoice\",\n \"invoiceNumber\": \"INV-1042\",\n \"date\": \"2026-03-01\",\n \"dueDate\": \"2026-03-31\",\n \"currency\": \"USD\",\n \"recurrencePattern\": \"monthly\",\n \"recurrenceInterval\": 1,\n \"inAdvanceCreationDays\": 0,\n \"emailCustomer\": true,\n \"isDraft\": true,\n \"products\": [\n {\n \"productUuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Consulting services\",\n \"quantity\": 10,\n \"unitPrice\": 100,\n \"nonTaxable\": false\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1a22759a-5aac-4d87-9805-01ecba09f40c", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"invoiceType\": \"invoice\",\n \"invoiceNumber\": \"INV-1042\",\n \"date\": \"2026-03-01\",\n \"dueDate\": \"2026-03-31\",\n \"currency\": \"USD\",\n \"recurrencePattern\": \"monthly\",\n \"recurrenceInterval\": 1,\n \"inAdvanceCreationDays\": 0,\n \"emailCustomer\": true,\n \"isDraft\": true,\n \"products\": [\n {\n \"productUuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Consulting services\",\n \"quantity\": 10,\n \"unitPrice\": 100,\n \"nonTaxable\": false\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6846ec3d-b827-4f8e-93e5-3df890a3f3c0", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"invoiceType\": \"invoice\",\n \"invoiceNumber\": \"INV-1042\",\n \"date\": \"2026-03-01\",\n \"dueDate\": \"2026-03-31\",\n \"currency\": \"USD\",\n \"recurrencePattern\": \"monthly\",\n \"recurrenceInterval\": 1,\n \"inAdvanceCreationDays\": 0,\n \"emailCustomer\": true,\n \"isDraft\": true,\n \"products\": [\n {\n \"productUuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Consulting services\",\n \"quantity\": 10,\n \"unitPrice\": 100,\n \"nonTaxable\": false\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dc122802-5a1d-430e-b45c-87c877e6cc75", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"invoiceType\": \"invoice\",\n \"invoiceNumber\": \"INV-1042\",\n \"date\": \"2026-03-01\",\n \"dueDate\": \"2026-03-31\",\n \"currency\": \"USD\",\n \"recurrencePattern\": \"monthly\",\n \"recurrenceInterval\": 1,\n \"inAdvanceCreationDays\": 0,\n \"emailCustomer\": true,\n \"isDraft\": true,\n \"products\": [\n {\n \"productUuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Consulting services\",\n \"quantity\": 10,\n \"unitPrice\": 100,\n \"nonTaxable\": false\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9fd05e1f-2489-4432-ba9b-02c00e36e8a2", "name": "Retrieves a single recurring invoice template by its UUID.", "request": { "name": "Retrieves a single recurring invoice template by its UUID.", "description": {}, "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID as returned in list and create responses." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "37c187f8-7cfd-4338-ac77-6a3293f7c211", "name": "The requested template.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID as returned in list and create responses." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on fetching recurring invoice template\",\n \"data\": {\n \"result\": {\n \"id\": \"c4d5e6f7-a8b9-0123-cdef-456789012345\",\n \"invoiceTitle\": \"Monthly consulting retainer\",\n \"summary\": \"Recurring monthly invoice for Acme Corporation\",\n \"email\": \"contact@acme.com\",\n \"currency\": \"USD\",\n \"subtotal\": 1000,\n \"taxTotal\": 85,\n \"total\": 1085,\n \"invoiceType\": \"invoice\",\n \"customer\": {\n \"id\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\",\n \"email\": \"contact@acme.com\",\n \"contactName\": \"John Doe\"\n },\n \"invoiceProducts\": [\n {\n \"id\": \"d5e6f7a8-b9c0-1234-defa-567890123456\",\n \"productServiceId\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Consulting services\",\n \"quantity\": 10,\n \"unitPrice\": 100,\n \"price\": 100,\n \"nonTaxable\": false\n }\n ],\n \"createdInvoiceTemplate\": {\n \"recurrencePattern\": \"monthly\",\n \"recurrenceInterval\": 1,\n \"occurrenceCount\": null,\n \"remainingOccurrence\": null,\n \"recurrenceEndDate\": null,\n \"nextInvoiceDate\": \"2026-04-01\",\n \"inAdvanceCreationDays\": 0,\n \"creationDate\": \"2026-04-01\",\n \"emailCustomer\": true\n },\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f6a3147-4986-456b-b183-713694ef6788", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID as returned in list and create responses." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a9d51871-71d3-4fc0-8c51-46f63c40827d", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID as returned in list and create responses." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5776fdb1-e4d6-438c-9a7e-82d1de762bdd", "name": "Recurring invoice template not found.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID as returned in list and create responses." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dfa36724-48c0-411d-b029-e319cea912d2", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID as returned in list and create responses." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6f184d53-8051-43f7-9360-1a6831fe2114", "name": "Updates an existing recurring invoice template. Only sent fields are changed.", "request": { "name": "Updates an existing recurring invoice template. Only sent fields are changed.", "description": { "content": "You may update invoice fields (customer, line items, totals), recurrence settings, and `nextInvoiceDate`. Changing recurrence recalculates remaining occurrences when an end date is set.", "type": "text/plain" }, "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID to update." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"nextInvoiceDate\": \"\",\n \"recurrencePattern\": \"\",\n \"recurrenceInterval\": \"\",\n \"recurrenceEndDate\": \"\",\n \"inAdvanceCreationDays\": \"\",\n \"emailCustomer\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "68f7c9c5-3536-4127-aa7b-e33a810fdc74", "name": "Template updated successfully.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"recurrencePattern\": \"monthly\",\n \"recurrenceInterval\": 2,\n \"nextInvoiceDate\": \"2026-05-01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success on updating recurring invoice template\",\n \"data\": {\n \"result\": {\n \"id\": \"c4d5e6f7-a8b9-0123-cdef-456789012345\",\n \"invoiceTitle\": \"Monthly consulting retainer\",\n \"summary\": \"Recurring monthly invoice for Acme Corporation\",\n \"email\": \"contact@acme.com\",\n \"currency\": \"USD\",\n \"subtotal\": 1000,\n \"taxTotal\": 85,\n \"total\": 1085,\n \"invoiceType\": \"invoice\",\n \"customer\": {\n \"id\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\",\n \"email\": \"contact@acme.com\",\n \"contactName\": \"John Doe\"\n },\n \"invoiceProducts\": [\n {\n \"id\": \"d5e6f7a8-b9c0-1234-defa-567890123456\",\n \"productServiceId\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Consulting services\",\n \"quantity\": 10,\n \"unitPrice\": 100,\n \"price\": 100,\n \"nonTaxable\": false\n }\n ],\n \"createdInvoiceTemplate\": {\n \"recurrencePattern\": \"monthly\",\n \"recurrenceInterval\": 2,\n \"occurrenceCount\": null,\n \"remainingOccurrence\": null,\n \"recurrenceEndDate\": null,\n \"nextInvoiceDate\": \"2026-05-01\",\n \"inAdvanceCreationDays\": 0,\n \"creationDate\": \"2026-04-01\",\n \"emailCustomer\": true\n },\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1865f9a7-2c31-4af0-a742-093320d120b9", "name": "Invalid recurrence configuration or field change.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"recurrencePattern\": \"monthly\",\n \"recurrenceInterval\": 2,\n \"nextInvoiceDate\": \"2026-05-01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bc27ea3f-91ec-42fc-918f-04bb2064436d", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"recurrencePattern\": \"monthly\",\n \"recurrenceInterval\": 2,\n \"nextInvoiceDate\": \"2026-05-01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "439ddf76-6b23-417e-8883-07deefe39347", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"recurrencePattern\": \"monthly\",\n \"recurrenceInterval\": 2,\n \"nextInvoiceDate\": \"2026-05-01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c7df32a2-d2c9-4390-bab8-52eae71cf6ec", "name": "Recurring invoice template not found.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"recurrencePattern\": \"monthly\",\n \"recurrenceInterval\": 2,\n \"nextInvoiceDate\": \"2026-05-01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4669db60-313d-4ecf-8c5a-230443573deb", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"recurrencePattern\": \"monthly\",\n \"recurrenceInterval\": 2,\n \"nextInvoiceDate\": \"2026-05-01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "54942697-8125-47b6-ba55-c8d9e5e3784a", "name": "Removes a recurring invoice template and stops future generation.", "request": { "name": "Removes a recurring invoice template and stops future generation.", "description": {}, "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID to delete." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "b223ad2c-720d-4bb3-add5-19188ec08f7f", "name": "Template removed.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"Success\",\n \"message\": \"Success on removing recurring invoice template\",\n \"data\": {\n \"result\": {\n \"id\": \"c4d5e6f7-a8b9-0123-cdef-456789012345\",\n \"isDeleted\": true\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "748f8b20-a5b6-4d7e-ab2b-3bd3c410c697", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "47beeb95-071a-4196-b35d-354deef45efe", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cbb2ddce-d833-4ef7-be37-564d7dd53757", "name": "Recurring invoice template not found.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4db699af-f983-4905-8019-dee83581a95a", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d8626d77-2272-4a43-854b-03af5a4cd583", "name": "Pauses generation by clearing nextInvoiceDate.", "request": { "name": "Pauses generation by clearing nextInvoiceDate.", "description": { "content": "No request body is required. The template remains in the workspace but will not generate invoices until resumed.", "type": "text/plain" }, "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID to pause." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "6b9ca5b2-d830-4f77-82b4-5302da62a532", "name": "Template paused.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID to pause." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Recurring invoice template paused\",\n \"data\": {\n \"result\": {\n \"id\": \"c4d5e6f7-a8b9-0123-cdef-456789012345\",\n \"invoiceTitle\": \"Monthly consulting retainer\",\n \"summary\": \"Recurring monthly invoice for Acme Corporation\",\n \"email\": \"contact@acme.com\",\n \"currency\": \"USD\",\n \"subtotal\": 1000,\n \"taxTotal\": 85,\n \"total\": 1085,\n \"invoiceType\": \"invoice\",\n \"customer\": {\n \"id\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\",\n \"email\": \"contact@acme.com\",\n \"contactName\": \"John Doe\"\n },\n \"invoiceProducts\": [\n {\n \"id\": \"d5e6f7a8-b9c0-1234-defa-567890123456\",\n \"productServiceId\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Consulting services\",\n \"quantity\": 10,\n \"unitPrice\": 100,\n \"price\": 100,\n \"nonTaxable\": false\n }\n ],\n \"createdInvoiceTemplate\": {\n \"recurrencePattern\": \"monthly\",\n \"recurrenceInterval\": 1,\n \"occurrenceCount\": null,\n \"remainingOccurrence\": null,\n \"recurrenceEndDate\": null,\n \"nextInvoiceDate\": null,\n \"inAdvanceCreationDays\": 0,\n \"creationDate\": \"2026-04-01\",\n \"emailCustomer\": true\n },\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "553ac5bd-478d-4b31-9fc1-7b26bf96f86d", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID to pause." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4957709e-0771-4a2f-915f-6c0f14ff3bb7", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID to pause." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "54cf56f7-2c58-4445-9b58-6141b3b6161d", "name": "Recurring invoice template not found.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID to pause." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ddf6c3bf-4509-4ddd-9214-6dc6dad90ebd", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID to pause." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6d68f90e-d93b-4733-ae30-a2a05e4e7dce", "name": "Resumes generation by setting nextInvoiceDate.", "request": { "name": "Resumes generation by setting nextInvoiceDate.", "description": { "content": "The JSON body must include `nextInvoiceDate` (ISO date). Returns 400 when it is omitted.", "type": "text/plain" }, "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID to resume." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"nextInvoiceDate\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "06d7eff1-1176-43b0-846d-5f09511e16cc", "name": "Template resumed.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID to resume." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"nextInvoiceDate\": \"2026-04-01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Recurring invoice template resumed\",\n \"data\": {\n \"result\": {\n \"id\": \"c4d5e6f7-a8b9-0123-cdef-456789012345\",\n \"invoiceTitle\": \"Monthly consulting retainer\",\n \"summary\": \"Recurring monthly invoice for Acme Corporation\",\n \"email\": \"contact@acme.com\",\n \"currency\": \"USD\",\n \"subtotal\": 1000,\n \"taxTotal\": 85,\n \"total\": 1085,\n \"invoiceType\": \"invoice\",\n \"customer\": {\n \"id\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\",\n \"email\": \"contact@acme.com\",\n \"contactName\": \"John Doe\"\n },\n \"invoiceProducts\": [\n {\n \"id\": \"d5e6f7a8-b9c0-1234-defa-567890123456\",\n \"productServiceId\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Consulting services\",\n \"quantity\": 10,\n \"unitPrice\": 100,\n \"price\": 100,\n \"nonTaxable\": false\n }\n ],\n \"createdInvoiceTemplate\": {\n \"recurrencePattern\": \"monthly\",\n \"recurrenceInterval\": 1,\n \"occurrenceCount\": null,\n \"remainingOccurrence\": null,\n \"recurrenceEndDate\": null,\n \"nextInvoiceDate\": \"2026-04-01\",\n \"inAdvanceCreationDays\": 0,\n \"creationDate\": \"2026-04-01\",\n \"emailCustomer\": true\n },\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5524b30b-2f92-42fc-a8e4-22e3be4a27e8", "name": "nextInvoiceDate is required to resume a recurring invoice template.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID to resume." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"nextInvoiceDate\": \"2026-04-01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "24b4c5db-33da-418e-bbcf-49b9ff6767fe", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID to resume." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"nextInvoiceDate\": \"2026-04-01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "878dd995-3c39-4b04-b1ad-e4083aba84c1", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID to resume." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"nextInvoiceDate\": \"2026-04-01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "231e4cfc-d52b-4f48-8e26-878eb9f123ed", "name": "Recurring invoice template not found.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID to resume." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"nextInvoiceDate\": \"2026-04-01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "23c50d97-865c-4a4a-8029-90f0afbb531f", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "recurring-invoice-templates", ":uuid", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The template UUID to resume." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"nextInvoiceDate\": \"2026-04-01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "642e1cb1-e468-4e3b-a884-0f4d2d3c50ab", "name": "Bills", "description": { "content": "Bills are vendor payables — amounts your workspace owes to suppliers. Partner routes cover listing, creating, updating, approving, and deleting bills, applying vendor memos, and removing transaction payments. All references use UUIDs.", "type": "text/plain" }, "item": [ { "id": "47d41f44-fba5-4ecb-8a16-ff9238253721", "name": "Returns a paginated list of bills and vendor memos in the workspace.", "request": { "name": "Returns a paginated list of bills and vendor memos in the workspace.", "description": { "content": "Each row exposes id as the bill UUID for detail and payment routes. Default limit is 50.", "type": "text/plain" }, "url": { "path": [ "partners", "bills" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Page number for pagination. The first page is 1." }, { "disabled": false, "key": "limit", "value": "", "description": "Records to return per page." }, { "disabled": false, "key": "billType", "value": "", "description": "Filter by document type." }, { "disabled": false, "key": "approvalStatus", "value": "", "description": "Filter by approval state." }, { "disabled": false, "key": "status", "value": "", "description": "Comma-separated approval and payment status tokens (for example draft,approved,paid)." }, { "disabled": false, "key": "vendorUuids", "value": "", "description": "Comma-separated vendor UUIDs from the Vendors API." }, { "disabled": false, "key": "projectUuids", "value": "", "description": "Comma-separated project UUIDs." }, { "disabled": false, "key": "currency", "value": "", "description": "Filter by ISO 4217 currency code." }, { "disabled": false, "key": "search", "value": "", "description": "Substring match against bill number or vendor name." }, { "disabled": false, "key": "startDate", "value": "", "description": "Bill date range start (ISO, inclusive)." }, { "disabled": false, "key": "endDate", "value": "", "description": "Bill date range end (ISO, inclusive)." }, { "disabled": false, "key": "startDueDate", "value": "", "description": "Due date range start (ISO, inclusive)." }, { "disabled": false, "key": "endDueDate", "value": "", "description": "Due date range end (ISO, inclusive)." }, { "disabled": false, "key": "amount", "value": "", "description": "Filter by bill total. Pair with amountOperator." }, { "disabled": false, "key": "amountOperator", "value": "", "description": "Comparison operator for amount filter." }, { "disabled": false, "key": "orderBy", "value": "", "description": "Sort field (for example id, date, dueDate, vendor, status). Defaults to id." }, { "disabled": false, "key": "orderDirection", "value": "", "description": "Sort direction. Defaults to DESC." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "acb8f6d1-7726-4ec8-82d0-ef4aa06855bd", "name": "Paginated list of bills.", "originalRequest": { "url": { "path": [ "partners", "bills" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "billType", "value": "" }, { "key": "approvalStatus", "value": "" }, { "key": "status", "value": "approved,unpaid" }, { "key": "vendorUuids", "value": "f1a2b3c4-d5e6-7890-abcd-ef1234567890" }, { "key": "projectUuids", "value": "" }, { "key": "currency", "value": "USD" }, { "key": "search", "value": "office" }, { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "startDueDate", "value": "" }, { "key": "endDueDate", "value": "" }, { "key": "amount", "value": "100" }, { "key": "amountOperator", "value": "" }, { "key": "orderBy", "value": "" }, { "key": "orderDirection", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": 1,\n \"page\": 1,\n \"limit\": 50,\n \"totalRecords\": 1,\n \"filters\": {\n \"search\": null,\n \"status\": null\n },\n \"bills\": [\n {\n \"id\": \"b2c3d4e5-f6a7-8901-bcde-f23456789012\",\n \"billNumber\": \"BILL-1042\",\n \"billType\": \"bill\",\n \"date\": \"2026-01-15\",\n \"dueDate\": \"2026-02-15\",\n \"currency\": \"USD\",\n \"approvalStatus\": \"approved\",\n \"status\": \"unpaid\",\n \"total\": 250,\n \"paidAmount\": 0,\n \"amountDue\": 250,\n \"notes\": \"Office supplies for Q1\",\n \"purchaseOrderNumber\": null,\n \"isDeleted\": false,\n \"vendor\": {\n \"id\": \"f1a2b3c4-d5e6-7890-abcd-ef1234567890\",\n \"name\": \"Office Depot\",\n \"email\": \"ap@officedepot.example\"\n },\n \"lineItems\": [\n {\n \"id\": \"a4b5c6d7-e8f9-0123-abcd-456789012345\",\n \"description\": \"Office supplies\",\n \"quantity\": 1,\n \"price\": 250,\n \"total\": 250,\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\"\n }\n ],\n \"transactions\": [],\n \"appliedVendorMemos\": [],\n \"tagUuids\": [],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5452a286-bbc9-4d95-a905-4a13700837ce", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "bills" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "billType", "value": "" }, { "key": "approvalStatus", "value": "" }, { "key": "status", "value": "approved,unpaid" }, { "key": "vendorUuids", "value": "f1a2b3c4-d5e6-7890-abcd-ef1234567890" }, { "key": "projectUuids", "value": "" }, { "key": "currency", "value": "USD" }, { "key": "search", "value": "office" }, { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "startDueDate", "value": "" }, { "key": "endDueDate", "value": "" }, { "key": "amount", "value": "100" }, { "key": "amountOperator", "value": "" }, { "key": "orderBy", "value": "" }, { "key": "orderDirection", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "48a5d328-5c46-469b-9841-f9f6efd3c87d", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "bills" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "billType", "value": "" }, { "key": "approvalStatus", "value": "" }, { "key": "status", "value": "approved,unpaid" }, { "key": "vendorUuids", "value": "f1a2b3c4-d5e6-7890-abcd-ef1234567890" }, { "key": "projectUuids", "value": "" }, { "key": "currency", "value": "USD" }, { "key": "search", "value": "office" }, { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "startDueDate", "value": "" }, { "key": "endDueDate", "value": "" }, { "key": "amount", "value": "100" }, { "key": "amountOperator", "value": "" }, { "key": "orderBy", "value": "" }, { "key": "orderDirection", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "98a89f78-c63a-4814-8417-3958fd97a25d", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "bills" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "billType", "value": "" }, { "key": "approvalStatus", "value": "" }, { "key": "status", "value": "approved,unpaid" }, { "key": "vendorUuids", "value": "f1a2b3c4-d5e6-7890-abcd-ef1234567890" }, { "key": "projectUuids", "value": "" }, { "key": "currency", "value": "USD" }, { "key": "search", "value": "office" }, { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "startDueDate", "value": "" }, { "key": "endDueDate", "value": "" }, { "key": "amount", "value": "100" }, { "key": "amountOperator", "value": "" }, { "key": "orderBy", "value": "" }, { "key": "orderDirection", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2d2f0e33-cb5e-4c0f-9dce-19b77937d4ef", "name": "Creates a new vendor bill (draft by default, or approved for migrations).", "request": { "name": "Creates a new vendor bill (draft by default, or approved for migrations).", "description": { "content": "Required: exactly one of vendorUuid OR inline vendor object, date, dueDate, and lineItems with categoryAccountUuid, quantity, and price. Optional approvalStatus (draft | approved). Inline vendors are echoed on the response as _partnerInlineCreated.", "type": "text/plain" }, "url": { "path": [ "partners", "bills" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"date\": \"\",\n \"dueDate\": \"\",\n \"lineItems\": [\n {\n \"categoryAccountUuid\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"projectUuid\": \"\",\n \"customerUuid\": \"\"\n },\n {\n \"categoryAccountUuid\": \"\",\n \"description\": \"\",\n \"quantity\": \"\",\n \"price\": \"\",\n \"projectUuid\": \"\",\n \"customerUuid\": \"\"\n }\n ],\n \"vendorUuid\": \"\",\n \"vendor\": {\n \"name\": \"\",\n \"email\": \"\"\n },\n \"billNumber\": \"\",\n \"purchaseOrderNumber\": \"\",\n \"notes\": \"\",\n \"currency\": \"\",\n \"projectUuid\": \"\",\n \"approvalStatus\": \"\",\n \"attachments\": [\n {\n \"url\": \"\",\n \"title\": \"\"\n },\n {\n \"url\": \"\",\n \"title\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c3d68e69-ac53-45dd-8d42-4ef7e44d7e24", "name": "Bill created in draft.", "originalRequest": { "url": { "path": [ "partners", "bills" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vendorUuid\": \"f1a2b3c4-d5e6-7890-abcd-ef1234567890\",\n \"date\": \"2026-01-15\",\n \"dueDate\": \"2026-02-15\",\n \"lineItems\": [\n {\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"description\": \"Office supplies\",\n \"quantity\": 1,\n \"price\": 250\n }\n ],\n \"notes\": \"Q1 office supplies\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"b2c3d4e5-f6a7-8901-bcde-f23456789012\",\n \"billNumber\": \"BILL-1043\",\n \"billType\": \"bill\",\n \"date\": \"2026-01-15\",\n \"dueDate\": \"2026-02-15\",\n \"currency\": \"USD\",\n \"approvalStatus\": \"draft\",\n \"status\": \"draft\",\n \"total\": 250,\n \"paidAmount\": 0,\n \"amountDue\": 250,\n \"notes\": \"Office supplies for Q1\",\n \"purchaseOrderNumber\": null,\n \"isDeleted\": false,\n \"vendor\": {\n \"id\": \"f1a2b3c4-d5e6-7890-abcd-ef1234567890\",\n \"name\": \"Office Depot\",\n \"email\": \"ap@officedepot.example\"\n },\n \"lineItems\": [\n {\n \"id\": \"a4b5c6d7-e8f9-0123-abcd-456789012345\",\n \"description\": \"Office supplies\",\n \"quantity\": 1,\n \"price\": 250,\n \"total\": 250,\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\"\n }\n ],\n \"transactions\": [],\n \"appliedVendorMemos\": [],\n \"tagUuids\": [],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a0b13df-8abb-4a1f-81e5-37292bbd62ba", "name": "Validation failed — missing required fields or invalid UUID references.", "originalRequest": { "url": { "path": [ "partners", "bills" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vendorUuid\": \"f1a2b3c4-d5e6-7890-abcd-ef1234567890\",\n \"date\": \"2026-01-15\",\n \"dueDate\": \"2026-02-15\",\n \"lineItems\": [\n {\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"description\": \"Office supplies\",\n \"quantity\": 1,\n \"price\": 250\n }\n ],\n \"notes\": \"Q1 office supplies\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b32343d3-2308-49ef-89d8-029f8544d0a1", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "bills" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vendorUuid\": \"f1a2b3c4-d5e6-7890-abcd-ef1234567890\",\n \"date\": \"2026-01-15\",\n \"dueDate\": \"2026-02-15\",\n \"lineItems\": [\n {\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"description\": \"Office supplies\",\n \"quantity\": 1,\n \"price\": 250\n }\n ],\n \"notes\": \"Q1 office supplies\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "815f0e2a-2ab3-4939-ba44-e0236c60eeb8", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "bills" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vendorUuid\": \"f1a2b3c4-d5e6-7890-abcd-ef1234567890\",\n \"date\": \"2026-01-15\",\n \"dueDate\": \"2026-02-15\",\n \"lineItems\": [\n {\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"description\": \"Office supplies\",\n \"quantity\": 1,\n \"price\": 250\n }\n ],\n \"notes\": \"Q1 office supplies\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a701532e-873d-40c8-bc82-483bd9ca6bcc", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "bills" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"vendorUuid\": \"f1a2b3c4-d5e6-7890-abcd-ef1234567890\",\n \"date\": \"2026-01-15\",\n \"dueDate\": \"2026-02-15\",\n \"lineItems\": [\n {\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"description\": \"Office supplies\",\n \"quantity\": 1,\n \"price\": 250\n }\n ],\n \"notes\": \"Q1 office supplies\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fc47053e-51fc-420a-8cd0-66bbff6cebe3", "name": "Retrieves a single bill by its UUID.", "request": { "name": "Retrieves a single bill by its UUID.", "description": { "content": "Returns line items, vendor, transactions (payments), and applied vendor memos. Soft-deleted bills may still be returned — check isDeleted.", "type": "text/plain" }, "url": { "path": [ "partners", "bills", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID from list responses." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "7fdcc226-2bca-4d73-adc6-cff307d9390b", "name": "The requested bill.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID from list responses." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"b2c3d4e5-f6a7-8901-bcde-f23456789012\",\n \"billNumber\": \"BILL-1042\",\n \"billType\": \"bill\",\n \"date\": \"2026-01-15\",\n \"dueDate\": \"2026-02-15\",\n \"currency\": \"USD\",\n \"approvalStatus\": \"approved\",\n \"status\": \"unpaid\",\n \"total\": 250,\n \"paidAmount\": 0,\n \"amountDue\": 250,\n \"notes\": \"Office supplies for Q1\",\n \"purchaseOrderNumber\": null,\n \"isDeleted\": false,\n \"vendor\": {\n \"id\": \"f1a2b3c4-d5e6-7890-abcd-ef1234567890\",\n \"name\": \"Office Depot\",\n \"email\": \"ap@officedepot.example\"\n },\n \"lineItems\": [\n {\n \"id\": \"a4b5c6d7-e8f9-0123-abcd-456789012345\",\n \"description\": \"Office supplies\",\n \"quantity\": 1,\n \"price\": 250,\n \"total\": 250,\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\"\n }\n ],\n \"transactions\": [],\n \"appliedVendorMemos\": [],\n \"tagUuids\": [],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c5af3d1-b0eb-4014-9d01-4f5ca05465c9", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID from list responses." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d5f9b1c3-0bb4-4ca7-a442-04b5b5208051", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID from list responses." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "34bfe18d-a0e9-4f01-9cc5-4bb351a18f8e", "name": "Bill not found.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID from list responses." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "35e36e74-5947-4efb-8c15-f589a07e803e", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID from list responses." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb62fa78-ccd9-46ef-bdf7-4ca50ccd63cb", "name": "Updates a bill. Only the fields you send are changed.", "request": { "name": "Updates a bill. Only the fields you send are changed.", "description": { "content": "Same UUID field names as create. Providing lineItems replaces all lines. Approved or paid bills restrict which fields can change.", "type": "text/plain" }, "url": { "path": [ "partners", "bills", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID to update." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"vendorUuid\": \"\",\n \"date\": \"\",\n \"dueDate\": \"\",\n \"billNumber\": \"\",\n \"purchaseOrderNumber\": \"\",\n \"notes\": \"\",\n \"currency\": \"\",\n \"projectUuid\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "52ca165e-c0d1-4757-a2fc-bd9b7376afc5", "name": "Bill updated successfully.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"dueDate\": \"2026-03-01\",\n \"notes\": \"Extended payment terms\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Bill updated successfully\",\n \"data\": {\n \"id\": \"b2c3d4e5-f6a7-8901-bcde-f23456789012\",\n \"billNumber\": \"BILL-1042\",\n \"billType\": \"bill\",\n \"date\": \"2026-01-15\",\n \"dueDate\": \"2026-03-01\",\n \"currency\": \"USD\",\n \"approvalStatus\": \"approved\",\n \"status\": \"unpaid\",\n \"total\": 250,\n \"paidAmount\": 0,\n \"amountDue\": 250,\n \"notes\": \"Extended payment terms\",\n \"purchaseOrderNumber\": null,\n \"isDeleted\": false,\n \"vendor\": {\n \"id\": \"f1a2b3c4-d5e6-7890-abcd-ef1234567890\",\n \"name\": \"Office Depot\",\n \"email\": \"ap@officedepot.example\"\n },\n \"lineItems\": [\n {\n \"id\": \"a4b5c6d7-e8f9-0123-abcd-456789012345\",\n \"description\": \"Office supplies\",\n \"quantity\": 1,\n \"price\": 250,\n \"total\": 250,\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\"\n }\n ],\n \"transactions\": [],\n \"appliedVendorMemos\": [],\n \"tagUuids\": [],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93dda4e3-c9de-4b6d-8110-77c34da7bfd9", "name": "Change not allowed on approved or paid bill.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"dueDate\": \"2026-03-01\",\n \"notes\": \"Extended payment terms\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "87182341-9f69-4a27-bdc7-3ccbd40a7b99", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"dueDate\": \"2026-03-01\",\n \"notes\": \"Extended payment terms\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "15b2b86b-a2bc-4e8b-99fb-9d2e48d7b433", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"dueDate\": \"2026-03-01\",\n \"notes\": \"Extended payment terms\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b1900d50-9a50-490f-9067-0486718c4247", "name": "Bill not found.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"dueDate\": \"2026-03-01\",\n \"notes\": \"Extended payment terms\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6f9986cf-1469-4d66-b382-d404c78a72fb", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"dueDate\": \"2026-03-01\",\n \"notes\": \"Extended payment terms\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "39d6bd35-bef3-4c00-a202-185752a5888b", "name": "Soft-deletes a draft bill.", "request": { "name": "Soft-deletes a draft bill.", "description": { "content": "Bills with paidAmount > 0 cannot be deleted. Unassign payments first.", "type": "text/plain" }, "url": { "path": [ "partners", "bills", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID to delete." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "680eff66-0512-465c-9559-514689b4d298", "name": "Bill deleted.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Bill deleted successfully\",\n \"data\": {\n \"id\": \"b2c3d4e5-f6a7-8901-bcde-f23456789012\",\n \"isDeleted\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c010117-dafd-4102-9121-03c8524d0bba", "name": "Bill has payments applied and cannot be deleted.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c8e25f78-baa4-4648-8415-4187f1c0b601", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1e3ea4c5-7d6b-443a-be7e-a66160ac5349", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "129a5764-3075-45ce-939c-2f6689b060ab", "name": "Bill not found.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ece36c97-1c96-4cd5-abd5-9e94dd2c1fef", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "58da2e44-3102-4d18-ba92-49adf7c0d90b", "name": "Approves a draft bill and posts journal entries.", "request": { "name": "Approves a draft bill and posts journal entries.", "description": { "content": "Makes the bill eligible for transaction payment and vendor memo application. Returns 400 if already approved or line items are missing.", "type": "text/plain" }, "url": { "path": [ "partners", "bills", ":uuid", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID to approve." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "fa8b0710-5eca-4f78-ae09-64610cf21f9c", "name": "Bill approved.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID to approve." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Bill approved\",\n \"data\": {\n \"id\": \"b2c3d4e5-f6a7-8901-bcde-f23456789012\",\n \"billNumber\": \"BILL-1042\",\n \"billType\": \"bill\",\n \"date\": \"2026-01-15\",\n \"dueDate\": \"2026-02-15\",\n \"currency\": \"USD\",\n \"approvalStatus\": \"approved\",\n \"status\": \"unpaid\",\n \"total\": 250,\n \"paidAmount\": 0,\n \"amountDue\": 250,\n \"notes\": \"Office supplies for Q1\",\n \"purchaseOrderNumber\": null,\n \"isDeleted\": false,\n \"vendor\": {\n \"id\": \"f1a2b3c4-d5e6-7890-abcd-ef1234567890\",\n \"name\": \"Office Depot\",\n \"email\": \"ap@officedepot.example\"\n },\n \"lineItems\": [\n {\n \"id\": \"a4b5c6d7-e8f9-0123-abcd-456789012345\",\n \"description\": \"Office supplies\",\n \"quantity\": 1,\n \"price\": 250,\n \"total\": 250,\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\"\n }\n ],\n \"transactions\": [],\n \"appliedVendorMemos\": [],\n \"tagUuids\": [],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "985637a0-276f-4f6c-9db1-fd78384a49f1", "name": "Bill is already approved or has no line items.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID to approve." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3b0a3d66-7fc6-4a69-884a-a31173fae260", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID to approve." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "158874ce-8c34-45fd-a433-86efaddf963a", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID to approve." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "80d81ddb-adb1-4e17-b15c-537ed7ace11f", "name": "Bill not found.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID to approve." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "88b2e188-5dee-4ca3-97c7-01ab6cc47aa5", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID to approve." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d36dd690-d590-40fe-867c-ec91d9d7cbbd", "name": "Applies one or more vendor credit memos toward an approved bill.", "request": { "name": "Applies one or more vendor credit memos toward an approved bill.", "description": { "content": "Target bill must be approved with amountDue > 0. Each memo id is a vendor_memo UUID from list bills with billType=vendor_memo. Memos must belong to the same vendor.", "type": "text/plain" }, "url": { "path": [ "partners", "bills", ":uuid", "apply-vendor-memos" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The target bill UUID." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"memosBills\": [\n {\n \"id\": \"\",\n \"amount\": \"\"\n },\n {\n \"id\": \"\",\n \"amount\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "598c2d65-4f4c-46b0-988b-2aef98e0bece", "name": "Vendor memos applied.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid", "apply-vendor-memos" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The target bill UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"memosBills\": [\n {\n \"id\": \"e3f4a5b6-c7d8-9012-efab-345678901234\",\n \"amount\": 100\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Vendor memos applied to bill\",\n \"data\": {\n \"paidbill\": {\n \"id\": \"b2c3d4e5-f6a7-8901-bcde-f23456789012\",\n \"billNumber\": \"BILL-1042\",\n \"billType\": \"bill\",\n \"date\": \"2026-01-15\",\n \"dueDate\": \"2026-02-15\",\n \"currency\": \"USD\",\n \"approvalStatus\": \"approved\",\n \"status\": \"unpaid\",\n \"total\": 250,\n \"paidAmount\": 100,\n \"amountDue\": 150,\n \"notes\": \"Office supplies for Q1\",\n \"purchaseOrderNumber\": null,\n \"isDeleted\": false,\n \"vendor\": {\n \"id\": \"f1a2b3c4-d5e6-7890-abcd-ef1234567890\",\n \"name\": \"Office Depot\",\n \"email\": \"ap@officedepot.example\"\n },\n \"lineItems\": [\n {\n \"id\": \"a4b5c6d7-e8f9-0123-abcd-456789012345\",\n \"description\": \"Office supplies\",\n \"quantity\": 1,\n \"price\": 250,\n \"total\": 250,\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\"\n }\n ],\n \"transactions\": [],\n \"appliedVendorMemos\": [\n {\n \"id\": \"e3f4a5b6-c7d8-9012-efab-345678901234\",\n \"amount\": 100\n }\n ],\n \"tagUuids\": [],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1e2c956-db63-4c7b-938b-3ced74f9f339", "name": "Bill not approved, insufficient memo balance, or vendor mismatch.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid", "apply-vendor-memos" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The target bill UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"memosBills\": [\n {\n \"id\": \"e3f4a5b6-c7d8-9012-efab-345678901234\",\n \"amount\": 100\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "470b1ecb-ba96-4e0f-b7aa-2def58107306", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid", "apply-vendor-memos" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The target bill UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"memosBills\": [\n {\n \"id\": \"e3f4a5b6-c7d8-9012-efab-345678901234\",\n \"amount\": 100\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7611f245-3d4b-44fc-beff-6644be21c16c", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid", "apply-vendor-memos" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The target bill UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"memosBills\": [\n {\n \"id\": \"e3f4a5b6-c7d8-9012-efab-345678901234\",\n \"amount\": 100\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6c1b3388-7a3b-46f6-8a07-28a60a1b006f", "name": "Bill or vendor memo not found.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid", "apply-vendor-memos" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The target bill UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"memosBills\": [\n {\n \"id\": \"e3f4a5b6-c7d8-9012-efab-345678901234\",\n \"amount\": 100\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dcf70963-6b12-4d3f-88fa-c082c2fc6e44", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid", "apply-vendor-memos" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The target bill UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"memosBills\": [\n {\n \"id\": \"e3f4a5b6-c7d8-9012-efab-345678901234\",\n \"amount\": 100\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "31afb6a1-2a7b-4d2a-aa17-e76f9479c3d5", "name": "Removes a previously applied expense transaction payment from a bill.", "request": { "name": "Removes a previously applied expense transaction payment from a bill.", "description": { "content": "Restores the bill open balance and unlinks the transaction from accounts payable. transactionId is the transaction UUID.", "type": "text/plain" }, "url": { "path": [ "partners", "bills", ":uuid", "unassign-transaction" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"transactionId\": \"\",\n \"withCaution\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "eb766373-acd2-481c-b26d-45ff1c67b3c0", "name": "Transaction unassigned from bill.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid", "unassign-transaction" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactionId\": \"b7c8d9e0-f1a2-3456-bcde-678901234567\",\n \"withCaution\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Transaction unassigned from bill\",\n \"data\": {\n \"id\": \"b2c3d4e5-f6a7-8901-bcde-f23456789012\",\n \"billNumber\": \"BILL-1042\",\n \"billType\": \"bill\",\n \"date\": \"2026-01-15\",\n \"dueDate\": \"2026-02-15\",\n \"currency\": \"USD\",\n \"approvalStatus\": \"approved\",\n \"status\": \"unpaid\",\n \"total\": 250,\n \"paidAmount\": 0,\n \"amountDue\": 250,\n \"notes\": \"Office supplies for Q1\",\n \"purchaseOrderNumber\": null,\n \"isDeleted\": false,\n \"vendor\": {\n \"id\": \"f1a2b3c4-d5e6-7890-abcd-ef1234567890\",\n \"name\": \"Office Depot\",\n \"email\": \"ap@officedepot.example\"\n },\n \"lineItems\": [\n {\n \"id\": \"a4b5c6d7-e8f9-0123-abcd-456789012345\",\n \"description\": \"Office supplies\",\n \"quantity\": 1,\n \"price\": 250,\n \"total\": 250,\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\"\n }\n ],\n \"transactions\": [],\n \"appliedVendorMemos\": [],\n \"tagUuids\": [],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfc2b726-b2be-42cd-af8f-eb37ebdfbaa0", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid", "unassign-transaction" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactionId\": \"b7c8d9e0-f1a2-3456-bcde-678901234567\",\n \"withCaution\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "567cefda-b18e-4e43-bb6f-2ecdb658ac71", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid", "unassign-transaction" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactionId\": \"b7c8d9e0-f1a2-3456-bcde-678901234567\",\n \"withCaution\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cfe9618f-3cb6-40aa-862c-3ac1f1252833", "name": "Bill or transaction not found.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid", "unassign-transaction" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactionId\": \"b7c8d9e0-f1a2-3456-bcde-678901234567\",\n \"withCaution\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ab4d4101-619d-4409-80b0-93a5eea5fbe4", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "bills", ":uuid", "unassign-transaction" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The bill UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactionId\": \"b7c8d9e0-f1a2-3456-bcde-678901234567\",\n \"withCaution\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "474e4f06-7f24-45ae-a7f6-9924560a8154", "name": "Transactions", "description": { "content": "Transactions are the individual money movements on a workspace account. Amounts are signed: negative for money out (expense) and positive for money in (income). All references (account, category, vendor, customer, tags) use UUIDs.", "type": "text/plain" }, "item": [ { "id": "93433d32-42ce-4e7a-abbf-523810455339", "name": "Returns a paginated list of transactions, newest first.", "request": { "name": "Returns a paginated list of transactions, newest first.", "description": {}, "url": { "path": [ "partners", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Page number. First page is 1." }, { "disabled": false, "key": "limit", "value": "", "description": "Records per page. Maximum 100." }, { "disabled": false, "key": "startDate", "value": "", "description": "Filter on postedDate (ISO, inclusive)." }, { "disabled": false, "key": "endDate", "value": "", "description": "Filter on postedDate (ISO, inclusive)." }, { "disabled": false, "key": "accUuid", "value": "", "description": "Filter by bank/cash account UUID (alias: accountUuid)." }, { "disabled": false, "key": "categoryAccountUuid", "value": "", "description": "Filter by category account UUID." }, { "disabled": false, "key": "vendorUuid", "value": "", "description": "Filter by vendor UUID." }, { "disabled": false, "key": "customerUuid", "value": "", "description": "Filter by customer UUID." }, { "disabled": false, "key": "projectUuid", "value": "", "description": "Filter by project UUID." }, { "disabled": false, "key": "tagUuids", "value": "", "description": "Comma-separated tag UUIDs or array of UUIDs." }, { "disabled": false, "key": "transactionTypes", "value": "", "description": "Filter by type." }, { "disabled": false, "key": "type", "value": "", "description": "Alias for transactionTypes — use one or the other." }, { "disabled": false, "key": "reviewed", "value": "", "description": "Filter by review state (true/false or \"true\"/\"false\")." }, { "disabled": false, "key": "reconciled", "value": "", "description": "Filter by reconciliation state." }, { "disabled": false, "key": "pending", "value": "", "description": "Filter by pending state." }, { "disabled": false, "key": "excluded", "value": "", "description": "Filter by excluded state." }, { "disabled": false, "key": "currency", "value": "", "description": "ISO 4217 currency code — match the target bill or invoice currency." }, { "disabled": false, "key": "forAttachment", "value": "", "description": "Bill/invoice picker search mode. Excludes original_amount from amount search." }, { "disabled": false, "key": "status", "value": "", "description": "Repeatable status filter tokens." }, { "disabled": false, "key": "transactionLevel", "value": "", "description": "Split row mode." }, { "disabled": false, "key": "search", "value": "", "description": "Free-text search across description and notes." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "0ea0a7cb-a09f-4fa3-b851-501ef9b1148c", "name": "Paginated list of transactions.", "originalRequest": { "url": { "path": [ "partners", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "50" }, { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "accUuid", "value": "" }, { "key": "categoryAccountUuid", "value": "" }, { "key": "vendorUuid", "value": "" }, { "key": "customerUuid", "value": "" }, { "key": "projectUuid", "value": "" }, { "key": "tagUuids", "value": "" }, { "key": "transactionTypes", "value": "" }, { "key": "type", "value": "" }, { "key": "reviewed", "value": "" }, { "key": "reconciled", "value": "" }, { "key": "pending", "value": "" }, { "key": "excluded", "value": "" }, { "key": "currency", "value": "" }, { "key": "forAttachment", "value": "" }, { "key": "status", "value": "" }, { "key": "transactionLevel", "value": "" }, { "key": "search", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on fetching transactions.\",\n \"results\": 1,\n \"totalRecords\": 1,\n \"page\": 1,\n \"limit\": 50,\n \"data\": {\n \"transactions\": [\n {\n \"id\": \"b7c8d9e0-f1a2-3456-bcde-678901234567\",\n \"type\": \"EXPENSE\",\n \"description\": \"Office supplies from Amazon\",\n \"amount\": -150,\n \"currency\": \"USD\",\n \"postedDate\": \"2026-03-01\",\n \"authorizedDate\": \"2026-03-01\",\n \"notes\": \"Q1 office supplies\",\n \"paymentChannel\": \"online\",\n \"reviewed\": false,\n \"excluded\": false,\n \"pending\": false,\n \"split\": false,\n \"accountId\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"categoryAccountId\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"vendorId\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"customerId\": null,\n \"billId\": null,\n \"invoiceId\": null,\n \"tags\": [\n {\n \"id\": \"e5f6a7b8-c9d0-1234-efab-345678901234\",\n \"name\": \"Office\"\n }\n ],\n \"createdAt\": \"2026-03-13T08:30:00.000Z\",\n \"updatedAt\": \"2026-03-13T08:30:00.000Z\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6c2085e-429b-4f72-aa6b-ac9ed7a00b8d", "name": "Unauthorized — authentication failed.", "originalRequest": { "url": { "path": [ "partners", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "50" }, { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "accUuid", "value": "" }, { "key": "categoryAccountUuid", "value": "" }, { "key": "vendorUuid", "value": "" }, { "key": "customerUuid", "value": "" }, { "key": "projectUuid", "value": "" }, { "key": "tagUuids", "value": "" }, { "key": "transactionTypes", "value": "" }, { "key": "type", "value": "" }, { "key": "reviewed", "value": "" }, { "key": "reconciled", "value": "" }, { "key": "pending", "value": "" }, { "key": "excluded", "value": "" }, { "key": "currency", "value": "" }, { "key": "forAttachment", "value": "" }, { "key": "status", "value": "" }, { "key": "transactionLevel", "value": "" }, { "key": "search", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3762c222-d71a-44c7-9dd6-e07adaed67d7", "name": "Records a new transaction on an account.", "request": { "name": "Records a new transaction on an account.", "description": {}, "url": { "path": [ "partners", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"accUuid\": \"\",\n \"amount\": \"\",\n \"postedDate\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"categoryAccountUuid\": \"\",\n \"vendorUuid\": \"\",\n \"customerUuid\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f2c3fb20-25a5-46ad-8bd2-b63841c44526", "name": "Transaction created successfully.", "originalRequest": { "url": { "path": [ "partners", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accUuid\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\",\n \"description\": \"Office supplies from Amazon\",\n \"amount\": 150,\n \"type\": \"Expense\",\n \"postedDate\": \"2026-03-13\",\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"vendorUuid\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"notes\": \"Q1 office supplies\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"transaction\": {\n \"id\": \"b7c8d9e0-f1a2-3456-bcde-678901234567\",\n \"type\": \"EXPENSE\",\n \"description\": \"Office supplies from Amazon\",\n \"amount\": -150,\n \"currency\": \"USD\",\n \"postedDate\": \"2026-03-01\",\n \"authorizedDate\": \"2026-03-01\",\n \"notes\": \"Q1 office supplies\",\n \"paymentChannel\": \"online\",\n \"reviewed\": false,\n \"excluded\": false,\n \"pending\": false,\n \"split\": false,\n \"accountId\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"categoryAccountId\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"vendorId\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"customerId\": null,\n \"billId\": null,\n \"invoiceId\": null,\n \"tags\": [\n {\n \"id\": \"e5f6a7b8-c9d0-1234-efab-345678901234\",\n \"name\": \"Office\"\n }\n ],\n \"createdAt\": \"2026-03-13T08:30:00.000Z\",\n \"updatedAt\": \"2026-03-13T08:30:00.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4443b458-f6a0-4c72-aafc-fe1fc286240e", "name": "Bad request — validation failed.", "originalRequest": { "url": { "path": [ "partners", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accUuid\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\",\n \"description\": \"Office supplies from Amazon\",\n \"amount\": 150,\n \"type\": \"Expense\",\n \"postedDate\": \"2026-03-13\",\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"vendorUuid\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"notes\": \"Q1 office supplies\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e999c126-d3b7-445b-8d21-9b4eb6d25847", "name": "Referenced account, category, or vendor not found.", "originalRequest": { "url": { "path": [ "partners", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accUuid\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\",\n \"description\": \"Office supplies from Amazon\",\n \"amount\": 150,\n \"type\": \"Expense\",\n \"postedDate\": \"2026-03-13\",\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"vendorUuid\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"notes\": \"Q1 office supplies\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f32cba1d-dec7-4e06-bc39-765a419f4388", "name": "Retrieves a single transaction by its UUID.", "request": { "name": "Retrieves a single transaction by its UUID.", "description": {}, "url": { "path": [ "partners", "transactions", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the transaction." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "4ef779ef-b0d4-48c9-a7cb-8d459f6c14bb", "name": "The requested transaction.", "originalRequest": { "url": { "path": [ "partners", "transactions", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the transaction." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"transaction\": {\n \"id\": \"b7c8d9e0-f1a2-3456-bcde-678901234567\",\n \"type\": \"EXPENSE\",\n \"description\": \"Office supplies from Amazon\",\n \"amount\": -150,\n \"currency\": \"USD\",\n \"postedDate\": \"2026-03-01\",\n \"authorizedDate\": \"2026-03-01\",\n \"notes\": \"Q1 office supplies\",\n \"paymentChannel\": \"online\",\n \"reviewed\": false,\n \"excluded\": false,\n \"pending\": false,\n \"split\": false,\n \"accountId\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"categoryAccountId\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"vendorId\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"customerId\": null,\n \"billId\": null,\n \"invoiceId\": null,\n \"tags\": [\n {\n \"id\": \"e5f6a7b8-c9d0-1234-efab-345678901234\",\n \"name\": \"Office\"\n }\n ],\n \"createdAt\": \"2026-03-13T08:30:00.000Z\",\n \"updatedAt\": \"2026-03-13T08:30:00.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b91e326-ace1-4214-9e60-9d387e922c64", "name": "Transaction not found.", "originalRequest": { "url": { "path": [ "partners", "transactions", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the transaction." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9cd48cea-d8a6-46d2-901c-eac5894a7dfb", "name": "Updates fields on an existing transaction.", "request": { "name": "Updates fields on an existing transaction.", "description": {}, "url": { "path": [ "partners", "transactions", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the transaction." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"notes\": \"\",\n \"reviewed\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9c134ae4-81e7-4843-a331-a8e1b4374d04", "name": "Transaction updated.", "originalRequest": { "url": { "path": [ "partners", "transactions", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the transaction." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"reviewed\": true,\n \"notes\": \"Reconciled against statement\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"transaction\": {\n \"id\": \"b7c8d9e0-f1a2-3456-bcde-678901234567\",\n \"type\": \"EXPENSE\",\n \"description\": \"Office supplies from Amazon\",\n \"amount\": -150,\n \"currency\": \"USD\",\n \"postedDate\": \"2026-03-01\",\n \"authorizedDate\": \"2026-03-01\",\n \"notes\": \"Q1 office supplies\",\n \"paymentChannel\": \"online\",\n \"reviewed\": true,\n \"excluded\": false,\n \"pending\": false,\n \"split\": false,\n \"accountId\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"categoryAccountId\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"vendorId\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"customerId\": null,\n \"billId\": null,\n \"invoiceId\": null,\n \"tags\": [\n {\n \"id\": \"e5f6a7b8-c9d0-1234-efab-345678901234\",\n \"name\": \"Office\"\n }\n ],\n \"createdAt\": \"2026-03-13T08:30:00.000Z\",\n \"updatedAt\": \"2026-03-13T08:30:00.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "773aa44c-270c-45f3-a208-12488a1a86ce", "name": "Transaction not found.", "originalRequest": { "url": { "path": [ "partners", "transactions", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the transaction." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"reviewed\": true,\n \"notes\": \"Reconciled against statement\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1ca9f955-2ca8-4780-af64-82152b68df28", "name": "Deletes a transaction from the workspace.", "request": { "name": "Deletes a transaction from the workspace.", "description": {}, "url": { "path": [ "partners", "transactions", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the transaction." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "af00636b-5cf5-4e95-830b-7bdac26793c1", "name": "Transaction deleted.", "originalRequest": { "url": { "path": [ "partners", "transactions", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the transaction." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Transaction deleted.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8b4e9e1-16be-45e5-ab77-202c0bd35179", "name": "Transaction not found.", "originalRequest": { "url": { "path": [ "partners", "transactions", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the transaction." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bc4a54b2-62d6-48cd-9afe-09cf61a75030", "name": "Creates many transactions in a single request.", "request": { "name": "Creates many transactions in a single request.", "description": {}, "url": { "path": [ "partners", "transactions", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"transactions\": []\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5d6d5d4d-a4f6-49c0-aabf-4cc6aa5c0437", "name": "Transactions created.", "originalRequest": { "url": { "path": [ "partners", "transactions", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactions\": [\n {\n \"type\": \"EXPENSE\",\n \"description\": \"Domain renewal\",\n \"amount\": -24,\n \"postedDate\": \"2026-03-10\",\n \"accountId\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\"\n },\n {\n \"type\": \"INCOME\",\n \"description\": \"Consulting payment\",\n \"amount\": 1500,\n \"postedDate\": \"2026-03-12\",\n \"accountId\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"created\": 2\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae0301a8-7570-4fb1-9918-b073cbe31a8e", "name": "Bad request — one or more transactions failed validation.", "originalRequest": { "url": { "path": [ "partners", "transactions", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactions\": [\n {\n \"type\": \"EXPENSE\",\n \"description\": \"Domain renewal\",\n \"amount\": -24,\n \"postedDate\": \"2026-03-10\",\n \"accountId\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\"\n },\n {\n \"type\": \"INCOME\",\n \"description\": \"Consulting payment\",\n \"amount\": 1500,\n \"postedDate\": \"2026-03-12\",\n \"accountId\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fc13b01e-7892-4552-a8d8-781d7331ef51", "name": "Re-categorizes a transaction to a different chart-of-accounts category.", "request": { "name": "Re-categorizes a transaction to a different chart-of-accounts category.", "description": {}, "url": { "path": [ "partners", "transactions", ":uuid", "change-category" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the transaction." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"categoryAccountId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "17b7c437-b9b4-4dfd-bf2a-be60d1bb6958", "name": "Category updated.", "originalRequest": { "url": { "path": [ "partners", "transactions", ":uuid", "change-category" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the transaction." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"categoryAccountId\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"transaction\": {\n \"id\": \"b7c8d9e0-f1a2-3456-bcde-678901234567\",\n \"type\": \"EXPENSE\",\n \"description\": \"Office supplies from Amazon\",\n \"amount\": -150,\n \"currency\": \"USD\",\n \"postedDate\": \"2026-03-01\",\n \"authorizedDate\": \"2026-03-01\",\n \"notes\": \"Q1 office supplies\",\n \"paymentChannel\": \"online\",\n \"reviewed\": false,\n \"excluded\": false,\n \"pending\": false,\n \"split\": false,\n \"accountId\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"categoryAccountId\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"vendorId\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"customerId\": null,\n \"billId\": null,\n \"invoiceId\": null,\n \"tags\": [\n {\n \"id\": \"e5f6a7b8-c9d0-1234-efab-345678901234\",\n \"name\": \"Office\"\n }\n ],\n \"createdAt\": \"2026-03-13T08:30:00.000Z\",\n \"updatedAt\": \"2026-03-13T08:30:00.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4f4f6a2-d014-4641-98ee-5a81098f5587", "name": "Transaction or category not found.", "originalRequest": { "url": { "path": [ "partners", "transactions", ":uuid", "change-category" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the transaction." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"categoryAccountId\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "05df7972-c6ba-40bb-9b75-a5e41b9d3602", "name": "Categorizes or uncategorizes up to 100 existing transactions in one call.", "request": { "name": "Categorizes or uncategorizes up to 100 existing transactions in one call.", "description": { "content": "Per-row partial success: unresolvable UUIDs or ineligible rows (reviewed, reconciled, pending, attached to bill/invoice/transfer/deposit) appear in `failures` instead of failing the whole batch. Prefer `categoryAccountUuid` (or null to uncategorize). Liabilities physical accounts may create linked transfers; bank/cash Assets physical accounts still return 400 in bulk.", "type": "text/plain" }, "url": { "path": [ "partners", "transactions", "change-category-bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"transactionUuids\": [],\n \"categoryAccountUuid\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "06524669-9638-4506-9528-7ac2b789236c", "name": "Bulk category change processed.", "originalRequest": { "url": { "path": [ "partners", "transactions", "change-category-bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"transactionUuids\": [\n \"b7c8d9e0-f1a2-3456-bcde-678901234567\",\n \"b7c8d9e0-f1a2-3456-bcde-678901234568\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Bulk category change processed.\",\n \"data\": {\n \"successCount\": 1,\n \"failedCount\": 0,\n \"failures\": [],\n \"updatedTransactions\": [\n {\n \"id\": \"b7c8d9e0-f1a2-3456-bcde-678901234567\",\n \"type\": \"EXPENSE\",\n \"description\": \"Office supplies from Amazon\",\n \"amount\": -150,\n \"currency\": \"USD\",\n \"postedDate\": \"2026-03-01\",\n \"authorizedDate\": \"2026-03-01\",\n \"notes\": \"Q1 office supplies\",\n \"paymentChannel\": \"online\",\n \"reviewed\": false,\n \"excluded\": false,\n \"pending\": false,\n \"split\": false,\n \"accountId\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"categoryAccountId\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"vendorId\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"customerId\": null,\n \"billId\": null,\n \"invoiceId\": null,\n \"tags\": [\n {\n \"id\": \"e5f6a7b8-c9d0-1234-efab-345678901234\",\n \"name\": \"Office\"\n }\n ],\n \"createdAt\": \"2026-03-13T08:30:00.000Z\",\n \"updatedAt\": \"2026-03-13T08:30:00.000Z\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a77f91e9-ebda-42a7-9448-b29ddde8ae38", "name": "Empty or oversized transactionUuids array.", "originalRequest": { "url": { "path": [ "partners", "transactions", "change-category-bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"transactionUuids\": [\n \"b7c8d9e0-f1a2-3456-bcde-678901234567\",\n \"b7c8d9e0-f1a2-3456-bcde-678901234568\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "849f4478-2053-4e48-9d0f-9eb15e77f77f", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "transactions", "change-category-bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"transactionUuids\": [\n \"b7c8d9e0-f1a2-3456-bcde-678901234567\",\n \"b7c8d9e0-f1a2-3456-bcde-678901234568\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "99dc76bd-db6d-4a59-9463-4ff45cceb063", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "transactions", "change-category-bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"transactionUuids\": [\n \"b7c8d9e0-f1a2-3456-bcde-678901234567\",\n \"b7c8d9e0-f1a2-3456-bcde-678901234568\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b7aeffa5-295e-41b9-b1e8-9403e214846c", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "transactions", "change-category-bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"transactionUuids\": [\n \"b7c8d9e0-f1a2-3456-bcde-678901234567\",\n \"b7c8d9e0-f1a2-3456-bcde-678901234568\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d37489db-8f10-4a45-8244-da9d172bd927", "name": "Excludes or un-excludes transactions by UUID list or postedDate range.", "request": { "name": "Excludes or un-excludes transactions by UUID list or postedDate range.", "description": { "content": "Pass either `{ transactionUuids, excluded }` or `{ startDate, endDate, excluded }` — not both. Date-range mode rejects with 400 if more than 100 transactions match. Excluding hides a row from the ledger without deleting it. Same per-row eligibility guards as single-row exclude (unreviewed, unreconciled, not pending, not attached).", "type": "text/plain" }, "url": { "path": [ "partners", "transactions", "exclude-bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"excluded\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "59b57375-c1a2-487d-bf41-86e563ff8932", "name": "Bulk exclude processed with per-row failures for skipped rows.", "originalRequest": { "url": { "path": [ "partners", "transactions", "exclude-bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"excluded\": true,\n \"transactionUuids\": [\n \"b7c8d9e0-f1a2-3456-bcde-678901234567\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"successCount\": 1,\n \"failedCount\": 0,\n \"failures\": []\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ba1bdf9-1318-4730-a421-95e018c5fcfb", "name": "Invalid body — both modes, neither mode, bad dates, or more than 100 matches.", "originalRequest": { "url": { "path": [ "partners", "transactions", "exclude-bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"excluded\": true,\n \"transactionUuids\": [\n \"b7c8d9e0-f1a2-3456-bcde-678901234567\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2d698cdd-e1bf-44fd-841c-1688cf74fe82", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "transactions", "exclude-bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"excluded\": true,\n \"transactionUuids\": [\n \"b7c8d9e0-f1a2-3456-bcde-678901234567\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "361eddb7-5ca1-44b2-823b-bd1822de6412", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "transactions", "exclude-bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"excluded\": true,\n \"transactionUuids\": [\n \"b7c8d9e0-f1a2-3456-bcde-678901234567\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e17c246f-342b-4d58-8ca5-a62c392dcc05", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "transactions", "exclude-bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"excluded\": true,\n \"transactionUuids\": [\n \"b7c8d9e0-f1a2-3456-bcde-678901234567\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "73c128cf-4a0e-466c-9c4a-658e57d5247a", "name": "Applies a transaction as payment against one or more bills or invoices.", "request": { "name": "Applies a transaction as payment against one or more bills or invoices.", "description": {}, "url": { "path": [ "partners", "transactions", ":uuid", "assign-to-bills-invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the transaction (the payment)." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"matchingType\": \"\",\n \"records\": [\n {\n \"id\": \"\",\n \"paymentAmount\": \"\"\n },\n {\n \"id\": \"\",\n \"paymentAmount\": \"\"\n }\n ],\n \"withCaution\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f5c3ec14-8f12-49d8-908d-0d3ca4e03929", "name": "Transaction assigned.", "originalRequest": { "url": { "path": [ "partners", "transactions", ":uuid", "assign-to-bills-invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the transaction (the payment)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"matchingType\": \"invoice\",\n \"records\": [\n {\n \"id\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"paymentAmount\": 150\n }\n ],\n \"withCaution\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Transaction assigned.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "914d70ce-0b35-4bc4-96fa-99eeb5a0386a", "name": "Bad request — assignment amount exceeds the transaction or target balance.", "originalRequest": { "url": { "path": [ "partners", "transactions", ":uuid", "assign-to-bills-invoices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the transaction (the payment)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"matchingType\": \"invoice\",\n \"records\": [\n {\n \"id\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"paymentAmount\": 150\n }\n ],\n \"withCaution\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a5a1a8c3-3a31-45ce-b6e4-3bff03da8df0", "name": "Splits a transaction into a parent row and child rows before bill or invoice assignment.", "request": { "name": "Splits a transaction into a parent row and child rows before bill or invoice assignment.", "description": {}, "url": { "path": [ "partners", "transactions", ":uuid", "split" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the transaction to split." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"forAttachment\": \"\",\n \"splitASplit\": \"\",\n \"withCaution\": \"\",\n \"parent\": {\n \"categoryAccountUuid\": \"\",\n \"amount\": \"\",\n \"assignThis\": \"\"\n },\n \"splits\": [\n {\n \"categoryAccountUuid\": \"\",\n \"amount\": \"\"\n },\n {\n \"categoryAccountUuid\": \"\",\n \"amount\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "96f7ce38-917d-42f4-a4c9-068fb934c8fd", "name": "Transaction split. Returns parent and transactionToAssign rows with UUID ids.", "originalRequest": { "url": { "path": [ "partners", "transactions", ":uuid", "split" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the transaction to split." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"forAttachment\": true,\n \"parent\": {\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"amount\": -100,\n \"assignThis\": true\n },\n \"splits\": [\n {\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"amount\": -50\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"parent\": {\n \"id\": \"b7c8d9e0-f1a2-3456-bcde-678901234567\",\n \"type\": \"EXPENSE\",\n \"description\": \"Office supplies from Amazon\",\n \"amount\": -150,\n \"currency\": \"USD\",\n \"postedDate\": \"2026-03-01\",\n \"authorizedDate\": \"2026-03-01\",\n \"notes\": \"Q1 office supplies\",\n \"paymentChannel\": \"online\",\n \"reviewed\": false,\n \"excluded\": false,\n \"pending\": false,\n \"split\": false,\n \"accountId\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"categoryAccountId\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"vendorId\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"customerId\": null,\n \"billId\": null,\n \"invoiceId\": null,\n \"tags\": [\n {\n \"id\": \"e5f6a7b8-c9d0-1234-efab-345678901234\",\n \"name\": \"Office\"\n }\n ],\n \"createdAt\": \"2026-03-13T08:30:00.000Z\",\n \"updatedAt\": \"2026-03-13T08:30:00.000Z\"\n },\n \"transactionToAssign\": {\n \"id\": \"b7c8d9e0-f1a2-3456-bcde-678901234567\",\n \"type\": \"EXPENSE\",\n \"description\": \"Office supplies from Amazon\",\n \"amount\": -150,\n \"currency\": \"USD\",\n \"postedDate\": \"2026-03-01\",\n \"authorizedDate\": \"2026-03-01\",\n \"notes\": \"Q1 office supplies\",\n \"paymentChannel\": \"online\",\n \"reviewed\": false,\n \"excluded\": false,\n \"pending\": false,\n \"split\": false,\n \"accountId\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"categoryAccountId\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"vendorId\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"customerId\": null,\n \"billId\": null,\n \"invoiceId\": null,\n \"tags\": [\n {\n \"id\": \"e5f6a7b8-c9d0-1234-efab-345678901234\",\n \"name\": \"Office\"\n }\n ],\n \"createdAt\": \"2026-03-13T08:30:00.000Z\",\n \"updatedAt\": \"2026-03-13T08:30:00.000Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6782fcd4-17a8-481c-8407-58f02a2f3fc3", "name": "Bad request — transfer/deposit splits, reviewed/pending guards, or invalid amounts.", "originalRequest": { "url": { "path": [ "partners", "transactions", ":uuid", "split" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the transaction to split." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"forAttachment\": true,\n \"parent\": {\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"amount\": -100,\n \"assignThis\": true\n },\n \"splits\": [\n {\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"amount\": -50\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "03368dd8-d754-4da5-97be-ae5d3a8a651d", "name": "Transaction or category account not found.", "originalRequest": { "url": { "path": [ "partners", "transactions", ":uuid", "split" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The UUID of the transaction to split." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"forAttachment\": true,\n \"parent\": {\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"amount\": -100,\n \"assignThis\": true\n },\n \"splits\": [\n {\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"amount\": -50\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a6a03442-fb77-4c51-82ec-d0bec5707b18", "name": "Chart of Accounts", "description": { "content": "The chart of accounts is the workspace general ledger. Every transaction, bill, invoice line, and journal entry line posts to an account. Accounts are organized by high-level type (Assets, Liabilities, Equity, Income, Expenses) and a numeric sub-type.", "type": "text/plain" }, "item": [ { "id": "dce5ed32-5c52-4240-ad12-b994f4ae3441", "name": "Returns the workspace chart of accounts with optional filters.", "request": { "name": "Returns the workspace chart of accounts with optional filters.", "description": { "content": "Accounts are returned with nested `subType` and `institution` shapes. Use boolean-string query flags such as `includeBalances` or `includeHiddenAccounts` to control optional fields.", "type": "text/plain" }, "url": { "path": [ "partners", "chart-of-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "type", "value": "", "description": "Filter by high-level account type. Case-sensitive plural values only." }, { "disabled": false, "key": "subTypeId", "value": "", "description": "Filter by numeric AccountSubType id." }, { "disabled": false, "key": "search", "value": "", "description": "Partial match against account name or account number." }, { "disabled": false, "key": "inactive", "value": "", "description": "When `\"true\"`, include inactive accounts." }, { "disabled": false, "key": "includeBalances", "value": "", "description": "When `\"true\"`, include `systemBalance` on each account and sub-account, plus `providerBalances` and `reconcileBalances` on top-level rows only." }, { "disabled": false, "key": "includeHidden", "value": "", "description": "When `\"true\"`, include hidden accounts." }, { "disabled": false, "key": "includeHiddenAccounts", "value": "", "description": "Alias for including hidden accounts." }, { "disabled": false, "key": "onlyCategoryAccounts", "value": "", "description": "When `\"true\"`, restrict to category-style accounts used for coding transactions." }, { "disabled": false, "key": "includeDeleteMeta", "value": "", "description": "When `\"true\"`, include `canDelete` and `deleteBlockedReason` on each row so integrations can tell whether delete will succeed." }, { "disabled": false, "key": "page", "value": "", "description": "Page number for pagination. The first page is 1." }, { "disabled": false, "key": "limit", "value": "", "description": "Records to return per page." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "5b50c4da-2fb2-4262-9dc4-572a30734fa2", "name": "Chart of accounts rows.", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "" }, { "key": "subTypeId", "value": "1" }, { "key": "search", "value": "bank" }, { "key": "inactive", "value": "false" }, { "key": "includeBalances", "value": "true" }, { "key": "includeHidden", "value": "false" }, { "key": "includeHiddenAccounts", "value": "false" }, { "key": "onlyCategoryAccounts", "value": "true" }, { "key": "includeDeleteMeta", "value": "true" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"page\": 1,\n \"limit\": 50,\n \"totalRecords\": 1,\n \"filters\": {\n \"type\": null,\n \"subTypeId\": null,\n \"search\": null\n },\n \"accounts\": [\n {\n \"id\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"name\": \"Operating Bank Account\",\n \"accountNumber\": \"1000\",\n \"type\": \"Assets\",\n \"status\": \"active\",\n \"currency\": \"USD\",\n \"description\": \"Primary business checking account\",\n \"color\": \"#4A90D9\",\n \"subType\": {\n \"id\": 1,\n \"type\": \"Assets\",\n \"name\": \"Bank\",\n \"anchorTier\": null\n },\n \"institution\": {\n \"name\": \"Chase\",\n \"logoUrl\": null\n },\n \"subAccounts\": [],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "061c9a4c-131d-43b1-9983-604b73471c46", "name": "Invalid query parameters (for example malformed `type` or `subTypeId`).", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "" }, { "key": "subTypeId", "value": "1" }, { "key": "search", "value": "bank" }, { "key": "inactive", "value": "false" }, { "key": "includeBalances", "value": "true" }, { "key": "includeHidden", "value": "false" }, { "key": "includeHiddenAccounts", "value": "false" }, { "key": "onlyCategoryAccounts", "value": "true" }, { "key": "includeDeleteMeta", "value": "true" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b616b8da-5d3b-43c3-a622-4f8675d22294", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "" }, { "key": "subTypeId", "value": "1" }, { "key": "search", "value": "bank" }, { "key": "inactive", "value": "false" }, { "key": "includeBalances", "value": "true" }, { "key": "includeHidden", "value": "false" }, { "key": "includeHiddenAccounts", "value": "false" }, { "key": "onlyCategoryAccounts", "value": "true" }, { "key": "includeDeleteMeta", "value": "true" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "47a1dee3-042b-474a-a681-9bfa4b932244", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "" }, { "key": "subTypeId", "value": "1" }, { "key": "search", "value": "bank" }, { "key": "inactive", "value": "false" }, { "key": "includeBalances", "value": "true" }, { "key": "includeHidden", "value": "false" }, { "key": "includeHiddenAccounts", "value": "false" }, { "key": "onlyCategoryAccounts", "value": "true" }, { "key": "includeDeleteMeta", "value": "true" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1473d8ea-cb99-4c95-afbf-0e4581cef6f9", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "" }, { "key": "subTypeId", "value": "1" }, { "key": "search", "value": "bank" }, { "key": "inactive", "value": "false" }, { "key": "includeBalances", "value": "true" }, { "key": "includeHidden", "value": "false" }, { "key": "includeHiddenAccounts", "value": "false" }, { "key": "onlyCategoryAccounts", "value": "true" }, { "key": "includeDeleteMeta", "value": "true" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5960cc8c-9ba7-4943-a2f4-79d499e48bfa", "name": "Creates a new chart-of-accounts entry.", "request": { "name": "Creates a new chart-of-accounts entry.", "description": { "content": "Requires `name` and `subTypeId`. The high-level `type` is derived server-side from `subTypeId` — do not send `type`. For New Zealand workspaces, `taxes` (numeric tax ids) may be required.", "type": "text/plain" }, "url": { "path": [ "partners", "chart-of-accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"subTypeId\": \"\",\n \"accountNumber\": \"\",\n \"currency\": \"\",\n \"description\": \"\",\n \"color\": \"\",\n \"parentAccountId\": \"\",\n \"institutionId\": \"\",\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "15ef2cb8-ff54-4cf3-803e-6a4366f26e78", "name": "Account created successfully.", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Petty Cash\",\n \"subTypeId\": 1,\n \"accountNumber\": \"1010\",\n \"currency\": \"USD\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on creating account.\",\n \"data\": {\n \"account\": {\n \"id\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"name\": \"Operating Bank Account\",\n \"accountNumber\": \"1000\",\n \"type\": \"Assets\",\n \"status\": \"active\",\n \"currency\": \"USD\",\n \"description\": \"Primary business checking account\",\n \"color\": \"#4A90D9\",\n \"subType\": {\n \"id\": 1,\n \"type\": \"Assets\",\n \"name\": \"Bank\",\n \"anchorTier\": null\n },\n \"institution\": {\n \"name\": \"Chase\",\n \"logoUrl\": null\n },\n \"subAccounts\": [],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2a656cd-1eae-443e-8e51-26503ac9ae3c", "name": "Validation failed — missing name/subTypeId or invalid sub-type.", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Petty Cash\",\n \"subTypeId\": 1,\n \"accountNumber\": \"1010\",\n \"currency\": \"USD\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e7fac8df-d224-4b07-b8ba-8122bf846c1e", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Petty Cash\",\n \"subTypeId\": 1,\n \"accountNumber\": \"1010\",\n \"currency\": \"USD\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3fdec706-8591-4780-99d7-28da56bb4976", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Petty Cash\",\n \"subTypeId\": 1,\n \"accountNumber\": \"1010\",\n \"currency\": \"USD\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5e8219fc-2726-46bb-be48-d54292e329a0", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Petty Cash\",\n \"subTypeId\": 1,\n \"accountNumber\": \"1010\",\n \"currency\": \"USD\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5068b404-6b4f-490e-81e4-4109c6ca9bf6", "name": "Returns the catalog of account sub-types for the workspace country.", "request": { "name": "Returns the catalog of account sub-types for the workspace country.", "description": { "content": "Sub-type ids are global integers (not UUIDs). Pass the chosen `id` as `subTypeId` when creating a chart-of-accounts entry. Optional `type` filter accepts Assets, Liabilities, Equity, Income, or Expenses.", "type": "text/plain" }, "url": { "path": [ "partners", "account-sub-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "type", "value": "", "description": "Filter by high-level account type. Case-sensitive plural values only." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "879b2e7a-9b89-4b2e-8b83-767c1491d898", "name": "Array of account sub-type rows.", "originalRequest": { "url": { "path": [ "partners", "account-sub-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 1,\n \"type\": \"Assets\",\n \"name\": \"Bank\",\n \"anchorTier\": null,\n \"description\": \"Cash and bank accounts\"\n },\n {\n \"id\": 2,\n \"type\": \"Assets\",\n \"name\": \"Accounts Receivable\",\n \"anchorTier\": null,\n \"description\": \"Amounts owed by customers\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7efaf2b1-373f-4bee-beb1-00cf43a22b04", "name": "Invalid `type` query parameter.", "originalRequest": { "url": { "path": [ "partners", "account-sub-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c4bfb4ed-4433-43a1-9822-e77675ece0e4", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "account-sub-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "092fb104-3047-49b5-9fb3-bf5ec0b8b66d", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "account-sub-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "491a4b17-04d2-4409-8185-789aa6566c7d", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "account-sub-types" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "629edf07-93b4-4d5c-ae1f-5d3d8498b5c7", "name": "Updates an existing account. Only the fields you send are changed.", "request": { "name": "Updates an existing account. Only the fields you send are changed.", "description": { "content": "Editable fields include name, accountNumber, description, color, status, subTypeId (same high-level type only), and parentAccountId. Pass `isChildAccount: false` to detach from a parent. An empty body returns 400. Partner-created accounts remain editable until system-mapped or used in postings; system accounts may reject protected fields with 403.", "type": "text/plain" }, "url": { "path": [ "partners", "chart-of-accounts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The account UUID to update." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"accountNumber\": \"\",\n \"description\": \"\",\n \"color\": \"\",\n \"status\": \"\",\n \"subTypeId\": \"\",\n \"parentAccountId\": \"\",\n \"isChildAccount\": \"\",\n \"connectionSyncEnabled\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "473fac8b-54f2-4bcc-b3d7-80c4328cab29", "name": "Account updated successfully.", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The account UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Operating Bank Account — Primary\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on updating account.\",\n \"data\": {\n \"account\": {\n \"id\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"name\": \"Operating Bank Account\",\n \"accountNumber\": \"1000\",\n \"type\": \"Assets\",\n \"status\": \"active\",\n \"currency\": \"USD\",\n \"description\": \"Primary business checking account\",\n \"color\": \"#4A90D9\",\n \"subType\": {\n \"id\": 1,\n \"type\": \"Assets\",\n \"name\": \"Bank\",\n \"anchorTier\": null\n },\n \"institution\": {\n \"name\": \"Chase\",\n \"logoUrl\": null\n },\n \"subAccounts\": [],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b26a51da-b19f-4b38-8fe7-4e7871703ef9", "name": "Empty body or invalid field combination.", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The account UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Operating Bank Account — Primary\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9eda13f2-8750-4372-96a9-5ccd272d668b", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The account UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Operating Bank Account — Primary\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c0183d6a-69ad-4625-a063-a98a58c920aa", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The account UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Operating Bank Account — Primary\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6c5e3b2d-04ef-43aa-98c6-74fc3270f197", "name": "Account not found.", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The account UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Operating Bank Account — Primary\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "52bd83fc-87b3-484d-8ef5-af28056827fa", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The account UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Operating Bank Account — Primary\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e2e89b49-c08e-48d1-a709-0e165f92e2e7", "name": "Deletes a chart-of-accounts entry by UUID.", "request": { "name": "Deletes a chart-of-accounts entry by UUID.", "description": { "content": "Partner-created accounts are deletable until they have journal entries, sub-accounts, invoice products, or payroll mappings. If delete fails because of posted activity, deactivate the account with PATCH instead. Use GET with `includeDeleteMeta=true` to read `canDelete` and `deleteBlockedReason` before calling delete.", "type": "text/plain" }, "url": { "path": [ "partners", "chart-of-accounts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The account UUID to delete." } ] }, "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "4e37acff-b2dd-444a-937d-2a190b91cb2b", "name": "Account deleted successfully.", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The account UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3727443b-cec8-44bc-8403-05de44cf9e01", "name": "Account cannot be deleted due to linked activity.", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The account UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bef81bfe-15c9-4055-96bb-c2174aa1e1ba", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The account UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c3f8a779-449b-4e46-a4df-08f55cc5245e", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The account UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a0f8fb0d-0207-4aaa-9256-a98175c1c784", "name": "Account not found.", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The account UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9181dd00-f304-40ed-b531-7c34a792fde8", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The account UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "24565792-f1fc-48f3-b994-409c21c8e2af", "name": "Creates up to 100 chart-of-accounts entries in one request with partial-success semantics.", "request": { "name": "Creates up to 100 chart-of-accounts entries in one request with partial-success semantics.", "description": { "content": "Each row uses the same shape as Create account. Rows are processed independently — one failure does not roll back others. Returns the bulk batch shape documented in Response shapes (HTTP 201). Recommended batch size ~25 for migrations. Complete the chart of accounts before importing bills or transactions.", "type": "text/plain" }, "url": { "path": [ "partners", "chart-of-accounts", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"accounts\": []\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8551a8c8-78f6-4a6b-857e-e8e8259d67dc", "name": "Batch accepted. Check successCount and per-row results.", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"name\": \"Office Supplies\",\n \"subTypeId\": 42,\n \"accountNumber\": \"6100\"\n },\n {\n \"name\": \"Software Subscriptions\",\n \"subTypeId\": 42,\n \"accountNumber\": \"6200\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"successCount\": 2,\n \"errorCount\": 0,\n \"results\": [\n {\n \"index\": 0,\n \"success\": true,\n \"account\": {\n \"id\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"name\": \"Operating Bank Account\",\n \"accountNumber\": \"1000\",\n \"type\": \"Assets\",\n \"status\": \"active\",\n \"currency\": \"USD\",\n \"description\": \"Primary business checking account\",\n \"color\": \"#4A90D9\",\n \"subType\": {\n \"id\": 1,\n \"type\": \"Assets\",\n \"name\": \"Bank\",\n \"anchorTier\": null\n },\n \"institution\": {\n \"name\": \"Chase\",\n \"logoUrl\": null\n },\n \"subAccounts\": [],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbd220dc-4650-4810-80a2-44c6713a53e2", "name": "Batch-level validation failed (empty array, over 100 rows, etc.).", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"name\": \"Office Supplies\",\n \"subTypeId\": 42,\n \"accountNumber\": \"6100\"\n },\n {\n \"name\": \"Software Subscriptions\",\n \"subTypeId\": 42,\n \"accountNumber\": \"6200\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7c3f6210-7ae8-4da6-9b21-d8b9e7e9c139", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"name\": \"Office Supplies\",\n \"subTypeId\": 42,\n \"accountNumber\": \"6100\"\n },\n {\n \"name\": \"Software Subscriptions\",\n \"subTypeId\": 42,\n \"accountNumber\": \"6200\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "62d74961-3ba3-4ce5-968c-cfeb3ea954e0", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"name\": \"Office Supplies\",\n \"subTypeId\": 42,\n \"accountNumber\": \"6100\"\n },\n {\n \"name\": \"Software Subscriptions\",\n \"subTypeId\": 42,\n \"accountNumber\": \"6200\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8d21cef1-838e-4fb9-b11c-acd268425909", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "chart-of-accounts", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accounts\": [\n {\n \"name\": \"Office Supplies\",\n \"subTypeId\": 42,\n \"accountNumber\": \"6100\"\n },\n {\n \"name\": \"Software Subscriptions\",\n \"subTypeId\": 42,\n \"accountNumber\": \"6200\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "30e63e24-5587-41b7-97b1-f8ec457109a2", "name": "Vendors", "description": { "content": "Vendors are the suppliers, merchants, contractors, and contacts you pay through bills and expense transactions. A vendor holds contact details, an optional address, 1099 tax settings, and status.", "type": "text/plain" }, "item": [ { "id": "a05f0899-55a6-471b-a484-c131264ca9dd", "name": "Returns a paginated list of vendors in the workspace.", "request": { "name": "Returns a paginated list of vendors in the workspace.", "description": { "content": "Vendors are returned with address and contacts embedded. Results are sorted by name ascending.", "type": "text/plain" }, "url": { "path": [ "partners", "vendors" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "search", "value": "", "description": "Partial match on vendor name, account number, or contact email." }, { "disabled": false, "key": "status", "value": "", "description": "Filter by vendor status." }, { "disabled": false, "key": "page", "value": "", "description": "Page number for pagination. The first page is 1." }, { "disabled": false, "key": "limit", "value": "", "description": "Records to return per page." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "3a920979-6662-4517-a1ab-d59e3cfc5e58", "name": "Paginated list of vendors.", "originalRequest": { "url": { "path": [ "partners", "vendors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "office" }, { "key": "status", "value": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"page\": 1,\n \"limit\": 50,\n \"totalRecords\": 1,\n \"filters\": {\n \"search\": null,\n \"status\": null\n },\n \"vendors\": [\n {\n \"id\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"name\": \"Office Depot\",\n \"email\": \"ap@officedepot.com\",\n \"mainPhone\": \"+18001234567\",\n \"website\": \"https://officedepot.com\",\n \"accountNumber\": \"V-1001\",\n \"status\": \"active\",\n \"type\": \"SUPPLIER\",\n \"legalName\": \"Office Depot Inc.\",\n \"businessName\": null,\n \"taxNumber\": null,\n \"taxType\": \"none\",\n \"is1099\": false,\n \"address\": {\n \"street\": \"500 Supply Chain Blvd\",\n \"city\": \"Boca Raton\",\n \"state\": \"FL\",\n \"zipCode\": \"33431\",\n \"country\": \"USA\"\n },\n \"contacts\": [\n {\n \"id\": \"a5da3577-bf85-4e3a-aa73-df85ca69bc67\",\n \"firstName\": \"Accounts\",\n \"lastName\": \"Payable\",\n \"email\": \"ap@officedepot.com\",\n \"phone\": \"+18001234567\",\n \"isPrimary\": true\n }\n ],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "daa584fd-5f2e-4a14-99a9-e31f54df7869", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "vendors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "office" }, { "key": "status", "value": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "623a2b9b-c426-4c36-8af0-c0de54a6acb1", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "vendors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "office" }, { "key": "status", "value": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d2ecb400-ca44-4b7a-b1ec-232892491ed9", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "vendors" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "office" }, { "key": "status", "value": "" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8d3121aa-0c04-4ed1-8538-8156fbe1d3b9", "name": "Creates a new vendor in the workspace.", "request": { "name": "Creates a new vendor in the workspace.", "description": { "content": "Only `name` is required. Address and contacts can be created inline.", "type": "text/plain" }, "url": { "path": [ "partners", "vendors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"\",\n \"mainPhone\": \"\",\n \"website\": \"\",\n \"accountNumber\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"legalName\": \"\",\n \"businessName\": \"\",\n \"taxNumber\": \"\",\n \"taxType\": \"\",\n \"is1099\": \"\",\n \"addToContractorGroup\": \"\",\n \"address\": {\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipCode\": \"\",\n \"country\": \"\"\n },\n \"contacts\": [\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"isPrimary\": \"\"\n },\n {\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"isPrimary\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7b9bc46a-47fc-490f-8e54-6851459e14aa", "name": "Vendor created successfully.", "originalRequest": { "url": { "path": [ "partners", "vendors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Office Depot\",\n \"email\": \"ap@officedepot.com\",\n \"type\": \"SUPPLIER\",\n \"status\": \"active\",\n \"address\": {\n \"street\": \"500 Supply Chain Blvd\",\n \"city\": \"Boca Raton\",\n \"state\": \"FL\",\n \"zipCode\": \"33431\",\n \"country\": \"USA\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on creating vendor.\",\n \"data\": {\n \"vendor\": {\n \"id\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"name\": \"Office Depot\",\n \"email\": \"ap@officedepot.com\",\n \"mainPhone\": \"+18001234567\",\n \"website\": \"https://officedepot.com\",\n \"accountNumber\": \"V-1001\",\n \"status\": \"active\",\n \"type\": \"SUPPLIER\",\n \"legalName\": \"Office Depot Inc.\",\n \"businessName\": null,\n \"taxNumber\": null,\n \"taxType\": \"none\",\n \"is1099\": false,\n \"address\": {\n \"street\": \"500 Supply Chain Blvd\",\n \"city\": \"Boca Raton\",\n \"state\": \"FL\",\n \"zipCode\": \"33431\",\n \"country\": \"USA\"\n },\n \"contacts\": [\n {\n \"id\": \"a5da3577-bf85-4e3a-aa73-df85ca69bc67\",\n \"firstName\": \"Accounts\",\n \"lastName\": \"Payable\",\n \"email\": \"ap@officedepot.com\",\n \"phone\": \"+18001234567\",\n \"isPrimary\": true\n }\n ],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7db3d300-cb42-42fc-900d-6c0d17f9a8e9", "name": "Validation failed or an active vendor with the same name already exists.", "originalRequest": { "url": { "path": [ "partners", "vendors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Office Depot\",\n \"email\": \"ap@officedepot.com\",\n \"type\": \"SUPPLIER\",\n \"status\": \"active\",\n \"address\": {\n \"street\": \"500 Supply Chain Blvd\",\n \"city\": \"Boca Raton\",\n \"state\": \"FL\",\n \"zipCode\": \"33431\",\n \"country\": \"USA\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0a983135-7cbc-4a74-9c28-0a91ff6f15b8", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "vendors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Office Depot\",\n \"email\": \"ap@officedepot.com\",\n \"type\": \"SUPPLIER\",\n \"status\": \"active\",\n \"address\": {\n \"street\": \"500 Supply Chain Blvd\",\n \"city\": \"Boca Raton\",\n \"state\": \"FL\",\n \"zipCode\": \"33431\",\n \"country\": \"USA\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ebf2274d-b673-4326-af7a-66a5f397445c", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "vendors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Office Depot\",\n \"email\": \"ap@officedepot.com\",\n \"type\": \"SUPPLIER\",\n \"status\": \"active\",\n \"address\": {\n \"street\": \"500 Supply Chain Blvd\",\n \"city\": \"Boca Raton\",\n \"state\": \"FL\",\n \"zipCode\": \"33431\",\n \"country\": \"USA\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2265b7ea-bd1a-4275-8e00-0076dc8bb37c", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "vendors" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Office Depot\",\n \"email\": \"ap@officedepot.com\",\n \"type\": \"SUPPLIER\",\n \"status\": \"active\",\n \"address\": {\n \"street\": \"500 Supply Chain Blvd\",\n \"city\": \"Boca Raton\",\n \"state\": \"FL\",\n \"zipCode\": \"33431\",\n \"country\": \"USA\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bf42b7a5-f6b9-46f1-b7d2-7a23bcd7816c", "name": "Updates an existing vendor. Only the fields you send are changed.", "request": { "name": "Updates an existing vendor. Only the fields you send are changed.", "description": {}, "url": { "path": [ "partners", "vendors", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The vendor UUID to update." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"\",\n \"mainPhone\": \"\",\n \"website\": \"\",\n \"accountNumber\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"legalName\": \"\",\n \"taxNumber\": \"\",\n \"is1099\": \"\",\n \"address\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2bc5f20e-35dc-488f-a61f-0d5c6e0767d1", "name": "Vendor updated successfully.", "originalRequest": { "url": { "path": [ "partners", "vendors", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The vendor UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"mainPhone\": \"+18009876543\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on updating vendor.\",\n \"data\": {\n \"vendor\": {\n \"id\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"name\": \"Office Depot\",\n \"email\": \"ap@officedepot.com\",\n \"mainPhone\": \"+18001234567\",\n \"website\": \"https://officedepot.com\",\n \"accountNumber\": \"V-1001\",\n \"status\": \"active\",\n \"type\": \"SUPPLIER\",\n \"legalName\": \"Office Depot Inc.\",\n \"businessName\": null,\n \"taxNumber\": null,\n \"taxType\": \"none\",\n \"is1099\": false,\n \"address\": {\n \"street\": \"500 Supply Chain Blvd\",\n \"city\": \"Boca Raton\",\n \"state\": \"FL\",\n \"zipCode\": \"33431\",\n \"country\": \"USA\"\n },\n \"contacts\": [\n {\n \"id\": \"a5da3577-bf85-4e3a-aa73-df85ca69bc67\",\n \"firstName\": \"Accounts\",\n \"lastName\": \"Payable\",\n \"email\": \"ap@officedepot.com\",\n \"phone\": \"+18001234567\",\n \"isPrimary\": true\n }\n ],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccd301da-c9a1-44aa-9d34-67c02909da31", "name": "Validation failed or restricted contractor vendor field.", "originalRequest": { "url": { "path": [ "partners", "vendors", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The vendor UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"mainPhone\": \"+18009876543\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "de92a6d2-94b4-4057-a83b-1baa0511efa1", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "vendors", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The vendor UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"mainPhone\": \"+18009876543\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "08df229b-fa03-4856-bbfb-9e7b0ae79755", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "vendors", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The vendor UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"mainPhone\": \"+18009876543\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4ebd571f-b156-4eb3-96fa-fb2eafefa058", "name": "Vendor not found.", "originalRequest": { "url": { "path": [ "partners", "vendors", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The vendor UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"mainPhone\": \"+18009876543\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "843e88bb-39a1-4078-a7de-4b0d8b5260e2", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "vendors", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The vendor UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"mainPhone\": \"+18009876543\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8405a1db-c2d5-4bbd-92f0-2f5fe575b75e", "name": "Deletes a vendor by UUID.", "request": { "name": "Deletes a vendor by UUID.", "description": { "content": "Vendors linked to bills, transactions, or other records may not be deletable.", "type": "text/plain" }, "url": { "path": [ "partners", "vendors", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The vendor UUID to delete." } ] }, "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "f954f586-dab5-4f61-ba9d-3b522af5128b", "name": "Vendor deleted successfully.", "originalRequest": { "url": { "path": [ "partners", "vendors", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The vendor UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cbd39513-8d79-4c54-9397-5be3ee31f640", "name": "Vendor is linked to records and cannot be deleted.", "originalRequest": { "url": { "path": [ "partners", "vendors", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The vendor UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b28a9726-f482-442a-a229-a43d64cada16", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "vendors", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The vendor UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b05728ac-e1b2-473c-8add-0295e3b6eeaf", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "vendors", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The vendor UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bd58df40-5591-4372-a4b4-13b5f93f3916", "name": "Vendor not found.", "originalRequest": { "url": { "path": [ "partners", "vendors", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The vendor UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "646eb53b-a434-4157-ad8a-e2dacf861614", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "vendors", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The vendor UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "0a7e0f1b-6594-4186-8e03-7fb37adbd0a0", "name": "Products & Services", "description": { "content": "Products and services are the catalog items you sell on invoices and estimates. Each record carries pricing, optional inventory tracking, income and purchase category accounts, and tax configuration.", "type": "text/plain" }, "item": [ { "id": "b5da272e-3660-40f9-9828-6e041258229f", "name": "Returns a paginated list of products and services.", "request": { "name": "Returns a paginated list of products and services.", "description": { "content": "Partner list responses embed nested category accounts and taxes. Hidden products are excluded unless `includeHidden=true`.", "type": "text/plain" }, "url": { "path": [ "partners", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Page number for pagination. The first page is 1." }, { "disabled": false, "key": "limit", "value": "", "description": "Records to return per page." }, { "disabled": false, "key": "search", "value": "", "description": "Partial match on name, code, description, or numeric price fields." }, { "disabled": false, "key": "status", "value": "", "description": "Filter by product status." }, { "disabled": false, "key": "orderBy", "value": "", "description": "Field to sort by. Defaults to name." }, { "disabled": false, "key": "orderDirection", "value": "", "description": "Sort direction. Defaults to ASC." }, { "disabled": false, "key": "requireCategory", "value": "", "description": "When `\"true\"`, return only products with an income category account assigned." }, { "disabled": false, "key": "includeHidden", "value": "", "description": "When `\"true\"`, include hidden products." }, { "disabled": false, "key": "hidden", "value": "", "description": "Filter explicitly on hidden flag (`\"true\"` or `\"false\"`)." }, { "disabled": false, "key": "isTimeEntry", "value": "", "description": "When `\"true\"`, return only time-entry tasks." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "23bab2f0-b184-4e58-a4fb-c4d69e15ad9f", "name": "Paginated list of products.", "originalRequest": { "url": { "path": [ "partners", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "consulting" }, { "key": "status", "value": "" }, { "key": "orderBy", "value": "name" }, { "key": "orderDirection", "value": "" }, { "key": "requireCategory", "value": "true" }, { "key": "includeHidden", "value": "false" }, { "key": "hidden", "value": "false" }, { "key": "isTimeEntry", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"results\": 1,\n \"message\": {\n \"products\": [\n {\n \"id\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"name\": \"Consulting — hourly\",\n \"code\": \"SVC-001\",\n \"description\": \"Consulting services\",\n \"unitPrice\": 150,\n \"purchasePrice\": null,\n \"total\": 150,\n \"tax\": 0,\n \"currency\": \"USD\",\n \"status\": \"active\",\n \"pricingMethod\": \"hour\",\n \"hidden\": false,\n \"stockQuantity\": null,\n \"timeEntryTask\": false,\n \"categoryAccount\": {\n \"id\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"name\": \"Professional Services Income\",\n \"type\": \"Income\"\n },\n \"purchaseCategoryAccount\": null,\n \"taxes\": [],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n ],\n \"totalRecords\": 1,\n \"page\": 1,\n \"limit\": 50,\n \"orderBy\": \"name\",\n \"orderDirection\": \"ASC\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b6ef141-a02b-4e29-a139-645e7122dc6f", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "consulting" }, { "key": "status", "value": "" }, { "key": "orderBy", "value": "name" }, { "key": "orderDirection", "value": "" }, { "key": "requireCategory", "value": "true" }, { "key": "includeHidden", "value": "false" }, { "key": "hidden", "value": "false" }, { "key": "isTimeEntry", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c15b5df7-6358-4e2c-bf90-83593629fc34", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "consulting" }, { "key": "status", "value": "" }, { "key": "orderBy", "value": "name" }, { "key": "orderDirection", "value": "" }, { "key": "requireCategory", "value": "true" }, { "key": "includeHidden", "value": "false" }, { "key": "hidden", "value": "false" }, { "key": "isTimeEntry", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "60094dfe-5474-4f15-b558-cfc1b68f9a0a", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "products" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "consulting" }, { "key": "status", "value": "" }, { "key": "orderBy", "value": "name" }, { "key": "orderDirection", "value": "" }, { "key": "requireCategory", "value": "true" }, { "key": "includeHidden", "value": "false" }, { "key": "hidden", "value": "false" }, { "key": "isTimeEntry", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c69520bb-a36d-4d04-852a-3e4874e55780", "name": "Creates a new product or service.", "request": { "name": "Creates a new product or service.", "description": { "content": "Use `categoryAccountUuid` and `purchaseCategoryAccountUuid` for chart-of-accounts references and `taxUuids` for taxes.", "type": "text/plain" }, "url": { "path": [ "partners", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"code\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"purchasePrice\": \"\",\n \"currency\": \"\",\n \"status\": \"\",\n \"pricingMethod\": \"\",\n \"hidden\": \"\",\n \"stockAdjustment\": \"\",\n \"timeEntryTask\": \"\",\n \"categoryAccountUuid\": \"\",\n \"purchaseCategoryAccountUuid\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4649dd60-df92-4cae-ab7b-2fd94e31d676", "name": "Product created successfully.", "originalRequest": { "url": { "path": [ "partners", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Consulting — hourly\",\n \"code\": \"SVC-001\",\n \"description\": \"Consulting services\",\n \"unitPrice\": 150,\n \"currency\": \"USD\",\n \"pricingMethod\": \"hour\",\n \"categoryAccountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on creating product\",\n \"data\": {\n \"productService\": {\n \"id\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"name\": \"Consulting — hourly\",\n \"code\": \"SVC-001\",\n \"description\": \"Consulting services\",\n \"unitPrice\": 150,\n \"purchasePrice\": null,\n \"total\": 150,\n \"tax\": 0,\n \"currency\": \"USD\",\n \"status\": \"active\",\n \"pricingMethod\": \"hour\",\n \"hidden\": false,\n \"stockQuantity\": null,\n \"timeEntryTask\": false,\n \"categoryAccount\": {\n \"id\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"name\": \"Professional Services Income\",\n \"type\": \"Income\"\n },\n \"purchaseCategoryAccount\": null,\n \"taxes\": [],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72a74893-031b-4a75-8778-d9898df21a2b", "name": "Validation failed or unknown account/tax UUID.", "originalRequest": { "url": { "path": [ "partners", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Consulting — hourly\",\n \"code\": \"SVC-001\",\n \"description\": \"Consulting services\",\n \"unitPrice\": 150,\n \"currency\": \"USD\",\n \"pricingMethod\": \"hour\",\n \"categoryAccountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f97b2a95-3e76-4ada-9528-30212b5ec3d9", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Consulting — hourly\",\n \"code\": \"SVC-001\",\n \"description\": \"Consulting services\",\n \"unitPrice\": 150,\n \"currency\": \"USD\",\n \"pricingMethod\": \"hour\",\n \"categoryAccountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "59a83274-1fc0-4aa8-9aad-ea0bc2bc2cf5", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Consulting — hourly\",\n \"code\": \"SVC-001\",\n \"description\": \"Consulting services\",\n \"unitPrice\": 150,\n \"currency\": \"USD\",\n \"pricingMethod\": \"hour\",\n \"categoryAccountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cd6ff64b-71f4-4ae5-8268-dc92132c6bbb", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "products" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Consulting — hourly\",\n \"code\": \"SVC-001\",\n \"description\": \"Consulting services\",\n \"unitPrice\": 150,\n \"currency\": \"USD\",\n \"pricingMethod\": \"hour\",\n \"categoryAccountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "93e8f0d3-3039-40de-9a03-31cc3c1e12b0", "name": "Retrieves a single product or service by UUID.", "request": { "name": "Retrieves a single product or service by UUID.", "description": {}, "url": { "path": [ "partners", "products", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The product UUID." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "9d128d4f-c2ad-4af9-b9fe-a793caacd2d0", "name": "The requested product.", "originalRequest": { "url": { "path": [ "partners", "products", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The product UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"success on gettng Consulting — hourly product\",\n \"data\": {\n \"product\": {\n \"id\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"name\": \"Consulting — hourly\",\n \"code\": \"SVC-001\",\n \"description\": \"Consulting services\",\n \"unitPrice\": 150,\n \"purchasePrice\": null,\n \"total\": 150,\n \"tax\": 0,\n \"currency\": \"USD\",\n \"status\": \"active\",\n \"pricingMethod\": \"hour\",\n \"hidden\": false,\n \"stockQuantity\": null,\n \"timeEntryTask\": false,\n \"categoryAccount\": {\n \"id\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"name\": \"Professional Services Income\",\n \"type\": \"Income\"\n },\n \"purchaseCategoryAccount\": null,\n \"taxes\": [],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2770e887-0eee-4818-afd8-daabbb956fb2", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "products", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The product UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "55707e21-4026-4bd4-8837-a70411f0d308", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "products", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The product UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4d9cdf03-1781-4281-b114-0b21cc52a98d", "name": "Product not found.", "originalRequest": { "url": { "path": [ "partners", "products", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The product UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "65fb7066-0bc4-4c33-b741-354a4d147c9b", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "products", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The product UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b235e3c7-9eac-44e3-a5a7-62664e7793c2", "name": "Updates an existing product. Only the fields you send are changed.", "request": { "name": "Updates an existing product. Only the fields you send are changed.", "description": { "content": "Use `categoryAccountUuid`, `purchaseCategoryAccountUuid`, and `taxUuids` for account and tax references (same as create). An empty body returns 400.", "type": "text/plain" }, "url": { "path": [ "partners", "products", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The product UUID to update." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"code\": \"\",\n \"description\": \"\",\n \"unitPrice\": \"\",\n \"purchasePrice\": \"\",\n \"status\": \"\",\n \"pricingMethod\": \"\",\n \"hidden\": \"\",\n \"stockAdjustment\": \"\",\n \"stockReason\": \"\",\n \"categoryAccountUuid\": \"\",\n \"purchaseCategoryAccountUuid\": \"\",\n \"notes\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "81515d03-86da-4b52-9895-acefc3f22555", "name": "Product updated successfully.", "originalRequest": { "url": { "path": [ "partners", "products", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The product UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"unitPrice\": 175,\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on updating product\",\n \"data\": {\n \"updatedProduct\": {\n \"id\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"name\": \"Consulting — hourly\",\n \"code\": \"SVC-001\",\n \"description\": \"Consulting services\",\n \"unitPrice\": 175,\n \"purchasePrice\": null,\n \"total\": 150,\n \"tax\": 0,\n \"currency\": \"USD\",\n \"status\": \"active\",\n \"pricingMethod\": \"hour\",\n \"hidden\": false,\n \"stockQuantity\": null,\n \"timeEntryTask\": false,\n \"categoryAccount\": {\n \"id\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"name\": \"Professional Services Income\",\n \"type\": \"Income\"\n },\n \"purchaseCategoryAccount\": null,\n \"taxes\": [],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e341599-28da-4fdb-878c-a6b99af340e7", "name": "Empty body or validation error.", "originalRequest": { "url": { "path": [ "partners", "products", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The product UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"unitPrice\": 175,\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "de01c636-a629-4b4e-9538-5ab211f66f0d", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "products", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The product UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"unitPrice\": 175,\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "001f6fac-2fa5-41d4-8bd4-de91dcf001e4", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "products", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The product UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"unitPrice\": 175,\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7552f40c-5baa-429e-8e92-fa800794d2de", "name": "Product not found.", "originalRequest": { "url": { "path": [ "partners", "products", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The product UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"unitPrice\": 175,\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f54972c8-9473-430c-b954-b6ab5a721b07", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "products", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The product UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"unitPrice\": 175,\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "83a24d37-071b-4191-9642-8ce6d52865da", "name": "Soft-deletes a product or service by UUID.", "request": { "name": "Soft-deletes a product or service by UUID.", "description": {}, "url": { "path": [ "partners", "products", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The product UUID to delete." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "e7b974f3-8448-4ba3-b41d-aa21b0887411", "name": "Product deleted successfully.", "originalRequest": { "url": { "path": [ "partners", "products", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The product UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on deleting Consulting — hourly product.\",\n \"data\": {\n \"deletedProduct\": {\n \"id\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"name\": \"Consulting — hourly\",\n \"code\": \"SVC-001\",\n \"description\": \"Consulting services\",\n \"unitPrice\": 150,\n \"purchasePrice\": null,\n \"total\": 150,\n \"tax\": 0,\n \"currency\": \"USD\",\n \"status\": \"active\",\n \"pricingMethod\": \"hour\",\n \"hidden\": false,\n \"stockQuantity\": null,\n \"timeEntryTask\": false,\n \"categoryAccount\": {\n \"id\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"name\": \"Professional Services Income\",\n \"type\": \"Income\"\n },\n \"purchaseCategoryAccount\": null,\n \"taxes\": [],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "121fd526-dbfa-433f-b356-ce7444d4e181", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "products", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The product UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c82ac8a1-d7c5-4bcc-81ca-40bdb8fbf599", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "products", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The product UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "71e2d0d6-d881-43a7-8c0b-517965df3d04", "name": "Product not found.", "originalRequest": { "url": { "path": [ "partners", "products", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The product UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6f3e1f5b-b9be-464a-89be-c4552577e965", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "products", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The product UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "af368528-a0bb-4c51-8765-f2c2b6eea652", "name": "Journal Entries", "description": { "content": "Journal entries are manual double-entry postings to the general ledger. Each posting has a memo, date, optional reference number, and balanced debit/credit lines that reference chart-of-accounts UUIDs.", "type": "text/plain" }, "item": [ { "id": "2b0537f8-f61d-42c9-aca4-c4b03b0513d5", "name": "Returns a paginated list of journal entry lines.", "request": { "name": "Returns a paginated list of journal entry lines.", "description": { "content": "Partner list responses embed nested account objects on each line. Use date, account, and search filters to narrow results.", "type": "text/plain" }, "url": { "path": [ "partners", "journal-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Page number for pagination. The first page is 1." }, { "disabled": false, "key": "limit", "value": "", "description": "Records to return per page." }, { "disabled": false, "key": "search", "value": "", "description": "Free-text search across memo and line descriptions." }, { "disabled": false, "key": "startDate", "value": "", "description": "Filter on posting date (ISO, inclusive)." }, { "disabled": false, "key": "endDate", "value": "", "description": "Filter on posting date (ISO, inclusive)." }, { "disabled": false, "key": "accounts", "value": "", "description": "Comma-separated account UUIDs to filter by." }, { "disabled": false, "key": "accountType", "value": "", "description": "Filter by account high-level type." }, { "disabled": false, "key": "reviewed", "value": "", "description": "Filter by reviewed state." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "999eab62-afe3-429f-bc1b-4ba01c8e7a03", "name": "Paginated journal entry lines.", "originalRequest": { "url": { "path": [ "partners", "journal-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "rent" }, { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "accounts", "value": "" }, { "key": "accountType", "value": "" }, { "key": "reviewed", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Successfully found all journal entries\",\n \"data\": {\n \"page\": 1,\n \"limit\": 50,\n \"totalRecords\": 2,\n \"totalSplitJeCount\": 0,\n \"records\": 2,\n \"filters\": {\n \"search\": null,\n \"startDate\": null,\n \"endDate\": null\n },\n \"results\": [\n {\n \"id\": \"f1a2b3c4-d5e6-7890-abcd-ef1234567890\",\n \"descriptionEntry\": \"Accrue March rent\",\n \"descriptionLine\": \"Rent expense\",\n \"date\": \"2026-03-01\",\n \"refNumber\": \"JE-2026-003\",\n \"amountDebit\": \"2500.00\",\n \"amountCredit\": null,\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"account\": {\n \"id\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"name\": \"Rent Expense\",\n \"type\": \"Expenses\"\n },\n \"journalLinkUuid\": \"a9b8c7d6-e5f4-3210-abcd-ef9876543210\",\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a0d317a-9893-41ec-bcec-f3b1bf83edf4", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "journal-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "rent" }, { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "accounts", "value": "" }, { "key": "accountType", "value": "" }, { "key": "reviewed", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3265fb5c-53ae-4af1-8fc7-56c2390a626b", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "journal-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "rent" }, { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "accounts", "value": "" }, { "key": "accountType", "value": "" }, { "key": "reviewed", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e9153c0f-c30f-46d8-8b21-a7cd9544990e", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "journal-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "rent" }, { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "accounts", "value": "" }, { "key": "accountType", "value": "" }, { "key": "reviewed", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f72a371d-997c-4d94-bb51-dc4c9382b674", "name": "Creates a manual journal entry posting.", "request": { "name": "Creates a manual journal entry posting.", "description": { "content": "Required body fields: `descriptionEntry`, `date`, and `lines`. Each line needs `accountUuid` and exactly one of `amountDebit` or `amountCredit`.", "type": "text/plain" }, "url": { "path": [ "partners", "journal-entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"descriptionEntry\": \"\",\n \"date\": \"\",\n \"lines\": [\n {\n \"accountUuid\": \"\",\n \"amountDebit\": \"\",\n \"amountCredit\": \"\",\n \"descriptionLine\": \"\"\n },\n {\n \"accountUuid\": \"\",\n \"amountDebit\": \"\",\n \"amountCredit\": \"\",\n \"descriptionLine\": \"\"\n }\n ],\n \"refNumber\": \"\",\n \"withCaution\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "40a583c0-547d-46bc-92cd-223655e40b6e", "name": "Journal entry created successfully.", "originalRequest": { "url": { "path": [ "partners", "journal-entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"descriptionEntry\": \"Accrue March rent\",\n \"date\": \"2026-03-01\",\n \"refNumber\": \"JE-2026-003\",\n \"lines\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"amountDebit\": \"2500.00\",\n \"descriptionLine\": \"Rent expense\"\n },\n {\n \"accountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"amountCredit\": \"2500.00\",\n \"descriptionLine\": \"Accrued rent payable\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Successfully created journal entry\",\n \"data\": {\n \"results\": [\n {\n \"id\": \"f1a2b3c4-d5e6-7890-abcd-ef1234567890\",\n \"descriptionEntry\": \"Accrue March rent\",\n \"descriptionLine\": \"Rent expense\",\n \"date\": \"2026-03-01\",\n \"refNumber\": \"JE-2026-003\",\n \"amountDebit\": \"2500.00\",\n \"amountCredit\": null,\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"account\": {\n \"id\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"name\": \"Rent Expense\",\n \"type\": \"Expenses\"\n },\n \"journalLinkUuid\": \"a9b8c7d6-e5f4-3210-abcd-ef9876543210\",\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "651de857-d4a0-40f2-b3c8-585ffe76ccb5", "name": "Unbalanced lines, unknown account UUID, locked period, or validation error.", "originalRequest": { "url": { "path": [ "partners", "journal-entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"descriptionEntry\": \"Accrue March rent\",\n \"date\": \"2026-03-01\",\n \"refNumber\": \"JE-2026-003\",\n \"lines\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"amountDebit\": \"2500.00\",\n \"descriptionLine\": \"Rent expense\"\n },\n {\n \"accountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"amountCredit\": \"2500.00\",\n \"descriptionLine\": \"Accrued rent payable\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3402b4f1-4b85-407b-9028-33be4a0fb9a0", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "journal-entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"descriptionEntry\": \"Accrue March rent\",\n \"date\": \"2026-03-01\",\n \"refNumber\": \"JE-2026-003\",\n \"lines\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"amountDebit\": \"2500.00\",\n \"descriptionLine\": \"Rent expense\"\n },\n {\n \"accountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"amountCredit\": \"2500.00\",\n \"descriptionLine\": \"Accrued rent payable\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9bb8b6d1-7b88-4c8d-8e60-3506081a2a40", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "journal-entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"descriptionEntry\": \"Accrue March rent\",\n \"date\": \"2026-03-01\",\n \"refNumber\": \"JE-2026-003\",\n \"lines\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"amountDebit\": \"2500.00\",\n \"descriptionLine\": \"Rent expense\"\n },\n {\n \"accountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"amountCredit\": \"2500.00\",\n \"descriptionLine\": \"Accrued rent payable\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0d1e4b86-6685-4608-aeab-5be484b4b9f7", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "journal-entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"descriptionEntry\": \"Accrue March rent\",\n \"date\": \"2026-03-01\",\n \"refNumber\": \"JE-2026-003\",\n \"lines\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"amountDebit\": \"2500.00\",\n \"descriptionLine\": \"Rent expense\"\n },\n {\n \"accountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"amountCredit\": \"2500.00\",\n \"descriptionLine\": \"Accrued rent payable\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3123f502-11c2-4188-8f3a-fc21012b8430", "name": "Creates up to 100 journal entry postings in one request with partial-success semantics.", "request": { "name": "Creates up to 100 journal entry postings in one request with partial-success semantics.", "description": { "content": "Body: `{ journalEntries: [, ...] }` where each posting uses the same shape as create journal entry. Each posting runs in its own transaction. HTTP 201 is returned when the batch is accepted, even if all postings fail — read `errorCount` and per-row `results`.", "type": "text/plain" }, "url": { "path": [ "partners", "journal-entries", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"journalEntries\": []\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "194a70f9-446e-4e58-b1bd-b6a2249558d6", "name": "Batch accepted. Check successCount and per-row results.", "originalRequest": { "url": { "path": [ "partners", "journal-entries", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"journalEntries\": [\n {\n \"descriptionEntry\": \"Accrue March rent\",\n \"date\": \"2026-03-01\",\n \"refNumber\": \"JE-2026-003\",\n \"lines\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"amountDebit\": \"2500.00\",\n \"descriptionLine\": \"Rent expense\"\n },\n {\n \"accountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"amountCredit\": \"2500.00\",\n \"descriptionLine\": \"Accrued rent payable\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"successCount\": 1,\n \"errorCount\": 0,\n \"results\": [\n {\n \"index\": 0,\n \"success\": true,\n \"journalEntry\": [\n {\n \"id\": \"f1a2b3c4-d5e6-7890-abcd-ef1234567890\",\n \"descriptionEntry\": \"Accrue March rent\",\n \"descriptionLine\": \"Rent expense\",\n \"date\": \"2026-03-01\",\n \"refNumber\": \"JE-2026-003\",\n \"amountDebit\": \"2500.00\",\n \"amountCredit\": null,\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"account\": {\n \"id\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"name\": \"Rent Expense\",\n \"type\": \"Expenses\"\n },\n \"journalLinkUuid\": \"a9b8c7d6-e5f4-3210-abcd-ef9876543210\",\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a565266-9658-49c0-8781-1836cff8ecd1", "name": "Batch-level validation failed (empty array, over 100 postings, etc.).", "originalRequest": { "url": { "path": [ "partners", "journal-entries", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"journalEntries\": [\n {\n \"descriptionEntry\": \"Accrue March rent\",\n \"date\": \"2026-03-01\",\n \"refNumber\": \"JE-2026-003\",\n \"lines\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"amountDebit\": \"2500.00\",\n \"descriptionLine\": \"Rent expense\"\n },\n {\n \"accountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"amountCredit\": \"2500.00\",\n \"descriptionLine\": \"Accrued rent payable\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c524be44-7338-4142-b81a-1e97f28f8596", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "journal-entries", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"journalEntries\": [\n {\n \"descriptionEntry\": \"Accrue March rent\",\n \"date\": \"2026-03-01\",\n \"refNumber\": \"JE-2026-003\",\n \"lines\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"amountDebit\": \"2500.00\",\n \"descriptionLine\": \"Rent expense\"\n },\n {\n \"accountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"amountCredit\": \"2500.00\",\n \"descriptionLine\": \"Accrued rent payable\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "59d43b89-6863-47ab-a11c-9920c98bf287", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "journal-entries", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"journalEntries\": [\n {\n \"descriptionEntry\": \"Accrue March rent\",\n \"date\": \"2026-03-01\",\n \"refNumber\": \"JE-2026-003\",\n \"lines\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"amountDebit\": \"2500.00\",\n \"descriptionLine\": \"Rent expense\"\n },\n {\n \"accountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"amountCredit\": \"2500.00\",\n \"descriptionLine\": \"Accrued rent payable\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "185ab75b-0169-4a1c-9cb8-46a6729d9efa", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "journal-entries", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"journalEntries\": [\n {\n \"descriptionEntry\": \"Accrue March rent\",\n \"date\": \"2026-03-01\",\n \"refNumber\": \"JE-2026-003\",\n \"lines\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"amountDebit\": \"2500.00\",\n \"descriptionLine\": \"Rent expense\"\n },\n {\n \"accountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"amountCredit\": \"2500.00\",\n \"descriptionLine\": \"Accrued rent payable\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "05ac1405-6763-4802-8944-6f044bbe8a41", "name": "Updates a manually-created journal entry by UUID.", "request": { "name": "Updates a manually-created journal entry by UUID.", "description": { "content": "Same body shape as create: `descriptionEntry`, `date`, optional `refNumber`, and the full replacement `lines` array. System-generated entries return 400.", "type": "text/plain" }, "url": { "path": [ "partners", "journal-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of any line in the posting (anchor line)." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"descriptionEntry\": \"\",\n \"date\": \"\",\n \"refNumber\": \"\",\n \"withCaution\": \"\",\n \"lines\": [\n {\n \"accountUuid\": \"\",\n \"amountDebit\": \"\",\n \"amountCredit\": \"\",\n \"descriptionLine\": \"\"\n },\n {\n \"accountUuid\": \"\",\n \"amountDebit\": \"\",\n \"amountCredit\": \"\",\n \"descriptionLine\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a4953694-2137-4f4d-b677-975d56120520", "name": "Journal entry updated successfully.", "originalRequest": { "url": { "path": [ "partners", "journal-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of any line in the posting (anchor line)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"descriptionEntry\": \"Accrue March rent — revised\",\n \"date\": \"2026-03-01\",\n \"lines\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"amountDebit\": \"2500.00\",\n \"descriptionLine\": \"Rent expense\"\n },\n {\n \"accountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"amountCredit\": \"2500.00\",\n \"descriptionLine\": \"Accrued rent payable\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Successfully updated journal entry\",\n \"data\": {\n \"results\": [\n {\n \"id\": \"f1a2b3c4-d5e6-7890-abcd-ef1234567890\",\n \"descriptionEntry\": \"Accrue March rent\",\n \"descriptionLine\": \"Rent expense\",\n \"date\": \"2026-03-01\",\n \"refNumber\": \"JE-2026-003\",\n \"amountDebit\": \"2500.00\",\n \"amountCredit\": null,\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"account\": {\n \"id\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"name\": \"Rent Expense\",\n \"type\": \"Expenses\"\n },\n \"journalLinkUuid\": \"a9b8c7d6-e5f4-3210-abcd-ef9876543210\",\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5813d3f6-81d0-4faa-bc2e-9718f1c682a9", "name": "System-generated entry, validation error, or unbalanced lines.", "originalRequest": { "url": { "path": [ "partners", "journal-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of any line in the posting (anchor line)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"descriptionEntry\": \"Accrue March rent — revised\",\n \"date\": \"2026-03-01\",\n \"lines\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"amountDebit\": \"2500.00\",\n \"descriptionLine\": \"Rent expense\"\n },\n {\n \"accountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"amountCredit\": \"2500.00\",\n \"descriptionLine\": \"Accrued rent payable\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "74f33503-cede-402f-aedb-1fe3ba53b942", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "journal-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of any line in the posting (anchor line)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"descriptionEntry\": \"Accrue March rent — revised\",\n \"date\": \"2026-03-01\",\n \"lines\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"amountDebit\": \"2500.00\",\n \"descriptionLine\": \"Rent expense\"\n },\n {\n \"accountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"amountCredit\": \"2500.00\",\n \"descriptionLine\": \"Accrued rent payable\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b872bd1a-ab5e-40f0-bdd9-4b051db91bf7", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "journal-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of any line in the posting (anchor line)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"descriptionEntry\": \"Accrue March rent — revised\",\n \"date\": \"2026-03-01\",\n \"lines\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"amountDebit\": \"2500.00\",\n \"descriptionLine\": \"Rent expense\"\n },\n {\n \"accountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"amountCredit\": \"2500.00\",\n \"descriptionLine\": \"Accrued rent payable\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e44b5115-eab7-47dc-96dc-51225e49048e", "name": "Journal entry not found.", "originalRequest": { "url": { "path": [ "partners", "journal-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of any line in the posting (anchor line)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"descriptionEntry\": \"Accrue March rent — revised\",\n \"date\": \"2026-03-01\",\n \"lines\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"amountDebit\": \"2500.00\",\n \"descriptionLine\": \"Rent expense\"\n },\n {\n \"accountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"amountCredit\": \"2500.00\",\n \"descriptionLine\": \"Accrued rent payable\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e352b2d2-8407-4bea-87be-12fd51672686", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "journal-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of any line in the posting (anchor line)." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"descriptionEntry\": \"Accrue March rent — revised\",\n \"date\": \"2026-03-01\",\n \"lines\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"amountDebit\": \"2500.00\",\n \"descriptionLine\": \"Rent expense\"\n },\n {\n \"accountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"amountCredit\": \"2500.00\",\n \"descriptionLine\": \"Accrued rent payable\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2d58a2bb-e8d0-4034-90a1-67c00bcc4a4f", "name": "Deletes a journal entry posting by UUID.", "request": { "name": "Deletes a journal entry posting by UUID.", "description": { "content": "Removes all lines sharing the same journal link. System-generated entries return 400.", "type": "text/plain" }, "url": { "path": [ "partners", "journal-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of any line in the posting." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "92c45d24-2a82-44c6-80ee-4af97c9446ae", "name": "Journal entry deleted successfully.", "originalRequest": { "url": { "path": [ "partners", "journal-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of any line in the posting." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Non-Authoritative Information (since HTTP/1.1)", "code": 203, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Successfully deleted journal entry\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8e89a6e-0e41-4e85-80c7-3f727ed54ccf", "name": "System-generated entry cannot be deleted.", "originalRequest": { "url": { "path": [ "partners", "journal-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of any line in the posting." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6addf2d2-048f-4498-9efd-04d1ad9990bd", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "journal-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of any line in the posting." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "25033c14-3eba-439a-aef5-56cf4d407016", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "journal-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of any line in the posting." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a976d102-f502-4309-bd4a-9ff4f40c6955", "name": "Journal entry not found.", "originalRequest": { "url": { "path": [ "partners", "journal-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of any line in the posting." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d581708d-641c-40c6-9b87-872cdd7d3316", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "journal-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of any line in the posting." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "0e5cd360-96c6-4cc1-b5ae-122b7b08b3db", "name": "Budgets", "description": { "content": "Budgets let partners create workspace financial plans with versioned cell grids. Partner responses expose budget UUIDs as `id`, strip internal numeric foreign keys, and require `accountUuid` (not numeric `accountId`) on cell update payloads.", "type": "text/plain" }, "item": [ { "id": "4d1946a1-5528-4e0b-81ef-47d4348bd6a3", "name": "Returns the workspace Overall Budget, if one exists.", "request": { "name": "Returns the workspace Overall Budget, if one exists.", "description": {}, "url": { "path": [ "partners", "budgets", "overall" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "603f1b28-5461-4c79-8cf9-905af3a27965", "name": "The Overall Budget record.", "originalRequest": { "url": { "path": [ "partners", "budgets", "overall" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on fetching overall budget\",\n \"data\": {\n \"budget\": {\n \"id\": \"55667788-99aa-bbcc-ddee-ff0011223344\",\n \"name\": \"Overall Budget\",\n \"startPeriod\": \"2026-01-01\",\n \"cadence\": \"monthly\",\n \"actualPeriods\": 3,\n \"budgetPeriods\": 12,\n \"currencyCode\": \"USD\",\n \"status\": \"draft\",\n \"lockedAt\": null,\n \"isOverall\": true,\n \"versions\": [\n {\n \"versionNumber\": 1,\n \"label\": \"Initial\",\n \"isPublished\": false,\n \"createdAt\": \"2026-01-15T10:30:00.000Z\"\n }\n ],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "190246f0-6fbd-408d-9311-791993db74a3", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "budgets", "overall" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5179921d-a782-4794-896f-6c2f38438b7f", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "budgets", "overall" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7b65b10e-08be-49a0-a616-dcc05d7bc2d2", "name": "No Overall Budget exists for this workspace.", "originalRequest": { "url": { "path": [ "partners", "budgets", "overall" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fa82fe87-bf60-4844-b9ae-59ab9598c625", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "budgets", "overall" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f3874187-64db-4a44-84e4-f2168777fb93", "name": "Returns all budgets in the workspace, optionally filtered by status.", "request": { "name": "Returns all budgets in the workspace, optionally filtered by status.", "description": {}, "url": { "path": [ "partners", "budgets" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "status", "value": "", "description": "Filter by budget status." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "93e7bf6d-1927-413c-90ec-0605272bf001", "name": "Budget list.", "originalRequest": { "url": { "path": [ "partners", "budgets" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on fetching budgets\",\n \"data\": {\n \"budgets\": [\n {\n \"id\": \"55667788-99aa-bbcc-ddee-ff0011223344\",\n \"name\": \"FY 2026 Operating Budget\",\n \"startPeriod\": \"2026-01-01\",\n \"cadence\": \"monthly\",\n \"actualPeriods\": 3,\n \"budgetPeriods\": 12,\n \"currencyCode\": \"USD\",\n \"status\": \"draft\",\n \"lockedAt\": null,\n \"isOverall\": false,\n \"versions\": [\n {\n \"versionNumber\": 1,\n \"label\": \"Initial\",\n \"isPublished\": false,\n \"createdAt\": \"2026-01-15T10:30:00.000Z\"\n }\n ],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80c8c90f-8dbc-487d-b71a-0c604018378e", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "budgets" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "40683f78-ed57-4eab-b1d5-457ab3b2d4b5", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "budgets" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7397734b-b411-4345-8e9d-96106f7e11a0", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "budgets" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e3368341-631b-41a6-8322-9c4f3addb91b", "name": "Creates a budget and its initial version.", "request": { "name": "Creates a budget and its initial version.", "description": {}, "url": { "path": [ "partners", "budgets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"startPeriod\": \"\",\n \"cadence\": \"\",\n \"actualPeriods\": \"\",\n \"budgetPeriods\": \"\",\n \"currencyCode\": \"\",\n \"isOverall\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cb8fd107-109b-4bf1-985a-952d6588d353", "name": "Budget and initial version created.", "originalRequest": { "url": { "path": [ "partners", "budgets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"FY 2026 Operating Budget\",\n \"startPeriod\": \"2026-01-01\",\n \"cadence\": \"monthly\",\n \"actualPeriods\": 3,\n \"budgetPeriods\": 12,\n \"currencyCode\": \"USD\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on creating budget\",\n \"data\": {\n \"budget\": {\n \"id\": \"55667788-99aa-bbcc-ddee-ff0011223344\",\n \"name\": \"FY 2026 Operating Budget\",\n \"startPeriod\": \"2026-01-01\",\n \"cadence\": \"monthly\",\n \"actualPeriods\": 3,\n \"budgetPeriods\": 12,\n \"currencyCode\": \"USD\",\n \"status\": \"draft\",\n \"lockedAt\": null,\n \"isOverall\": false,\n \"versions\": [\n {\n \"versionNumber\": 1,\n \"label\": \"Initial\",\n \"isPublished\": false,\n \"createdAt\": \"2026-01-15T10:30:00.000Z\"\n }\n ],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n },\n \"version\": {\n \"versionNumber\": 1,\n \"label\": \"Initial\",\n \"isPublished\": false,\n \"createdAt\": \"2026-01-15T10:30:00.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ba18e41-3673-47e1-98da-f421b2bcb63c", "name": "Validation failed or duplicate budget name.", "originalRequest": { "url": { "path": [ "partners", "budgets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"FY 2026 Operating Budget\",\n \"startPeriod\": \"2026-01-01\",\n \"cadence\": \"monthly\",\n \"actualPeriods\": 3,\n \"budgetPeriods\": 12,\n \"currencyCode\": \"USD\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b22db2c1-3700-44b1-bd6f-afafd6d0fa7c", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "budgets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"FY 2026 Operating Budget\",\n \"startPeriod\": \"2026-01-01\",\n \"cadence\": \"monthly\",\n \"actualPeriods\": 3,\n \"budgetPeriods\": 12,\n \"currencyCode\": \"USD\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "afad804d-f1cd-470e-bfd9-2ff54dab29a0", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "budgets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"FY 2026 Operating Budget\",\n \"startPeriod\": \"2026-01-01\",\n \"cadence\": \"monthly\",\n \"actualPeriods\": 3,\n \"budgetPeriods\": 12,\n \"currencyCode\": \"USD\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8af76ac7-8252-40ae-9efe-2a943a6a2072", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "budgets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"FY 2026 Operating Budget\",\n \"startPeriod\": \"2026-01-01\",\n \"cadence\": \"monthly\",\n \"actualPeriods\": 3,\n \"budgetPeriods\": 12,\n \"currencyCode\": \"USD\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ebfa5763-f1bd-4243-9f8d-4f94fbed706f", "name": "Retrieves a single budget by UUID.", "request": { "name": "Retrieves a single budget by UUID.", "description": {}, "url": { "path": [ "partners", "budgets", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "1534bb6b-27b5-4c41-bb42-231202b3115e", "name": "The requested budget.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on fetching budget\",\n \"data\": {\n \"budget\": {\n \"id\": \"55667788-99aa-bbcc-ddee-ff0011223344\",\n \"name\": \"FY 2026 Operating Budget\",\n \"startPeriod\": \"2026-01-01\",\n \"cadence\": \"monthly\",\n \"actualPeriods\": 3,\n \"budgetPeriods\": 12,\n \"currencyCode\": \"USD\",\n \"status\": \"draft\",\n \"lockedAt\": null,\n \"isOverall\": false,\n \"versions\": [\n {\n \"versionNumber\": 1,\n \"label\": \"Initial\",\n \"isPublished\": false,\n \"createdAt\": \"2026-01-15T10:30:00.000Z\"\n }\n ],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3398979f-d033-4f81-9785-62fb1ccb1a9b", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "de0c5f68-f668-406e-8ead-6e02c7ed2db2", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e14595fc-8f34-420b-b780-c7ad5b8ea0e3", "name": "Budget not found.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "12fd3078-4cdf-4bb1-96e8-ff66febe6c2b", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "414ebfb4-1abd-4240-a4e2-0d8b546356a6", "name": "Updates budget metadata. Rejected when the budget is published or locked.", "request": { "name": "Updates budget metadata. Rejected when the budget is published or locked.", "description": {}, "url": { "path": [ "partners", "budgets", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"startPeriod\": \"\",\n \"cadence\": \"\",\n \"actualPeriods\": \"\",\n \"budgetPeriods\": \"\",\n \"isOverall\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "24ffc0f4-7030-447c-a864-cf6bcdf94adf", "name": "Budget updated.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"FY 2026 Operating Budget — Revised\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on updating budget\",\n \"data\": {\n \"budget\": {\n \"id\": \"55667788-99aa-bbcc-ddee-ff0011223344\",\n \"name\": \"FY 2026 Operating Budget\",\n \"startPeriod\": \"2026-01-01\",\n \"cadence\": \"monthly\",\n \"actualPeriods\": 3,\n \"budgetPeriods\": 12,\n \"currencyCode\": \"USD\",\n \"status\": \"draft\",\n \"lockedAt\": null,\n \"isOverall\": false,\n \"versions\": [\n {\n \"versionNumber\": 1,\n \"label\": \"Initial\",\n \"isPublished\": false,\n \"createdAt\": \"2026-01-15T10:30:00.000Z\"\n }\n ],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "feaec2b4-c475-4aa7-961a-a1f5808092a5", "name": "Budget is published, locked, or validation failed.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"FY 2026 Operating Budget — Revised\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "becd432c-e39f-449f-8c39-98306624ae7a", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"FY 2026 Operating Budget — Revised\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b3341cbd-f9f7-4b43-90b3-cbc54274571f", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"FY 2026 Operating Budget — Revised\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c2b88ead-3c9f-4f23-b9a6-b8cf7d20903e", "name": "Budget not found.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"FY 2026 Operating Budget — Revised\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eb64879a-86a4-4a75-bc4a-f328f4fa4e05", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"FY 2026 Operating Budget — Revised\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9e2b85e4-46f6-4e60-a20e-12e9e608960e", "name": "Deletes a draft budget.", "request": { "name": "Deletes a draft budget.", "description": { "content": "Only draft budgets can be deleted; the Overall Budget cannot be deleted, and published or archived budgets must be archived instead.", "type": "text/plain" }, "url": { "path": [ "partners", "budgets", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "accfcbc2-0890-47bc-a067-0462f02ab06f", "name": "Budget deleted.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on deleting budget\",\n \"data\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c64a7dac-d9a5-43b3-b644-865eb596f7ff", "name": "Budget is the Overall Budget or is not in draft status.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "658eff4d-eb51-4fc6-9b19-0da618c020b0", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "77fed31c-1915-410a-9b75-8c5eb0ced77e", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "59854588-6ad7-4c17-a672-5c6bc70dee00", "name": "Budget not found.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2a90112a-90d2-4a25-9756-530954444bac", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3cedae8e-0591-4f25-a75f-edd5700158ad", "name": "Returns the budget cell grid for a version, with optional actuals.", "request": { "name": "Returns the budget cell grid for a version, with optional actuals.", "description": {}, "url": { "path": [ "partners", "budgets", ":uuid", "grid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "versionNumber", "value": "", "description": "Version to load. Defaults to the latest version." }, { "disabled": false, "key": "includeActuals", "value": "", "description": "When false, omit actual-period columns. Defaults to true." }, { "disabled": false, "key": "reportType", "value": "", "description": "Reporting basis for actuals." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "29b87e61-a994-40b7-8567-17f4f7727619", "name": "Budget grid with account UUIDs on each row.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "grid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "versionNumber", "value": "1" }, { "key": "includeActuals", "value": "" }, { "key": "reportType", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on fetching budget grid\",\n \"data\": {\n \"grid\": {\n \"meta\": {\n \"version\": {\n \"versionNumber\": 1,\n \"label\": \"Initial\",\n \"isPublished\": false,\n \"createdAt\": \"2026-01-15T10:30:00.000Z\"\n }\n },\n \"rows\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"parentAccountUuid\": null,\n \"accountName\": \"Sales Revenue\",\n \"accountPath\": \"Income:Sales Revenue\",\n \"values\": [\n 10000,\n 12000,\n 11000\n ]\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3317cb32-f577-4ed6-bc7f-23237976dd0c", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "grid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "versionNumber", "value": "1" }, { "key": "includeActuals", "value": "" }, { "key": "reportType", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e4f04911-71e6-4cb5-8a55-3eb5f692a9f3", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "grid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "versionNumber", "value": "1" }, { "key": "includeActuals", "value": "" }, { "key": "reportType", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "89aaff84-7e23-4d79-95c5-9f68bc00a842", "name": "Budget or version not found.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "grid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "versionNumber", "value": "1" }, { "key": "includeActuals", "value": "" }, { "key": "reportType", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bd11c58c-0546-4907-b99f-a12064ffdfd0", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "grid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "versionNumber", "value": "1" }, { "key": "includeActuals", "value": "" }, { "key": "reportType", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5a1e09c8-6f3a-4ac5-87a8-f861ddf9e13c", "name": "Returns version summaries for a budget.", "request": { "name": "Returns version summaries for a budget.", "description": {}, "url": { "path": [ "partners", "budgets", ":uuid", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "c95d18b6-65ce-47f5-a101-2ee028f415dd", "name": "Version list.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on fetching budget versions\",\n \"data\": {\n \"versions\": [\n {\n \"versionNumber\": 1,\n \"label\": \"Initial\",\n \"isPublished\": false,\n \"createdAt\": \"2026-01-15T10:30:00.000Z\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49110fa4-dd40-4256-a6a9-be69a02f5335", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b3959fe0-6ab7-4c3f-b57d-f332b9fa565e", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f1fc64db-f243-4e56-9229-3f6cc5ca8e8d", "name": "Budget not found.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ce6ca52a-acf6-42e5-ab55-f907ae9776ff", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fe983662-6987-4af8-99e4-d12406db1f13", "name": "Creates a new numbered version for the budget.", "request": { "name": "Creates a new numbered version for the budget.", "description": {}, "url": { "path": [ "partners", "budgets", ":uuid", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"label\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "aec4adbb-9b9c-4c1b-9c7c-618202529836", "name": "Version created.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"label\": \"Q2 revision\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on creating budget version\",\n \"data\": {\n \"version\": {\n \"versionNumber\": 2,\n \"label\": \"Q2 revision\",\n \"isPublished\": false,\n \"createdAt\": \"2026-01-15T10:30:00.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed7658b6-8061-441b-9770-480836a19e00", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"label\": \"Q2 revision\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d9dfe8b0-40ff-4eae-8aad-b20478d25f32", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"label\": \"Q2 revision\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f6fc2f43-f72a-4907-aea1-172e8bc17db4", "name": "Budget not found.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"label\": \"Q2 revision\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "28a30740-4e19-4a66-92d5-9d67e3277940", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"label\": \"Q2 revision\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "57e7746e-c721-4a63-b5b7-a856bbbd0413", "name": "Updates one or more cells in a budget version.", "request": { "name": "Updates one or more cells in a budget version.", "description": {}, "url": { "path": [ "partners", "budgets", ":uuid", "versions", ":versionNumber", "cells" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." }, { "disabled": false, "type": "any", "value": "", "key": "versionNumber", "description": "(Required) Target version number." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"updates\": [\n {\n \"accountUuid\": \"\",\n \"periodStart\": \"\",\n \"amount\": \"\"\n },\n {\n \"accountUuid\": \"\",\n \"periodStart\": \"\",\n \"amount\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0fbead52-e259-464f-8d84-2dffae138a82", "name": "Cells updated.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "versions", ":versionNumber", "cells" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." }, { "disabled": false, "type": "any", "value": "", "key": "versionNumber", "description": "(Required) Target version number." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"updates\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"periodStart\": \"2026-01-01\",\n \"amount\": 10000\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on updating budget cells\",\n \"data\": {\n \"updatedCount\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dc2bc6a-327d-41d5-964e-9811d2a84993", "name": "Invalid account UUID, amount, or legacy accountId field.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "versions", ":versionNumber", "cells" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." }, { "disabled": false, "type": "any", "value": "", "key": "versionNumber", "description": "(Required) Target version number." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"updates\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"periodStart\": \"2026-01-01\",\n \"amount\": 10000\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4ae3574e-28d2-4dde-afd6-38fd2d5c886e", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "versions", ":versionNumber", "cells" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." }, { "disabled": false, "type": "any", "value": "", "key": "versionNumber", "description": "(Required) Target version number." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"updates\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"periodStart\": \"2026-01-01\",\n \"amount\": 10000\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2c4e2d7f-d36f-4f20-971a-b512080e6a03", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "versions", ":versionNumber", "cells" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." }, { "disabled": false, "type": "any", "value": "", "key": "versionNumber", "description": "(Required) Target version number." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"updates\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"periodStart\": \"2026-01-01\",\n \"amount\": 10000\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1056c939-cd98-4c0a-8900-fd5a5fb61ac2", "name": "Budget or version not found.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "versions", ":versionNumber", "cells" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." }, { "disabled": false, "type": "any", "value": "", "key": "versionNumber", "description": "(Required) Target version number." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"updates\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"periodStart\": \"2026-01-01\",\n \"amount\": 10000\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d958bdc8-4afa-46d9-8321-1a47af2bf982", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "versions", ":versionNumber", "cells" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." }, { "disabled": false, "type": "any", "value": "", "key": "versionNumber", "description": "(Required) Target version number." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"updates\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"periodStart\": \"2026-01-01\",\n \"amount\": 10000\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fc329d16-82c9-4b38-bd81-94a0231bf9bc", "name": "Applies many cell updates in one request with per-row success/failure results.", "request": { "name": "Applies many cell updates in one request with per-row success/failure results.", "description": {}, "url": { "path": [ "partners", "budgets", ":uuid", "versions", ":versionNumber", "cells", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." }, { "disabled": false, "type": "any", "value": "", "key": "versionNumber", "description": "(Required) Target version number." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"updates\": [\n {\n \"accountUuid\": \"\",\n \"periodStart\": \"\",\n \"amount\": \"\"\n },\n {\n \"accountUuid\": \"\",\n \"periodStart\": \"\",\n \"amount\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c6cb8e4e-4db2-4cea-8f19-280f93a70313", "name": "Bulk update summary with per-row results.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "versions", ":versionNumber", "cells", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." }, { "disabled": false, "type": "any", "value": "", "key": "versionNumber", "description": "(Required) Target version number." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"updates\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"periodStart\": \"2026-01-01\",\n \"amount\": 10000\n },\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"periodStart\": \"2026-02-01\",\n \"amount\": 12000\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"successCount\": 2,\n \"failureCount\": 0,\n \"results\": [\n {\n \"index\": 0,\n \"success\": true,\n \"budgetCellUpdate\": {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"periodStart\": \"2026-01-01\",\n \"amount\": 10000\n }\n },\n {\n \"index\": 1,\n \"success\": true,\n \"budgetCellUpdate\": {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"periodStart\": \"2026-02-01\",\n \"amount\": 12000\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d235091-0453-4d9a-be55-3a1633685401", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "versions", ":versionNumber", "cells", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." }, { "disabled": false, "type": "any", "value": "", "key": "versionNumber", "description": "(Required) Target version number." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"updates\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"periodStart\": \"2026-01-01\",\n \"amount\": 10000\n },\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"periodStart\": \"2026-02-01\",\n \"amount\": 12000\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4fb138e8-2684-45ee-85f3-08c89f92ea6a", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "versions", ":versionNumber", "cells", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." }, { "disabled": false, "type": "any", "value": "", "key": "versionNumber", "description": "(Required) Target version number." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"updates\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"periodStart\": \"2026-01-01\",\n \"amount\": 10000\n },\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"periodStart\": \"2026-02-01\",\n \"amount\": 12000\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7a70a17f-31aa-43b5-b7b8-9ddd004351d9", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "versions", ":versionNumber", "cells", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." }, { "disabled": false, "type": "any", "value": "", "key": "versionNumber", "description": "(Required) Target version number." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"updates\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"periodStart\": \"2026-01-01\",\n \"amount\": 10000\n },\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"periodStart\": \"2026-02-01\",\n \"amount\": 12000\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c32e8523-7d7e-470c-81c6-dae080da476a", "name": "Publishes a budget version snapshot.", "request": { "name": "Publishes a budget version snapshot.", "description": {}, "url": { "path": [ "partners", "budgets", ":uuid", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"versionNumber\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "809a924c-8dca-4cbc-ad2d-8bf82d6ecc21", "name": "Budget published.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionNumber\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on publishing budget\",\n \"data\": {\n \"budget\": {\n \"id\": \"55667788-99aa-bbcc-ddee-ff0011223344\",\n \"name\": \"FY 2026 Operating Budget\",\n \"startPeriod\": \"2026-01-01\",\n \"cadence\": \"monthly\",\n \"actualPeriods\": 3,\n \"budgetPeriods\": 12,\n \"currencyCode\": \"USD\",\n \"status\": \"published\",\n \"lockedAt\": null,\n \"isOverall\": false,\n \"versions\": [\n {\n \"versionNumber\": 1,\n \"label\": \"Initial\",\n \"isPublished\": false,\n \"createdAt\": \"2026-01-15T10:30:00.000Z\"\n }\n ],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n },\n \"version\": {\n \"versionNumber\": 1,\n \"label\": \"Initial\",\n \"isPublished\": true,\n \"createdAt\": \"2026-01-15T10:30:00.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6de6f9dc-68e6-40cb-8a1c-19fca2e973f3", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionNumber\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fa121bb0-08ad-428d-9597-6fb0b1a8f2f5", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionNumber\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "57516c41-a10f-4306-8e8d-3b4a9f8803cf", "name": "Budget or version not found.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionNumber\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7d7ec06c-5bf1-42ff-86d3-0ac5bf37da82", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"versionNumber\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f4150c49-b7ea-49d5-bbb1-ffb30df31367", "name": "Archives a budget.", "request": { "name": "Archives a budget.", "description": {}, "url": { "path": [ "partners", "budgets", ":uuid", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "9063164d-843d-43b5-a120-fd765c3634a3", "name": "Budget archived.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on archiving budget\",\n \"data\": {\n \"budget\": {\n \"id\": \"55667788-99aa-bbcc-ddee-ff0011223344\",\n \"name\": \"FY 2026 Operating Budget\",\n \"startPeriod\": \"2026-01-01\",\n \"cadence\": \"monthly\",\n \"actualPeriods\": 3,\n \"budgetPeriods\": 12,\n \"currencyCode\": \"USD\",\n \"status\": \"archived\",\n \"lockedAt\": null,\n \"isOverall\": false,\n \"versions\": [\n {\n \"versionNumber\": 1,\n \"label\": \"Initial\",\n \"isPublished\": false,\n \"createdAt\": \"2026-01-15T10:30:00.000Z\"\n }\n ],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "587667b7-f85d-46b9-ba45-1b57f1393f20", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "45f930f8-4984-4feb-9400-122009ce83e1", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8f2e1845-1a95-4334-9fc9-8f06f0ee918e", "name": "Budget not found.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "96617014-6a42-40c5-aad6-65adc1af48ee", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2137d738-a39d-40e6-b261-9bca165aed00", "name": "Creates a copy of a budget, optionally carrying cell values forward.", "request": { "name": "Creates a copy of a budget, optionally carrying cell values forward.", "description": {}, "url": { "path": [ "partners", "budgets", ":uuid", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The source budget UUID." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"newName\": \"\",\n \"carryValues\": \"\",\n \"isOverall\": \"\",\n \"versionNumber\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bde491db-c8ae-44ba-b84f-26fffe6c7759", "name": "Budget duplicated.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The source budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"newName\": \"FY 2026 Operating Budget — Copy\",\n \"carryValues\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on duplicating budget\",\n \"data\": {\n \"budget\": {\n \"id\": \"66778899-aabb-ccdd-eeff-001122334455\",\n \"name\": \"FY 2026 Operating Budget — Copy\",\n \"startPeriod\": \"2026-01-01\",\n \"cadence\": \"monthly\",\n \"actualPeriods\": 3,\n \"budgetPeriods\": 12,\n \"currencyCode\": \"USD\",\n \"status\": \"draft\",\n \"lockedAt\": null,\n \"isOverall\": false,\n \"versions\": [\n {\n \"versionNumber\": 1,\n \"label\": \"Initial\",\n \"isPublished\": false,\n \"createdAt\": \"2026-01-15T10:30:00.000Z\"\n }\n ],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n },\n \"version\": {\n \"versionNumber\": 1,\n \"label\": \"Initial\",\n \"isPublished\": false,\n \"createdAt\": \"2026-01-15T10:30:00.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70815907-9f9d-4d75-9141-e5959b4bdfa4", "name": "Duplicate name or Overall Budget conflict.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The source budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"newName\": \"FY 2026 Operating Budget — Copy\",\n \"carryValues\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cbda108b-4865-4ea9-86bf-301487aab1a3", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The source budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"newName\": \"FY 2026 Operating Budget — Copy\",\n \"carryValues\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "443cb23c-a831-4e26-ace9-93ca988232c7", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The source budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"newName\": \"FY 2026 Operating Budget — Copy\",\n \"carryValues\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c1d083db-fb90-44b9-ae2b-3067e38b70e9", "name": "Source budget not found.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The source budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"newName\": \"FY 2026 Operating Budget — Copy\",\n \"carryValues\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "235d4905-58fe-4f6f-9a3d-88cfe31ee9e4", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "budgets", ":uuid", "duplicate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The source budget UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"newName\": \"FY 2026 Operating Budget — Copy\",\n \"carryValues\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "05bf6a35-6689-4eb0-bfc0-8faa74b330f3", "name": "Tags", "description": { "content": "Tags are workspace labels used to classify transactions, journal entries, invoices, bills, and other records. Tag groups organize related tags — each tag may belong to at most one group.", "type": "text/plain" }, "item": [ { "id": "6ed9e169-c532-42d0-99d1-cdfea07d2bf7", "name": "Returns all tags in the workspace.", "request": { "name": "Returns all tags in the workspace.", "description": { "content": "Tags are returned with embedded tag group metadata when assigned. Results are sorted by name ascending.", "type": "text/plain" }, "url": { "path": [ "partners", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "search", "value": "", "description": "Partial, case-insensitive match on tag name." }, { "disabled": false, "key": "page", "value": "", "description": "Page number for pagination. The first page is 1." }, { "disabled": false, "key": "limit", "value": "", "description": "Records to return per page." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "300bc514-d7eb-4e55-8e4a-590fe531236b", "name": "Array of tags.", "originalRequest": { "url": { "path": [ "partners", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "office" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"e5f6a7b8-c9d0-1234-efab-345678901234\",\n \"name\": \"Office\",\n \"tagGroups\": [\n {\n \"id\": \"f6a7b8c9-d0e1-2345-fabc-456789012346\",\n \"name\": \"Department\",\n \"color\": \"#4A90D9\"\n }\n ],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3be12e04-9db5-48e7-955e-adddedb28883", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "office" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1802d68e-a888-4040-8b3d-f9058a17c544", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "office" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a17593bd-7f86-4605-94e2-fd2dc7bd628e", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "office" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "33a5dca9-ac21-4e13-92a1-83a73934190a", "name": "Creates a tag in the workspace.", "request": { "name": "Creates a tag in the workspace.", "description": { "content": "If a tag with the same name already exists, the existing tag is returned.", "type": "text/plain" }, "url": { "path": [ "partners", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5129ae61-2c96-4d91-8d5f-ebbcda305fd3", "name": "Tag created (or existing tag returned).", "originalRequest": { "url": { "path": [ "partners", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Office\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"e5f6a7b8-c9d0-1234-efab-345678901234\",\n \"name\": \"Office\",\n \"tagGroups\": [\n {\n \"id\": \"f6a7b8c9-d0e1-2345-fabc-456789012346\",\n \"name\": \"Department\",\n \"color\": \"#4A90D9\"\n }\n ],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9cd603d0-0091-47d3-a3ae-8a7874feec2a", "name": "Validation failed — missing name.", "originalRequest": { "url": { "path": [ "partners", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Office\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2bcdb5a4-b2d1-4405-b65f-5ed2a3934e23", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Office\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eac08868-8547-4d7c-9a1a-9bbb8f38d6f9", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Office\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "af73a06f-868b-4cd8-9fd7-a880e392dfcc", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Office\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b8f83e4e-16e1-4e3e-b88a-11b498e3e647", "name": "Retrieves a single tag by UUID.", "request": { "name": "Retrieves a single tag by UUID.", "description": {}, "url": { "path": [ "partners", "tags", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag UUID." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "2f0baa84-b111-4eab-ae07-64c3569211e7", "name": "The requested tag.", "originalRequest": { "url": { "path": [ "partners", "tags", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"e5f6a7b8-c9d0-1234-efab-345678901234\",\n \"name\": \"Office\",\n \"tagGroups\": [\n {\n \"id\": \"f6a7b8c9-d0e1-2345-fabc-456789012346\",\n \"name\": \"Department\",\n \"color\": \"#4A90D9\"\n }\n ],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c002fd36-9f43-4c6d-bb95-ab07e78c1cb5", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "tags", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5b65155a-2010-46f8-8896-730f1443b575", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "tags", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c960e7e0-4056-4ec6-8f66-26a072ed2afb", "name": "Tag not found.", "originalRequest": { "url": { "path": [ "partners", "tags", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6a4c8855-8770-432d-bb82-cdff2b291526", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "tags", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d4125185-21a4-46e4-85b1-3b1913ec5241", "name": "Updates a tag name by UUID.", "request": { "name": "Updates a tag name by UUID.", "description": {}, "url": { "path": [ "partners", "tags", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag UUID to update." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3a24135c-ad7c-4faa-a040-74853eae34a4", "name": "Tag updated successfully.", "originalRequest": { "url": { "path": [ "partners", "tags", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Office — HQ\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"e5f6a7b8-c9d0-1234-efab-345678901234\",\n \"name\": \"Office — HQ\",\n \"tagGroups\": [\n {\n \"id\": \"f6a7b8c9-d0e1-2345-fabc-456789012346\",\n \"name\": \"Department\",\n \"color\": \"#4A90D9\"\n }\n ],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3fc0b2c-a058-4ad5-a56d-69a7d0a6024f", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "tags", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Office — HQ\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "01b6ef68-98ad-4848-b7d6-5d72c57985c4", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "tags", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Office — HQ\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "825314de-552d-46b7-9a8e-dfedcf0a9d5c", "name": "Tag not found.", "originalRequest": { "url": { "path": [ "partners", "tags", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Office — HQ\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "14906e52-74c6-4957-81d4-4c5b701a4291", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "tags", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Office — HQ\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "60b4da47-a440-406e-966e-a069703f0bad", "name": "Deletes a tag and removes all of its associations.", "request": { "name": "Deletes a tag and removes all of its associations.", "description": {}, "url": { "path": [ "partners", "tags", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag UUID to delete." } ] }, "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "ae30e2e5-5f34-4cda-9335-de87e8f4577e", "name": "Tag deleted successfully.", "originalRequest": { "url": { "path": [ "partners", "tags", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "82d92fee-3a00-43ad-9302-c3d1e1cace0a", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "tags", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f0a631b0-a755-4cb4-84e6-7a0b5a21ed34", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "tags", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4656b5f5-5ac0-4f57-88ad-1df8f31d34e9", "name": "Tag not found.", "originalRequest": { "url": { "path": [ "partners", "tags", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "daba5468-584d-42b8-8395-911a406dd6b2", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "tags", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ab66ef0b-9feb-4af5-a350-327f4a1cc72e", "name": "Returns all tag groups and tags not assigned to any group.", "request": { "name": "Returns all tag groups and tags not assigned to any group.", "description": {}, "url": { "path": [ "partners", "tags", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "search", "value": "", "description": "Partial match on group or ungrouped tag names." }, { "disabled": false, "key": "page", "value": "", "description": "Page number for pagination. The first page is 1." }, { "disabled": false, "key": "limit", "value": "", "description": "Records to return per page." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "cb94dc0c-bbf5-487d-8699-3df563cff826", "name": "Tag groups and ungrouped tags.", "originalRequest": { "url": { "path": [ "partners", "tags", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "department" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"tagGroups\": [\n {\n \"id\": \"f6a7b8c9-d0e1-2345-fabc-456789012346\",\n \"name\": \"Department\",\n \"color\": \"#4A90D9\",\n \"tags\": [\n {\n \"id\": \"e5f6a7b8-c9d0-1234-efab-345678901234\",\n \"name\": \"Office\"\n },\n {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567891\",\n \"name\": \"Marketing\"\n }\n ],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n ],\n \"unGroupedTags\": [\n {\n \"id\": \"b2c3d4e5-f6a7-8901-bcde-f23456789012\",\n \"name\": \"Travel\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3254a352-52dd-4bc7-8635-a15bcdc8a4f2", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "tags", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "department" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "25f4ce0d-f170-4a5b-9d36-5009a0e2a07e", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "tags", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "department" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1c3e58b8-1391-440b-917e-f6af9d1d78ff", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "tags", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "search", "value": "department" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a583baa9-42cf-479b-abbd-01f06257ea2f", "name": "Creates a tag group and optionally assigns tags.", "request": { "name": "Creates a tag group and optionally assigns tags.", "description": { "content": "Body requires `name` (unique per workspace). Optional `color` and `tagUuids` (tag UUIDs from list tags). Each tag may belong to at most one group.", "type": "text/plain" }, "url": { "path": [ "partners", "tags", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "19980b59-fd6c-41d2-8374-888ccb844595", "name": "Tag group created successfully.", "originalRequest": { "url": { "path": [ "partners", "tags", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Department\",\n \"color\": \"#4A90D9\",\n \"tagUuids\": [\n \"e5f6a7b8-c9d0-1234-efab-345678901234\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"f6a7b8c9-d0e1-2345-fabc-456789012346\",\n \"name\": \"Department\",\n \"color\": \"#4A90D9\",\n \"tags\": [\n {\n \"id\": \"e5f6a7b8-c9d0-1234-efab-345678901234\",\n \"name\": \"Office\"\n },\n {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567891\",\n \"name\": \"Marketing\"\n }\n ],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1c4e4ac-17e0-4eb7-90c2-27c49c9b43bb", "name": "Duplicate group name or tag already assigned to another group.", "originalRequest": { "url": { "path": [ "partners", "tags", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Department\",\n \"color\": \"#4A90D9\",\n \"tagUuids\": [\n \"e5f6a7b8-c9d0-1234-efab-345678901234\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8274ba5f-e7cb-4292-b17b-5d0502f388c2", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "tags", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Department\",\n \"color\": \"#4A90D9\",\n \"tagUuids\": [\n \"e5f6a7b8-c9d0-1234-efab-345678901234\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c0f489da-d714-4a0f-93a3-b8e7420c2fe7", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "tags", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Department\",\n \"color\": \"#4A90D9\",\n \"tagUuids\": [\n \"e5f6a7b8-c9d0-1234-efab-345678901234\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5d2329cd-6466-40af-a3d8-f21d279dece5", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "tags", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Department\",\n \"color\": \"#4A90D9\",\n \"tagUuids\": [\n \"e5f6a7b8-c9d0-1234-efab-345678901234\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0d554d50-7d08-4ac3-b34e-cf839cb4d74c", "name": "Retrieves a single tag group by UUID with its member tags.", "request": { "name": "Retrieves a single tag group by UUID with its member tags.", "description": {}, "url": { "path": [ "partners", "tags", "groups", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag group UUID." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "d529dfc5-93c9-4810-bf9a-db84ea4570b9", "name": "The requested tag group.", "originalRequest": { "url": { "path": [ "partners", "tags", "groups", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag group UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"f6a7b8c9-d0e1-2345-fabc-456789012346\",\n \"name\": \"Department\",\n \"color\": \"#4A90D9\",\n \"tags\": [\n {\n \"id\": \"e5f6a7b8-c9d0-1234-efab-345678901234\",\n \"name\": \"Office\"\n },\n {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567891\",\n \"name\": \"Marketing\"\n }\n ],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e51a1961-b39e-4159-937f-9f204b73ca1d", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "tags", "groups", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag group UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c70799a3-fd1b-409b-994d-4e0f9e93161f", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "tags", "groups", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag group UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8224793c-9acf-4470-ba4a-3e2e3a4d9071", "name": "Tag group not found.", "originalRequest": { "url": { "path": [ "partners", "tags", "groups", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag group UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c231ab78-86bd-48aa-a488-e3a2245c4beb", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "tags", "groups", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag group UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "431663af-2257-41a5-89bf-a2d117b2ae29", "name": "Updates a tag group name, color, and/or membership.", "request": { "name": "Updates a tag group name, color, and/or membership.", "description": { "content": "When `tagUuids` is sent, membership is replaced with that exact set. Pass `[]` to remove all tags from the group.", "type": "text/plain" }, "url": { "path": [ "partners", "tags", "groups", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag group UUID to update." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fff824c5-8859-42c7-abff-42a3c90e8e7a", "name": "Tag group updated successfully.", "originalRequest": { "url": { "path": [ "partners", "tags", "groups", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag group UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"color\": \"#E48642\",\n \"tagUuids\": [\n \"e5f6a7b8-c9d0-1234-efab-345678901234\",\n \"a1b2c3d4-e5f6-7890-abcd-ef1234567891\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"f6a7b8c9-d0e1-2345-fabc-456789012346\",\n \"name\": \"Department\",\n \"color\": \"#4A90D9\",\n \"tags\": [\n {\n \"id\": \"e5f6a7b8-c9d0-1234-efab-345678901234\",\n \"name\": \"Office\"\n },\n {\n \"id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567891\",\n \"name\": \"Marketing\"\n }\n ],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06325d1f-3f35-44b7-94eb-78c7408914e6", "name": "Duplicate name or tag already in another group.", "originalRequest": { "url": { "path": [ "partners", "tags", "groups", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag group UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"color\": \"#E48642\",\n \"tagUuids\": [\n \"e5f6a7b8-c9d0-1234-efab-345678901234\",\n \"a1b2c3d4-e5f6-7890-abcd-ef1234567891\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ac56d84a-4e5c-473a-a81e-43fba89d384f", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "tags", "groups", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag group UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"color\": \"#E48642\",\n \"tagUuids\": [\n \"e5f6a7b8-c9d0-1234-efab-345678901234\",\n \"a1b2c3d4-e5f6-7890-abcd-ef1234567891\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e4e1e177-3101-447d-a69e-df6dbb0066fb", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "tags", "groups", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag group UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"color\": \"#E48642\",\n \"tagUuids\": [\n \"e5f6a7b8-c9d0-1234-efab-345678901234\",\n \"a1b2c3d4-e5f6-7890-abcd-ef1234567891\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b8b59690-dca8-417b-bd3a-43e0d5fc86e3", "name": "Tag group not found.", "originalRequest": { "url": { "path": [ "partners", "tags", "groups", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag group UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"color\": \"#E48642\",\n \"tagUuids\": [\n \"e5f6a7b8-c9d0-1234-efab-345678901234\",\n \"a1b2c3d4-e5f6-7890-abcd-ef1234567891\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "737b6f45-3e8d-4382-ba75-4e48854f14b0", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "tags", "groups", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag group UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"color\": \"#E48642\",\n \"tagUuids\": [\n \"e5f6a7b8-c9d0-1234-efab-345678901234\",\n \"a1b2c3d4-e5f6-7890-abcd-ef1234567891\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3bc526a0-35ae-4dba-94d8-dbc4b4dc1f82", "name": "Deletes a tag group. Member tags are not deleted.", "request": { "name": "Deletes a tag group. Member tags are not deleted.", "description": {}, "url": { "path": [ "partners", "tags", "groups", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag group UUID to delete." } ] }, "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "5b049fd8-4461-4871-9827-22435da46888", "name": "Tag group deleted successfully.", "originalRequest": { "url": { "path": [ "partners", "tags", "groups", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag group UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "070656ec-b019-43cc-81c6-3977be6e4e3a", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "tags", "groups", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag group UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "027cc1ae-ba90-45c1-b7bd-5be884abdac6", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "tags", "groups", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag group UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "63369ac7-2299-41a6-b28e-d91410fb77e9", "name": "Tag group not found.", "originalRequest": { "url": { "path": [ "partners", "tags", "groups", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag group UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9e0873e9-10de-46dc-861b-f5b739f75ba8", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "tags", "groups", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The tag group UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "8a978d74-2fee-425c-b2d7-9727c4398ee4", "name": "Webhooks", "description": { "content": "Subscribe to workspace events and receive HTTPS POST deliveries when matching records change. Each subscription covers one event type per workspace.", "type": "text/plain" }, "item": [ { "id": "2f6ff98e-08cf-4d86-afa7-234398bf9174", "name": "Returns every webhook subscription for the authorized workspace.", "request": { "name": "Returns every webhook subscription for the authorized workspace.", "description": {}, "url": { "path": [ "partners", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "900c4c9e-face-45ec-a3c2-857f3ad8d125", "name": "Subscriptions returned under data.webhooks.", "originalRequest": { "url": { "path": [ "partners", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"webhooks\": [\n {\n \"uuid\": \"e0f1a2b3-c4d5-6789-ef01-234567890abc\",\n \"event\": \"customer.created\",\n \"callbackUrl\": \"https://webhook.site/your-unique-id\",\n \"status\": \"active\",\n \"createdAt\": \"2026-03-01T09:00:00.000Z\",\n \"updatedAt\": \"2026-03-01T09:00:00.000Z\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8659b3aa-346c-4336-861b-9a995ab28798", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "95473462-5bde-4912-95bf-4bb413f94e79", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4c24ab26-0d2b-4dcf-b377-ad154140ff14", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ba0c0399-0233-4db1-9513-24cd9b443cb2", "name": "Subscribes to a single event type for the workspace.", "request": { "name": "Subscribes to a single event type for the workspace.", "description": { "content": "Provide a public HTTPS callback URL. Optionally set a signing secret for delivery verification. Defaults to status `active`.", "type": "text/plain" }, "url": { "path": [ "partners", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"event\": \"\",\n \"callbackUrl\": \"\",\n \"signingSecret\": \"\",\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "671876c3-a025-4c64-a87a-5acbeeb497cd", "name": "Subscription created. Returned under data.webhook.", "originalRequest": { "url": { "path": [ "partners", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event\": \"customer.created\",\n \"callbackUrl\": \"https://webhook.site/your-unique-id\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"webhook\": {\n \"uuid\": \"e0f1a2b3-c4d5-6789-ef01-234567890abc\",\n \"event\": \"customer.created\",\n \"callbackUrl\": \"https://webhook.site/your-unique-id\",\n \"status\": \"active\",\n \"createdAt\": \"2026-03-01T09:00:00.000Z\",\n \"updatedAt\": \"2026-03-01T09:00:00.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19e90161-b3e7-4386-af45-b0c7dccba9ee", "name": "Invalid callback URL, duplicate event subscription, or validation error.", "originalRequest": { "url": { "path": [ "partners", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event\": \"customer.created\",\n \"callbackUrl\": \"https://webhook.site/your-unique-id\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6b1013a9-587b-40ae-91fe-8acae5126fee", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event\": \"customer.created\",\n \"callbackUrl\": \"https://webhook.site/your-unique-id\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e1d717b3-a9ef-43a3-a19e-80931d43948d", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event\": \"customer.created\",\n \"callbackUrl\": \"https://webhook.site/your-unique-id\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1c1b3857-c8b8-46d5-8eba-1c29e5c4b73d", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event\": \"customer.created\",\n \"callbackUrl\": \"https://webhook.site/your-unique-id\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6a913396-0813-4aea-8c69-4d7f2656d662", "name": "Updates callback URL, status, or signing secret for an existing subscription.", "request": { "name": "Updates callback URL, status, or signing secret for an existing subscription.", "description": {}, "url": { "path": [ "partners", "webhooks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Subscription UUID." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"callbackUrl\": \"\",\n \"status\": \"\",\n \"signingSecret\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "07bb3072-1371-4edc-84e1-6db3a046bcac", "name": "Subscription updated. Returned under data.webhook.", "originalRequest": { "url": { "path": [ "partners", "webhooks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Subscription UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"paused\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"webhook\": {\n \"uuid\": \"e0f1a2b3-c4d5-6789-ef01-234567890abc\",\n \"event\": \"customer.created\",\n \"callbackUrl\": \"https://webhook.site/your-unique-id\",\n \"status\": \"paused\",\n \"createdAt\": \"2026-03-01T09:00:00.000Z\",\n \"updatedAt\": \"2026-03-01T09:00:00.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a0ba5ea-3df4-4813-b166-c53d05bbcf4f", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "webhooks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Subscription UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"paused\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "523c3626-9f2f-4992-bd0e-ae132f79f13f", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "webhooks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Subscription UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"paused\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "074732b7-e08e-42b0-830d-2bfcc88730c7", "name": "Subscription not found for this workspace.", "originalRequest": { "url": { "path": [ "partners", "webhooks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Subscription UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"paused\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1af0241e-098b-4aae-9941-915d5be3ec89", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "webhooks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Subscription UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"paused\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ecff9095-423b-4eb4-84f6-ee954b8a0a1c", "name": "Removes a webhook subscription. Deliveries stop immediately.", "request": { "name": "Removes a webhook subscription. Deliveries stop immediately.", "description": {}, "url": { "path": [ "partners", "webhooks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Subscription UUID." } ] }, "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "76269e7f-8ce2-45c7-81ca-985c623dd18f", "name": "Subscription deleted.", "originalRequest": { "url": { "path": [ "partners", "webhooks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Subscription UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a6cbc530-63ee-41dc-9e11-14836d3a6d9d", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "webhooks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Subscription UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9948bfd6-b4e6-4af0-9a1a-d924b8284896", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "webhooks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Subscription UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f5993ef3-91ed-4b27-ac76-2c69e0f19e34", "name": "Subscription not found for this workspace.", "originalRequest": { "url": { "path": [ "partners", "webhooks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Subscription UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "850e230e-1caa-4be3-be4e-849262c8710b", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "webhooks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Subscription UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "4ad93a22-1cdf-493b-8ad4-c5be9eeb6148", "name": "Documents", "description": { "content": "Upload, list, update, and delete files in a workspace document library. Large files use a chunked upload flow. Partner responses omit internal storage paths and download URLs.", "type": "text/plain" }, "item": [ { "id": "38dc62f6-f558-4dc6-b0e2-747c1fede125", "name": "Returns a paginated list of documents with optional UUID filters.", "request": { "name": "Returns a paginated list of documents with optional UUID filters.", "description": {}, "url": { "path": [ "partners", "documents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Page number for pagination. The first page is 1." }, { "disabled": false, "key": "limit", "value": "", "description": "Records to return per page." }, { "disabled": false, "key": "vendorUuids", "value": "", "description": "Comma-separated vendor UUIDs to filter by." }, { "disabled": false, "key": "customerUuids", "value": "", "description": "Comma-separated customer UUIDs to filter by." }, { "disabled": false, "key": "personUuids", "value": "", "description": "Comma-separated person UUIDs to filter by." }, { "disabled": false, "key": "projectUuids", "value": "", "description": "Comma-separated project UUIDs to filter by." }, { "disabled": false, "key": "startDate", "value": "", "description": "Filter documents created on or after this date." }, { "disabled": false, "key": "endDate", "value": "", "description": "Filter documents created on or before this date." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "fe39a14c-217a-496d-9165-28b993a950cf", "name": "Paginated document list.", "originalRequest": { "url": { "path": [ "partners", "documents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "vendorUuids", "value": "" }, { "key": "customerUuids", "value": "" }, { "key": "personUuids", "value": "" }, { "key": "projectUuids", "value": "" }, { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"page\": 1,\n \"limit\": 20,\n \"totalRecords\": 1,\n \"totalPages\": 1,\n \"records\": [\n {\n \"id\": \"d9e0f1a2-b3c4-5678-def0-890123456789\",\n \"fileName\": \"contract-acme-2026.pdf\",\n \"folderPath\": \"Contracts\",\n \"mimeType\": \"application/pdf\",\n \"fileSize\": 245760,\n \"vendor\": null,\n \"customer\": {\n \"id\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\"\n },\n \"person\": null,\n \"project\": null,\n \"createdAt\": \"2026-03-01T09:00:00.000Z\",\n \"updatedAt\": \"2026-03-01T09:00:00.000Z\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d8642ff-33ea-44c7-a5ce-8da74c4dfdfb", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "documents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "vendorUuids", "value": "" }, { "key": "customerUuids", "value": "" }, { "key": "personUuids", "value": "" }, { "key": "projectUuids", "value": "" }, { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ed08f332-c30b-4b5b-a030-a3fc66bf94a7", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "documents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "vendorUuids", "value": "" }, { "key": "customerUuids", "value": "" }, { "key": "personUuids", "value": "" }, { "key": "projectUuids", "value": "" }, { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "70a5fd9b-e96d-4427-b761-6a9b978c928f", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "documents" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "vendorUuids", "value": "" }, { "key": "customerUuids", "value": "" }, { "key": "personUuids", "value": "" }, { "key": "projectUuids", "value": "" }, { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "12669b83-aec2-4543-b623-0ec90a843965", "name": "Uploads a file via multipart form data.", "request": { "name": "Uploads a file via multipart form data.", "description": { "content": "Send multipart/form-data with a `file` field. Optional text fields: folderPath, vendorUuid, customerUuid, personUuid, projectUuid. Sign the request with an empty-object body hash.", "type": "text/plain" }, "url": { "path": [ "partners", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "6a01193c-b8e7-482e-98d2-910f88fa8296", "name": "Document created.", "originalRequest": { "url": { "path": [ "partners", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"id\": \"d9e0f1a2-b3c4-5678-def0-890123456789\",\n \"fileName\": \"contract-acme-2026.pdf\",\n \"folderPath\": \"Contracts\",\n \"mimeType\": \"application/pdf\",\n \"fileSize\": 245760,\n \"vendor\": null,\n \"customer\": {\n \"id\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\"\n },\n \"person\": null,\n \"project\": null,\n \"createdAt\": \"2026-03-01T09:00:00.000Z\",\n \"updatedAt\": \"2026-03-01T09:00:00.000Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73cdac99-563e-4f18-803d-01aeafa50596", "name": "Missing file or validation error.", "originalRequest": { "url": { "path": [ "partners", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "15a66f8f-a2ba-424c-9795-34990c56a813", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a65af6bb-a003-4dda-b7de-fcafb7dc9654", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "92d77c99-7cdf-4844-8921-5348df0de865", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3f0668ac-d423-4fd3-a90d-cbb1159db153", "name": "Returns a single document by UUID.", "request": { "name": "Returns a single document by UUID.", "description": {}, "url": { "path": [ "partners", "documents", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Document UUID." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "157ecdac-d281-4a76-8817-999348a95aa2", "name": "Document returned under data.", "originalRequest": { "url": { "path": [ "partners", "documents", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Document UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"id\": \"d9e0f1a2-b3c4-5678-def0-890123456789\",\n \"fileName\": \"contract-acme-2026.pdf\",\n \"folderPath\": \"Contracts\",\n \"mimeType\": \"application/pdf\",\n \"fileSize\": 245760,\n \"vendor\": null,\n \"customer\": {\n \"id\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\"\n },\n \"person\": null,\n \"project\": null,\n \"createdAt\": \"2026-03-01T09:00:00.000Z\",\n \"updatedAt\": \"2026-03-01T09:00:00.000Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9bf1729-513d-440c-80fb-99f0ee6d2978", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "documents", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Document UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d707135d-eed7-4e09-82e8-5f62b2b73f83", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "documents", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Document UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "01da124b-e33d-461d-bfcc-228f2acb618c", "name": "Document not found.", "originalRequest": { "url": { "path": [ "partners", "documents", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Document UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "13dba83e-b497-49a9-8706-f3962f8d8668", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "documents", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Document UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "237f5096-6ba0-452d-9733-76767b185680", "name": "Updates document metadata and link fields.", "request": { "name": "Updates document metadata and link fields.", "description": {}, "url": { "path": [ "partners", "documents", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Document UUID." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"folderPath\": \"\",\n \"vendorUuid\": \"\",\n \"customerUuid\": \"\",\n \"personUuid\": \"\",\n \"projectUuid\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c9386450-2e7e-488d-b8f2-177f1cc71127", "name": "Document updated.", "originalRequest": { "url": { "path": [ "partners", "documents", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Document UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"folderPath\": \"Contracts/2026\",\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"id\": \"d9e0f1a2-b3c4-5678-def0-890123456789\",\n \"fileName\": \"contract-acme-2026.pdf\",\n \"folderPath\": \"Contracts/2026\",\n \"mimeType\": \"application/pdf\",\n \"fileSize\": 245760,\n \"vendor\": null,\n \"customer\": {\n \"id\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\"\n },\n \"person\": null,\n \"project\": null,\n \"createdAt\": \"2026-03-01T09:00:00.000Z\",\n \"updatedAt\": \"2026-03-01T09:00:00.000Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82d19174-43fe-44ac-9a5f-b6f533b29b05", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "documents", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Document UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"folderPath\": \"Contracts/2026\",\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5001ebf1-eaac-4fb3-a5f7-6d878c7a3f89", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "documents", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Document UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"folderPath\": \"Contracts/2026\",\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eba38112-7cee-47c5-8a08-060fbf100cb4", "name": "Document not found.", "originalRequest": { "url": { "path": [ "partners", "documents", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Document UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"folderPath\": \"Contracts/2026\",\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "69263afa-63db-42c9-80c5-62ee4750a791", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "documents", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Document UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"folderPath\": \"Contracts/2026\",\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "77a662d7-7594-4236-b207-c9e98daf3acd", "name": "Deletes the document blob and database row.", "request": { "name": "Deletes the document blob and database row.", "description": { "content": "Blocked for Period Close system roots and Bank Statements/ paths.", "type": "text/plain" }, "url": { "path": [ "partners", "documents", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Document UUID." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "162a0f12-a235-41e3-8699-860ecdcfd05e", "name": "Document deleted.", "originalRequest": { "url": { "path": [ "partners", "documents", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Document UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Document deleted.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f6dbf11-6b62-4f4b-a719-fd451fd421c3", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "documents", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Document UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "38b0ef57-7ea7-4425-b49e-7971afd81565", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "documents", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Document UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7d8c14d7-3a21-4e75-b051-927e7fb644a1", "name": "Document not found.", "originalRequest": { "url": { "path": [ "partners", "documents", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Document UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c4eb54eb-7ed4-45fa-bbce-5c8905f92dff", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "documents", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Document UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3fbdb7a3-23a5-4cb0-a49b-d0b1a7b305dd", "name": "Starts a chunked upload session for a large file.", "request": { "name": "Starts a chunked upload session for a large file.", "description": {}, "url": { "path": [ "partners", "documents", "chunk-upload", "initiate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"fileName\": \"\",\n \"folderPath\": \"\",\n \"fileSize\": \"\",\n \"chunkSizeInMB\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2b0844a8-4a47-4421-9142-9abe76d86b42", "name": "Returns uploadProgressId and chunk configuration.", "originalRequest": { "url": { "path": [ "partners", "documents", "chunk-upload", "initiate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fileName\": \"contract-acme-2026.pdf\",\n \"folderPath\": \"Contracts\",\n \"fileSize\": 5242880,\n \"chunkSizeInMB\": 5\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"uploadProgressId\": \"upload-progress-uuid\",\n \"chunkSizeInBytes\": 5242880,\n \"totalChunks\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d697e460-4c1c-478c-b6ae-a20832956f0d", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "documents", "chunk-upload", "initiate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fileName\": \"contract-acme-2026.pdf\",\n \"folderPath\": \"Contracts\",\n \"fileSize\": 5242880,\n \"chunkSizeInMB\": 5\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "89b3ec28-e57d-4fe6-8f28-69a5c947f786", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "documents", "chunk-upload", "initiate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fileName\": \"contract-acme-2026.pdf\",\n \"folderPath\": \"Contracts\",\n \"fileSize\": 5242880,\n \"chunkSizeInMB\": 5\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "da4d71b3-24eb-4796-b30d-7baf18f6e6c5", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "documents", "chunk-upload", "initiate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"fileName\": \"contract-acme-2026.pdf\",\n \"folderPath\": \"Contracts\",\n \"fileSize\": 5242880,\n \"chunkSizeInMB\": 5\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "220dd7d3-da1f-4aca-b4f4-fc68761ef9db", "name": "Uploads a single chunk of a multipart upload.", "request": { "name": "Uploads a single chunk of a multipart upload.", "description": { "content": "Send multipart/form-data with `file`, `blockId`, and `uploadProgressId`. Sign with empty-object body hash.", "type": "text/plain" }, "url": { "path": [ "partners", "documents", "chunk-upload", "chunk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"file\": \"\",\n \"blockId\": \"\",\n \"uploadProgressId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d50371f5-ab8a-439f-8d1e-025435f4ebe4", "name": "Chunk accepted.", "originalRequest": { "url": { "path": [ "partners", "documents", "chunk-upload", "chunk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file\": \"\",\n \"blockId\": \"\",\n \"uploadProgressId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"blockId\": \"block-1\",\n \"uploaded\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f36dc97c-4293-4af7-9a9c-00d4018d9ab3", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "documents", "chunk-upload", "chunk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file\": \"\",\n \"blockId\": \"\",\n \"uploadProgressId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ea33432b-861b-47e5-b174-08e9a7defd32", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "documents", "chunk-upload", "chunk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file\": \"\",\n \"blockId\": \"\",\n \"uploadProgressId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2a1289b0-4a8c-4721-9136-abd1cbe69bab", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "documents", "chunk-upload", "chunk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"file\": \"\",\n \"blockId\": \"\",\n \"uploadProgressId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "32be9a4e-fd36-4e0c-8d1b-fa5e21382b50", "name": "Finalizes a chunked upload and creates the document record.", "request": { "name": "Finalizes a chunked upload and creates the document record.", "description": {}, "url": { "path": [ "partners", "documents", "chunk-upload", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"uploadProgressId\": \"\",\n \"blockIds\": [],\n \"vendorUuid\": \"\",\n \"customerUuid\": \"\",\n \"personUuid\": \"\",\n \"projectUuid\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e804f783-b6e0-47ac-8fba-2f50eb2316d1", "name": "Document created from assembled chunks.", "originalRequest": { "url": { "path": [ "partners", "documents", "chunk-upload", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"uploadProgressId\": \"upload-progress-uuid\",\n \"blockIds\": [\n \"block-1\",\n \"block-2\"\n ],\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"id\": \"d9e0f1a2-b3c4-5678-def0-890123456789\",\n \"fileName\": \"contract-acme-2026.pdf\",\n \"folderPath\": \"Contracts\",\n \"mimeType\": \"application/pdf\",\n \"fileSize\": 245760,\n \"vendor\": null,\n \"customer\": {\n \"id\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\"\n },\n \"person\": null,\n \"project\": null,\n \"createdAt\": \"2026-03-01T09:00:00.000Z\",\n \"updatedAt\": \"2026-03-01T09:00:00.000Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a41548a-4a8d-43ff-9bbf-3aac0a7d696d", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "documents", "chunk-upload", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"uploadProgressId\": \"upload-progress-uuid\",\n \"blockIds\": [\n \"block-1\",\n \"block-2\"\n ],\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b880456b-c383-46a0-bc6d-fdf73db53b03", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "documents", "chunk-upload", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"uploadProgressId\": \"upload-progress-uuid\",\n \"blockIds\": [\n \"block-1\",\n \"block-2\"\n ],\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7d8655e7-991b-4951-877b-bab9ed4ef648", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "documents", "chunk-upload", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"uploadProgressId\": \"upload-progress-uuid\",\n \"blockIds\": [\n \"block-1\",\n \"block-2\"\n ],\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1ffbde1a-87c7-40e1-880f-7b7951593789", "name": "Returns progress for an in-flight chunked upload.", "request": { "name": "Returns progress for an in-flight chunked upload.", "description": {}, "url": { "path": [ "partners", "documents", "chunk-upload", "progress", ":uploadProgressId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uploadProgressId", "description": "(Required) Upload session identifier from initiate." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "792ebc96-0893-4b2f-92ff-c062c564cbd6", "name": "Upload progress details.", "originalRequest": { "url": { "path": [ "partners", "documents", "chunk-upload", "progress", ":uploadProgressId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uploadProgressId", "description": "(Required) Upload session identifier from initiate." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"uploadProgressId\": \"upload-progress-uuid\",\n \"uploadedChunks\": 1,\n \"totalChunks\": 1,\n \"percentComplete\": 100\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7466e6d4-6485-4b6a-a1cd-322a5ae01d31", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "documents", "chunk-upload", "progress", ":uploadProgressId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uploadProgressId", "description": "(Required) Upload session identifier from initiate." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eeee7c2f-27b6-411b-8ab3-e8ce45e0a423", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "documents", "chunk-upload", "progress", ":uploadProgressId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uploadProgressId", "description": "(Required) Upload session identifier from initiate." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a2907fc2-7e01-484a-bf53-09a961bae6ec", "name": "Upload session not found.", "originalRequest": { "url": { "path": [ "partners", "documents", "chunk-upload", "progress", ":uploadProgressId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uploadProgressId", "description": "(Required) Upload session identifier from initiate." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "69f5ffcb-d976-4972-9539-0220b817278e", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "documents", "chunk-upload", "progress", ":uploadProgressId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uploadProgressId", "description": "(Required) Upload session identifier from initiate." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "36795ffd-64c0-448e-b583-6c77ee1120b5", "name": "People", "description": { "content": "People are workspace members — employees, contractors, and other payroll or expense-reporting contacts. Partner responses expose UUIDs as `id` and omit internal numeric foreign keys.", "type": "text/plain" }, "item": [ { "id": "cd31ce11-77a4-4909-9479-8dd26152df8f", "name": "Returns a paginated list of people in the workspace.", "request": { "name": "Returns a paginated list of people in the workspace.", "description": { "content": "People are returned with optional nested associations (address, primary job, department). Soft-deleted people are excluded.", "type": "text/plain" }, "url": { "path": [ "partners", "people" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Page number for pagination. The first page is 1." }, { "disabled": false, "key": "limit", "value": "", "description": "Records to return per page." }, { "disabled": false, "key": "search", "value": "", "description": "Partial, case-insensitive match on first name, last name, email, and phone." }, { "disabled": false, "key": "type", "value": "", "description": "Filter by people type (for example employee, contractor). Also supports `1099 contractor`." }, { "disabled": false, "key": "enabled", "value": "", "description": "Filter by active/inactive status." }, { "disabled": false, "key": "roles", "value": "", "description": "Comma-separated roles; matches people whose role array contains any listed role." }, { "disabled": false, "key": "payrollEnabled", "value": "", "description": "When true, returns people with the payroll role." }, { "disabled": false, "key": "createdByMe", "value": "", "description": "When true, returns only people created by the authenticated user." }, { "disabled": false, "key": "isNotExpenseReporter", "value": "", "description": "When true, excludes people who are already expense reporters." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "38a2c15f-ff15-4db1-a038-f6e42b71a44e", "name": "Paginated list of people.", "originalRequest": { "url": { "path": [ "partners", "people" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "jane" }, { "key": "type", "value": "" }, { "key": "enabled", "value": "" }, { "key": "roles", "value": "" }, { "key": "payrollEnabled", "value": "" }, { "key": "createdByMe", "value": "" }, { "key": "isNotExpenseReporter", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"people\": [\n {\n \"id\": \"f1a2b3c4-d5e6-4789-a012-3456789abcde\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"email\": \"jane.smith@acme.com\",\n \"phone\": \"+19876543210\",\n \"type\": \"employee\",\n \"enabled\": true,\n \"role\": [\n \"payroll\"\n ],\n \"paymentUnit\": \"hourly\",\n \"rate\": 45,\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n ],\n \"page\": 1,\n \"limit\": 20,\n \"totalRecords\": 1,\n \"totalPages\": 1,\n \"filters\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1ff5cc0-88a3-42ef-be06-dad33696c53d", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "people" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "jane" }, { "key": "type", "value": "" }, { "key": "enabled", "value": "" }, { "key": "roles", "value": "" }, { "key": "payrollEnabled", "value": "" }, { "key": "createdByMe", "value": "" }, { "key": "isNotExpenseReporter", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e5647e55-525e-4be6-a458-87924fa6c1e5", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "people" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "jane" }, { "key": "type", "value": "" }, { "key": "enabled", "value": "" }, { "key": "roles", "value": "" }, { "key": "payrollEnabled", "value": "" }, { "key": "createdByMe", "value": "" }, { "key": "isNotExpenseReporter", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c0d8c867-f807-48c6-9360-3bc4f753469d", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "people" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "jane" }, { "key": "type", "value": "" }, { "key": "enabled", "value": "" }, { "key": "roles", "value": "" }, { "key": "payrollEnabled", "value": "" }, { "key": "createdByMe", "value": "" }, { "key": "isNotExpenseReporter", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "051e7127-39dd-42c7-9e62-927f42e89164", "name": "Retrieves a single person by UUID.", "request": { "name": "Retrieves a single person by UUID.", "description": {}, "url": { "path": [ "partners", "people", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The person UUID as returned in list responses." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "c38d4384-5b35-42e2-be61-0b9fac11cedf", "name": "The requested person.", "originalRequest": { "url": { "path": [ "partners", "people", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The person UUID as returned in list responses." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on fetching people data.\",\n \"data\": {\n \"people\": {\n \"id\": \"f1a2b3c4-d5e6-4789-a012-3456789abcde\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"email\": \"jane.smith@acme.com\",\n \"phone\": \"+19876543210\",\n \"type\": \"employee\",\n \"enabled\": true,\n \"role\": [\n \"payroll\"\n ],\n \"paymentUnit\": \"hourly\",\n \"rate\": 45,\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "947799b5-e4b5-4749-a950-5cd8276a729e", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "people", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The person UUID as returned in list responses." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0da4cc67-fd47-45ce-8432-f4c1860582b1", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "people", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The person UUID as returned in list responses." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e88e758f-9067-412b-a2d2-9fd2299afeea", "name": "Person not found.", "originalRequest": { "url": { "path": [ "partners", "people", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The person UUID as returned in list responses." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0069dc3a-85fd-4a71-a5a0-6552169a9e60", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "people", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) The person UUID as returned in list responses." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "84b4fb32-9738-4e85-ba0a-799a3ad7cf21", "name": "Projects", "description": { "content": "Projects group work for a customer with a status, schedule, and associated tasks. Partner responses use UUIDs; numeric `customerId` and `statusId` fields are stripped.", "type": "text/plain" }, "item": [ { "id": "a242ca6d-4927-498c-9249-1d8da738ca6b", "name": "Returns the project statuses available in the workspace.", "request": { "name": "Returns the project statuses available in the workspace.", "description": { "content": "Each status includes its UUID, name, color, and ordering. Use the UUID as `statusUuid` on create/update or in `statusUuids` list filters.", "type": "text/plain" }, "url": { "path": [ "partners", "projects", "statuses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "77fef951-6cd9-437b-ac66-956f637fa31b", "name": "Workspace project statuses.", "originalRequest": { "url": { "path": [ "partners", "projects", "statuses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on fetching project statuses\",\n \"data\": {\n \"statuses\": [\n {\n \"uuid\": \"aabbccdd-eeff-4012-8000-001122334455\",\n \"name\": \"In Progress\",\n \"color\": \"#E48642\",\n \"order\": 1,\n \"isDefault\": false\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa754629-8997-4ea5-b59b-c052b190e84e", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "projects", "statuses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6cb3cc27-eb02-423e-b53e-fb6c57b92c01", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "projects", "statuses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f2d7d96d-222c-42c1-91ed-b056c5b87748", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "projects", "statuses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2bfa1992-695b-4eac-accf-dfb005fac8b2", "name": "Returns a paginated list of projects.", "request": { "name": "Returns a paginated list of projects.", "description": { "content": "Soft-deleted projects are excluded. Filter by customer, status, and name search.", "type": "text/plain" }, "url": { "path": [ "partners", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Page number for pagination. The first page is 1." }, { "disabled": false, "key": "limit", "value": "", "description": "Records to return per page." }, { "disabled": false, "key": "search", "value": "", "description": "Partial, case-insensitive match on project name." }, { "disabled": false, "key": "customerUuids", "value": "", "description": "Comma-separated customer UUIDs to filter by." }, { "disabled": false, "key": "statusUuids", "value": "", "description": "Comma-separated project-status UUIDs to filter by." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "f9d8394c-3a1b-43b8-9492-ede323e4aef2", "name": "Paginated list of projects.", "originalRequest": { "url": { "path": [ "partners", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "website" }, { "key": "customerUuids", "value": "dfa3219e-6af8-4c53-997a-037534f63a35" }, { "key": "statusUuids", "value": "aabbccdd-eeff-4012-8000-001122334455" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on fetching projects\",\n \"data\": {\n \"projects\": [\n {\n \"id\": \"11223344-5566-7788-99aa-bbccddeeff00\",\n \"name\": \"Website Redesign\",\n \"description\": \"Redesign the marketing website for Acme Corporation.\",\n \"customId\": \"PRJ-2026-001\",\n \"startDate\": \"2026-02-01\",\n \"endDate\": \"2026-06-30\",\n \"customer\": {\n \"uuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\"\n },\n \"projectStatus\": {\n \"uuid\": \"aabbccdd-eeff-4012-8000-001122334455\",\n \"name\": \"In Progress\",\n \"color\": \"#E48642\"\n },\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n ],\n \"page\": 1,\n \"limit\": 20,\n \"totalRecords\": 1,\n \"totalPages\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bbae685-9416-4d20-8811-e474e6aeb579", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "website" }, { "key": "customerUuids", "value": "dfa3219e-6af8-4c53-997a-037534f63a35" }, { "key": "statusUuids", "value": "aabbccdd-eeff-4012-8000-001122334455" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6f8d2d90-b5a0-46ff-aded-ce15c49b4be4", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "website" }, { "key": "customerUuids", "value": "dfa3219e-6af8-4c53-997a-037534f63a35" }, { "key": "statusUuids", "value": "aabbccdd-eeff-4012-8000-001122334455" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8660fcc1-206f-4ff2-af14-9f23044bc29c", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "projects" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "website" }, { "key": "customerUuids", "value": "dfa3219e-6af8-4c53-997a-037534f63a35" }, { "key": "statusUuids", "value": "aabbccdd-eeff-4012-8000-001122334455" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "56be1fe7-6832-4fd8-b28a-df340246619b", "name": "Creates a new project in the workspace.", "request": { "name": "Creates a new project in the workspace.", "description": { "content": "Only `name` is required. `statusUuid` defaults to the workspace default status when omitted. Numeric `customerId`, `statusId`, and `teamId` are stripped — use UUID fields.", "type": "text/plain" }, "url": { "path": [ "partners", "projects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"customerUuid\": \"\",\n \"statusUuid\": \"\",\n \"description\": \"\",\n \"customId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "10e71754-e67a-443d-9ec5-0032b31973b2", "name": "Project created successfully.", "originalRequest": { "url": { "path": [ "partners", "projects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Website Redesign\",\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"statusUuid\": \"aabbccdd-eeff-4012-8000-001122334455\",\n \"description\": \"Redesign the marketing website for Acme Corporation.\",\n \"startDate\": \"2026-02-01\",\n \"endDate\": \"2026-06-30\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on creating project\",\n \"data\": {\n \"project\": {\n \"id\": \"11223344-5566-7788-99aa-bbccddeeff00\",\n \"name\": \"Website Redesign\",\n \"description\": \"Redesign the marketing website for Acme Corporation.\",\n \"customId\": \"PRJ-2026-001\",\n \"startDate\": \"2026-02-01\",\n \"endDate\": \"2026-06-30\",\n \"customer\": {\n \"uuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\"\n },\n \"projectStatus\": {\n \"uuid\": \"aabbccdd-eeff-4012-8000-001122334455\",\n \"name\": \"In Progress\",\n \"color\": \"#E48642\"\n },\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ce1c254-c903-4844-977d-fc46e4e206b2", "name": "Validation failed — for example missing name.", "originalRequest": { "url": { "path": [ "partners", "projects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Website Redesign\",\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"statusUuid\": \"aabbccdd-eeff-4012-8000-001122334455\",\n \"description\": \"Redesign the marketing website for Acme Corporation.\",\n \"startDate\": \"2026-02-01\",\n \"endDate\": \"2026-06-30\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7e286419-5c19-473b-8053-db5f635eef19", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "projects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Website Redesign\",\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"statusUuid\": \"aabbccdd-eeff-4012-8000-001122334455\",\n \"description\": \"Redesign the marketing website for Acme Corporation.\",\n \"startDate\": \"2026-02-01\",\n \"endDate\": \"2026-06-30\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eb99bb83-4d62-488c-b68a-81cdaa010093", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "projects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Website Redesign\",\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"statusUuid\": \"aabbccdd-eeff-4012-8000-001122334455\",\n \"description\": \"Redesign the marketing website for Acme Corporation.\",\n \"startDate\": \"2026-02-01\",\n \"endDate\": \"2026-06-30\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "979cb2f5-b90a-418b-b654-5892ab902641", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "projects" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Website Redesign\",\n \"customerUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"statusUuid\": \"aabbccdd-eeff-4012-8000-001122334455\",\n \"description\": \"Redesign the marketing website for Acme Corporation.\",\n \"startDate\": \"2026-02-01\",\n \"endDate\": \"2026-06-30\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6cb1db5a-0c9b-4d9f-8c2f-78577565f0c8", "name": "Returns tasks attached to a project.", "request": { "name": "Returns tasks attached to a project.", "description": { "content": "Returns the same partner-sanitized task envelope as List tasks.", "type": "text/plain" }, "url": { "path": [ "partners", "projects", ":uuid", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Page number for pagination. The first page is 1." }, { "disabled": false, "key": "limit", "value": "", "description": "Records to return per page." }, { "disabled": false, "key": "search", "value": "", "description": "Partial, case-insensitive match on task name." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Project UUID." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "4deb7708-8026-415c-a838-a1c1d3be3be8", "name": "Paginated list of tasks for the project.", "originalRequest": { "url": { "path": [ "partners", "projects", ":uuid", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Project UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on fetching project tasks\",\n \"data\": {\n \"tasks\": [\n {\n \"id\": \"22334455-6677-8899-aabb-ccddeeff0011\",\n \"name\": \"Review wireframes\",\n \"type\": \"INTERNAL_TASK\",\n \"priority\": \"medium\",\n \"deadline\": \"2026-04-15\",\n \"visibility\": \"firm-team\",\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n ],\n \"page\": 1,\n \"limit\": 20,\n \"totalRecords\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a6ad011-6f58-4eca-9381-17760e3187a1", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "projects", ":uuid", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Project UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2fc5aec0-61e5-4492-804b-8b8cce0d5dd5", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "projects", ":uuid", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Project UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8b06fee8-7577-46cd-a363-494ed8b4d5aa", "name": "Project not found.", "originalRequest": { "url": { "path": [ "partners", "projects", ":uuid", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Project UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a4bc307f-774f-4231-9cbc-a9fdb49c4c67", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "projects", ":uuid", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Project UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "79031cc0-550f-4517-a8cf-4ed32bca01d2", "name": "Retrieves a single project by UUID.", "request": { "name": "Retrieves a single project by UUID.", "description": {}, "url": { "path": [ "partners", "projects", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Project UUID." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "7fc83c81-db59-4f76-ab5a-c91d25461c6e", "name": "The requested project.", "originalRequest": { "url": { "path": [ "partners", "projects", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Project UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on fetching project\",\n \"data\": {\n \"project\": {\n \"id\": \"11223344-5566-7788-99aa-bbccddeeff00\",\n \"name\": \"Website Redesign\",\n \"description\": \"Redesign the marketing website for Acme Corporation.\",\n \"customId\": \"PRJ-2026-001\",\n \"startDate\": \"2026-02-01\",\n \"endDate\": \"2026-06-30\",\n \"customer\": {\n \"uuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\"\n },\n \"projectStatus\": {\n \"uuid\": \"aabbccdd-eeff-4012-8000-001122334455\",\n \"name\": \"In Progress\",\n \"color\": \"#E48642\"\n },\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d25109f5-985e-443d-8513-3c8696196cca", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "projects", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Project UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "041e4be6-fc12-479a-bfc3-8d64837fabd6", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "projects", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Project UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "33209a96-ca30-46ad-b484-d591a4d06795", "name": "Project not found or soft-deleted.", "originalRequest": { "url": { "path": [ "partners", "projects", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Project UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3e13d544-3835-4875-9ce3-ce3a80e610cb", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "projects", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Project UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "462c5600-4d8c-4e15-9655-2a47c991afd3", "name": "Updates an existing project. Only the fields you send are changed.", "request": { "name": "Updates an existing project. Only the fields you send are changed.", "description": { "content": "Pass `customerUuid` as a UUID to set the customer, `null` or empty string to clear, or omit to leave unchanged. `statusUuid` sets the status when provided.", "type": "text/plain" }, "url": { "path": [ "partners", "projects", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Project UUID to update." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"customerUuid\": \"\",\n \"statusUuid\": \"\",\n \"description\": \"\",\n \"customId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3a7d4fa2-9dab-4dcf-8bcf-6e9e770ff704", "name": "Project updated successfully.", "originalRequest": { "url": { "path": [ "partners", "projects", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Project UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"Updated scope — includes mobile responsive design.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on updating project\",\n \"data\": {\n \"project\": {\n \"id\": \"11223344-5566-7788-99aa-bbccddeeff00\",\n \"name\": \"Website Redesign\",\n \"description\": \"Updated scope — includes mobile responsive design.\",\n \"customId\": \"PRJ-2026-001\",\n \"startDate\": \"2026-02-01\",\n \"endDate\": \"2026-06-30\",\n \"customer\": {\n \"uuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\"\n },\n \"projectStatus\": {\n \"uuid\": \"aabbccdd-eeff-4012-8000-001122334455\",\n \"name\": \"In Progress\",\n \"color\": \"#E48642\"\n },\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f19c352-8202-4110-a3ed-48c1e54fcab3", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "projects", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Project UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"Updated scope — includes mobile responsive design.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "078a0531-845d-4aab-8da2-9ccf76784f08", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "projects", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Project UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"Updated scope — includes mobile responsive design.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ff329576-b776-455b-a03a-79ce02ee6231", "name": "Project not found.", "originalRequest": { "url": { "path": [ "partners", "projects", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Project UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"Updated scope — includes mobile responsive design.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "95a86b9b-bee4-482d-8377-bb9eb9a133fc", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "projects", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Project UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"Updated scope — includes mobile responsive design.\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3f57441c-e88c-4a30-af8e-ec4c005c3fcb", "name": "Soft-deletes a project.", "request": { "name": "Soft-deletes a project.", "description": {}, "url": { "path": [ "partners", "projects", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Project UUID to delete." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "fa297bbc-c6d6-4d63-8a89-ea1b11f3979c", "name": "Project deleted successfully.", "originalRequest": { "url": { "path": [ "partners", "projects", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Project UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on deleting project\",\n \"data\": {\n \"result\": {\n \"deleted\": true\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0bdefe4-4a51-4501-ba39-7abbef571eac", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "projects", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Project UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9fd8f8c7-94c7-436d-a00e-92a5f19a7966", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "projects", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Project UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "75e53ac5-0b51-4164-b181-eca170eb803c", "name": "Project not found.", "originalRequest": { "url": { "path": [ "partners", "projects", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Project UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c8973936-584e-4b12-8a83-7769e6bc631f", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "projects", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Project UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ad588a1e-7480-47f1-9406-11ee95b60826", "name": "Tasks", "description": { "content": "Tasks are units of work with assignees, statuses, deadlines, and optional project links. Partner responses expose UUIDs; numeric foreign keys on the task root are stripped.", "type": "text/plain" }, "item": [ { "id": "7ce11bc6-e3f0-4339-924a-c34a5dad3ec0", "name": "Returns a paginated list of tasks.", "request": { "name": "Returns a paginated list of tasks.", "description": {}, "url": { "path": [ "partners", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Page number for pagination. The first page is 1." }, { "disabled": false, "key": "limit", "value": "", "description": "Records to return per page." }, { "disabled": false, "key": "search", "value": "", "description": "Partial, case-insensitive match on task name." }, { "disabled": false, "key": "orderBy", "value": "", "description": "Field to sort by." }, { "disabled": false, "key": "orderDirection", "value": "", "description": "Sort direction." }, { "disabled": false, "key": "visibility", "value": "", "description": "Comma-separated visibility values. Defaults to firm-team and team-only when omitted." }, { "disabled": false, "key": "priority", "value": "", "description": "Filter by priority." }, { "disabled": false, "key": "statusId", "value": "", "description": "Comma-separated status UUIDs or workspace-scoped numeric ids." }, { "disabled": false, "key": "assigneeId", "value": "", "description": "Comma-separated assignee UUIDs or workspace-scoped numeric ids." }, { "disabled": false, "key": "projects", "value": "", "description": "Comma-separated project UUIDs or workspace-scoped numeric ids." }, { "disabled": false, "key": "overduesOnly", "value": "", "description": "When true, returns only overdue tasks." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "19ca771b-e3c4-45f5-a03d-f4586412caf6", "name": "Paginated list of tasks.", "originalRequest": { "url": { "path": [ "partners", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "" }, { "key": "orderBy", "value": "" }, { "key": "orderDirection", "value": "" }, { "key": "visibility", "value": "firm-team,team-only" }, { "key": "priority", "value": "" }, { "key": "statusId", "value": "" }, { "key": "assigneeId", "value": "" }, { "key": "projects", "value": "" }, { "key": "overduesOnly", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on fetching tasks\",\n \"data\": {\n \"tasks\": [\n {\n \"id\": \"22334455-6677-8899-aabb-ccddeeff0011\",\n \"name\": \"Review wireframes\",\n \"type\": \"INTERNAL_TASK\",\n \"description\": \"Review and approve wireframes before development.\",\n \"priority\": \"medium\",\n \"deadline\": \"2026-04-15\",\n \"customId\": \"TASK-1042\",\n \"visibility\": \"firm-team\",\n \"assignee\": {\n \"uuid\": \"f1a2b3c4-d5e6-4789-a012-3456789abcde\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\"\n },\n \"project\": {\n \"uuid\": \"11223344-5566-7788-99aa-bbccddeeff00\",\n \"name\": \"Website Redesign\"\n },\n \"tags\": [],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n ],\n \"page\": 1,\n \"limit\": 20,\n \"totalRecords\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3079d7ae-17d6-4982-a7e3-eae9c445e311", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "" }, { "key": "orderBy", "value": "" }, { "key": "orderDirection", "value": "" }, { "key": "visibility", "value": "firm-team,team-only" }, { "key": "priority", "value": "" }, { "key": "statusId", "value": "" }, { "key": "assigneeId", "value": "" }, { "key": "projects", "value": "" }, { "key": "overduesOnly", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b3e4fd16-aa7b-4d0e-9d1c-1e60669a725c", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "" }, { "key": "orderBy", "value": "" }, { "key": "orderDirection", "value": "" }, { "key": "visibility", "value": "firm-team,team-only" }, { "key": "priority", "value": "" }, { "key": "statusId", "value": "" }, { "key": "assigneeId", "value": "" }, { "key": "projects", "value": "" }, { "key": "overduesOnly", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c7253672-4d96-448e-b76e-c330f1d593af", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "search", "value": "" }, { "key": "orderBy", "value": "" }, { "key": "orderDirection", "value": "" }, { "key": "visibility", "value": "firm-team,team-only" }, { "key": "priority", "value": "" }, { "key": "statusId", "value": "" }, { "key": "assigneeId", "value": "" }, { "key": "projects", "value": "" }, { "key": "overduesOnly", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5a757f39-43f1-4536-9e5d-172103e92b69", "name": "Creates a new task.", "request": { "name": "Creates a new task.", "description": { "content": "Required body field: `type`. If `assigneeId` is omitted, the partner-acting user is assigned. JSON only — no file attachments.", "type": "text/plain" }, "url": { "path": [ "partners", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"priority\": \"\",\n \"deadline\": \"\",\n \"customId\": \"\",\n \"visibility\": \"\",\n \"assigneeId\": \"\",\n \"statusId\": \"\",\n \"projectId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b6b12807-0907-49ec-95a9-8bd09975e825", "name": "Task created successfully.", "originalRequest": { "url": { "path": [ "partners", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"INTERNAL_TASK\",\n \"name\": \"Review wireframes\",\n \"description\": \"Review and approve wireframes before development.\",\n \"priority\": \"medium\",\n \"deadline\": \"2026-04-15\",\n \"assigneeId\": \"f1a2b3c4-d5e6-4789-a012-3456789abcde\",\n \"projectId\": \"11223344-5566-7788-99aa-bbccddeeff00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on creating task\",\n \"data\": {\n \"task\": {\n \"id\": \"22334455-6677-8899-aabb-ccddeeff0011\",\n \"name\": \"Review wireframes\",\n \"type\": \"INTERNAL_TASK\",\n \"description\": \"Review and approve wireframes before development.\",\n \"priority\": \"medium\",\n \"deadline\": \"2026-04-15\",\n \"customId\": \"TASK-1042\",\n \"visibility\": \"firm-team\",\n \"assignee\": {\n \"uuid\": \"f1a2b3c4-d5e6-4789-a012-3456789abcde\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\"\n },\n \"project\": {\n \"uuid\": \"11223344-5566-7788-99aa-bbccddeeff00\",\n \"name\": \"Website Redesign\"\n },\n \"tags\": [],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75192ba8-2ef7-44c3-93e7-46b7d4ce4ee1", "name": "Validation failed — for example missing type or mixed tag id kinds.", "originalRequest": { "url": { "path": [ "partners", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"INTERNAL_TASK\",\n \"name\": \"Review wireframes\",\n \"description\": \"Review and approve wireframes before development.\",\n \"priority\": \"medium\",\n \"deadline\": \"2026-04-15\",\n \"assigneeId\": \"f1a2b3c4-d5e6-4789-a012-3456789abcde\",\n \"projectId\": \"11223344-5566-7788-99aa-bbccddeeff00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ede1e24c-3d55-4451-acf6-28070bb4c4b1", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"INTERNAL_TASK\",\n \"name\": \"Review wireframes\",\n \"description\": \"Review and approve wireframes before development.\",\n \"priority\": \"medium\",\n \"deadline\": \"2026-04-15\",\n \"assigneeId\": \"f1a2b3c4-d5e6-4789-a012-3456789abcde\",\n \"projectId\": \"11223344-5566-7788-99aa-bbccddeeff00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ee7e9807-9fe9-4c2e-a107-be7fe3fd01fa", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"INTERNAL_TASK\",\n \"name\": \"Review wireframes\",\n \"description\": \"Review and approve wireframes before development.\",\n \"priority\": \"medium\",\n \"deadline\": \"2026-04-15\",\n \"assigneeId\": \"f1a2b3c4-d5e6-4789-a012-3456789abcde\",\n \"projectId\": \"11223344-5566-7788-99aa-bbccddeeff00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fdaed4c7-bc3a-4f6f-aa21-5f582082fd0a", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "tasks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"INTERNAL_TASK\",\n \"name\": \"Review wireframes\",\n \"description\": \"Review and approve wireframes before development.\",\n \"priority\": \"medium\",\n \"deadline\": \"2026-04-15\",\n \"assigneeId\": \"f1a2b3c4-d5e6-4789-a012-3456789abcde\",\n \"projectId\": \"11223344-5566-7788-99aa-bbccddeeff00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d796e66b-065e-4aa9-a050-ef67877769d6", "name": "Retrieves a single task by UUID.", "request": { "name": "Retrieves a single task by UUID.", "description": { "content": "Firm-only tasks (including INTERNAL_TASK) return 404 unless you pass `visibility=firm-only` in the query string.", "type": "text/plain" }, "url": { "path": [ "partners", "tasks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "visibility", "value": "", "description": "Include firm-only tasks when set to firm-only." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Task UUID." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "2bb89d4a-d984-44f3-9b66-3f29b287b06a", "name": "The requested task.", "originalRequest": { "url": { "path": [ "partners", "tasks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "visibility", "value": "firm-only" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Task UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on fetching task\",\n \"data\": {\n \"task\": {\n \"id\": \"22334455-6677-8899-aabb-ccddeeff0011\",\n \"name\": \"Review wireframes\",\n \"type\": \"INTERNAL_TASK\",\n \"description\": \"Review and approve wireframes before development.\",\n \"priority\": \"medium\",\n \"deadline\": \"2026-04-15\",\n \"customId\": \"TASK-1042\",\n \"visibility\": \"firm-team\",\n \"assignee\": {\n \"uuid\": \"f1a2b3c4-d5e6-4789-a012-3456789abcde\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\"\n },\n \"project\": {\n \"uuid\": \"11223344-5566-7788-99aa-bbccddeeff00\",\n \"name\": \"Website Redesign\"\n },\n \"tags\": [],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6871b680-0749-435e-bb47-cc75bfeb056a", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "tasks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "visibility", "value": "firm-only" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Task UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "93e5d71e-1183-46be-9938-32bed3245f4f", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "tasks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "visibility", "value": "firm-only" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Task UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6b6960a2-34e6-45bf-950a-638329c8267a", "name": "Task not found or not visible with default visibility.", "originalRequest": { "url": { "path": [ "partners", "tasks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "visibility", "value": "firm-only" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Task UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "abb648b3-7930-49e1-99eb-7cbf6b59bd2b", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "tasks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "visibility", "value": "firm-only" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Task UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e1129126-b44e-4dc1-b087-311579bbe8f0", "name": "Updates an existing task. Only the fields you send are changed.", "request": { "name": "Updates an existing task. Only the fields you send are changed.", "description": {}, "url": { "path": [ "partners", "tasks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Task UUID to update." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"priority\": \"\",\n \"deadline\": \"\",\n \"assigneeId\": \"\",\n \"statusId\": \"\",\n \"projectId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8f831ad2-9989-4448-ab1b-b60ecf82d869", "name": "Task updated successfully.", "originalRequest": { "url": { "path": [ "partners", "tasks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Task UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"priority\": \"high\",\n \"deadline\": \"2026-04-01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on updating task\",\n \"data\": {\n \"task\": {\n \"id\": \"22334455-6677-8899-aabb-ccddeeff0011\",\n \"name\": \"Review wireframes\",\n \"type\": \"INTERNAL_TASK\",\n \"description\": \"Review and approve wireframes before development.\",\n \"priority\": \"high\",\n \"deadline\": \"2026-04-01\",\n \"customId\": \"TASK-1042\",\n \"visibility\": \"firm-team\",\n \"assignee\": {\n \"uuid\": \"f1a2b3c4-d5e6-4789-a012-3456789abcde\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\"\n },\n \"project\": {\n \"uuid\": \"11223344-5566-7788-99aa-bbccddeeff00\",\n \"name\": \"Website Redesign\"\n },\n \"tags\": [],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e6a0e29-2f40-4143-bd42-89f676c3e755", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "tasks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Task UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"priority\": \"high\",\n \"deadline\": \"2026-04-01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6deb0519-8b0d-4d41-ab0f-f1164a89c796", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "tasks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Task UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"priority\": \"high\",\n \"deadline\": \"2026-04-01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3051de47-dbb8-4e43-8e44-21a7ad4d4412", "name": "Task not found.", "originalRequest": { "url": { "path": [ "partners", "tasks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Task UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"priority\": \"high\",\n \"deadline\": \"2026-04-01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e7916a55-624b-4083-9ebb-e33ec36a9600", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "tasks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Task UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"priority\": \"high\",\n \"deadline\": \"2026-04-01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "85d917f3-2a02-458a-8ca2-93603a5f921b", "name": "Deletes a task by UUID.", "request": { "name": "Deletes a task by UUID.", "description": {}, "url": { "path": [ "partners", "tasks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Task UUID to delete." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "839daa36-779f-42ec-9e8f-fefe65b75d4b", "name": "Task deleted successfully.", "originalRequest": { "url": { "path": [ "partners", "tasks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Task UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on deleting task\",\n \"data\": {\n \"result\": {\n \"deleted\": true\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7bf945f1-c5d7-4d02-a39c-2eeb8440e22d", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "tasks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Task UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d7be2d58-155c-496e-8481-3edb5b7f5f34", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "tasks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Task UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c8edae75-f068-4d0e-9503-0c5758356193", "name": "Task not found.", "originalRequest": { "url": { "path": [ "partners", "tasks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Task UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "03222adb-3256-47c4-9a39-78b1b0af6559", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "tasks", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Task UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "e9685880-0061-4e45-aa69-dbf668fa42d5", "name": "Time Entries", "description": { "content": "Time entries record minutes logged by a person against projects, customers, and billable services. Partner responses use UUIDs; entries in processed pay periods are read-only.", "type": "text/plain" }, "item": [ { "id": "90a93ff4-6501-4870-be6c-4ee53ec4221d", "name": "Returns a paginated list of time entries.", "request": { "name": "Returns a paginated list of time entries.", "description": { "content": "Soft-deleted entries are excluded. Default limit is 50.", "type": "text/plain" }, "url": { "path": [ "partners", "time-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Page number for pagination. The first page is 1." }, { "disabled": false, "key": "limit", "value": "", "description": "Records to return per page." }, { "disabled": false, "key": "peopleUuids", "value": "", "description": "Comma-separated person UUIDs." }, { "disabled": false, "key": "projectUuids", "value": "", "description": "Comma-separated project UUIDs." }, { "disabled": false, "key": "customerUuids", "value": "", "description": "Comma-separated customer UUIDs." }, { "disabled": false, "key": "productServiceUuids", "value": "", "description": "Comma-separated product or service UUIDs." }, { "disabled": false, "key": "startDate", "value": "", "description": "Range start (YYYY-MM-DD). Must be paired with endDate." }, { "disabled": false, "key": "endDate", "value": "", "description": "Range end (YYYY-MM-DD). Must be paired with startDate." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "074be518-df45-41c6-871c-824517948f38", "name": "Paginated list of time entries.", "originalRequest": { "url": { "path": [ "partners", "time-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "peopleUuids", "value": "f1a2b3c4-d5e6-4789-a012-3456789abcde" }, { "key": "projectUuids", "value": "11223344-5566-7788-99aa-bbccddeeff00" }, { "key": "customerUuids", "value": "dfa3219e-6af8-4c53-997a-037534f63a35" }, { "key": "productServiceUuids", "value": "aa11bb22-cc33-dd44-ee55-ff6677889900" }, { "key": "startDate", "value": "2026-03-01" }, { "key": "endDate", "value": "2026-03-31" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on fetching time entries\",\n \"data\": {\n \"timeEntries\": [\n {\n \"id\": \"33445566-7788-99aa-bbcc-ddeeff001122\",\n \"date\": \"2026-03-15\",\n \"minutes\": 120,\n \"description\": \"Wireframe review session\",\n \"billable\": true,\n \"wage\": 45,\n \"people\": {\n \"uuid\": \"f1a2b3c4-d5e6-4789-a012-3456789abcde\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\"\n },\n \"project\": {\n \"uuid\": \"11223344-5566-7788-99aa-bbccddeeff00\",\n \"name\": \"Website Redesign\"\n },\n \"customer\": {\n \"uuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\"\n },\n \"productService\": {\n \"uuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Consulting services\"\n },\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n ],\n \"page\": 1,\n \"limit\": 50,\n \"totalRecords\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a9d3224-ba31-418b-8489-3a0f7578433c", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "time-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "peopleUuids", "value": "f1a2b3c4-d5e6-4789-a012-3456789abcde" }, { "key": "projectUuids", "value": "11223344-5566-7788-99aa-bbccddeeff00" }, { "key": "customerUuids", "value": "dfa3219e-6af8-4c53-997a-037534f63a35" }, { "key": "productServiceUuids", "value": "aa11bb22-cc33-dd44-ee55-ff6677889900" }, { "key": "startDate", "value": "2026-03-01" }, { "key": "endDate", "value": "2026-03-31" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d29c5d26-61ac-4962-9c23-718f25b255a9", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "time-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "peopleUuids", "value": "f1a2b3c4-d5e6-4789-a012-3456789abcde" }, { "key": "projectUuids", "value": "11223344-5566-7788-99aa-bbccddeeff00" }, { "key": "customerUuids", "value": "dfa3219e-6af8-4c53-997a-037534f63a35" }, { "key": "productServiceUuids", "value": "aa11bb22-cc33-dd44-ee55-ff6677889900" }, { "key": "startDate", "value": "2026-03-01" }, { "key": "endDate", "value": "2026-03-31" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3edbd2c8-6559-466a-89f5-ab5f16f64490", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "time-entries" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" }, { "key": "peopleUuids", "value": "f1a2b3c4-d5e6-4789-a012-3456789abcde" }, { "key": "projectUuids", "value": "11223344-5566-7788-99aa-bbccddeeff00" }, { "key": "customerUuids", "value": "dfa3219e-6af8-4c53-997a-037534f63a35" }, { "key": "productServiceUuids", "value": "aa11bb22-cc33-dd44-ee55-ff6677889900" }, { "key": "startDate", "value": "2026-03-01" }, { "key": "endDate", "value": "2026-03-31" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fee2efb8-eb04-43da-96a2-19ef529f540a", "name": "Creates one or more time entry rows for a person.", "request": { "name": "Creates one or more time entry rows for a person.", "description": { "content": "Required: `peopleUuid` and `timeEntries` array. Each row needs `date` (YYYY-MM-DD) and `minutes`. Setting `projectUuid` may auto-fill the matching customer.", "type": "text/plain" }, "url": { "path": [ "partners", "time-entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"peopleUuid\": \"\",\n \"timeEntries\": [\n {\n \"date\": \"\",\n \"minutes\": \"\",\n \"description\": \"\",\n \"projectUuid\": \"\",\n \"customerUuid\": \"\",\n \"productServiceUuid\": \"\",\n \"billable\": \"\",\n \"wage\": \"\"\n },\n {\n \"date\": \"\",\n \"minutes\": \"\",\n \"description\": \"\",\n \"projectUuid\": \"\",\n \"customerUuid\": \"\",\n \"productServiceUuid\": \"\",\n \"billable\": \"\",\n \"wage\": \"\"\n }\n ],\n \"projectUuid\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1fac3e71-7c0a-4f85-88c4-772533eb66f5", "name": "Time entries created successfully.", "originalRequest": { "url": { "path": [ "partners", "time-entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"peopleUuid\": \"f1a2b3c4-d5e6-4789-a012-3456789abcde\",\n \"projectUuid\": \"11223344-5566-7788-99aa-bbccddeeff00\",\n \"timeEntries\": [\n {\n \"date\": \"2026-03-15\",\n \"minutes\": 120,\n \"description\": \"Wireframe review session\",\n \"billable\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Time entry created successfully\",\n \"data\": {\n \"timeEntry\": {\n \"id\": \"33445566-7788-99aa-bbcc-ddeeff001122\",\n \"date\": \"2026-03-15\",\n \"minutes\": 120,\n \"description\": \"Wireframe review session\",\n \"billable\": true,\n \"wage\": 45,\n \"people\": {\n \"uuid\": \"f1a2b3c4-d5e6-4789-a012-3456789abcde\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\"\n },\n \"project\": {\n \"uuid\": \"11223344-5566-7788-99aa-bbccddeeff00\",\n \"name\": \"Website Redesign\"\n },\n \"customer\": {\n \"uuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\"\n },\n \"productService\": {\n \"uuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Consulting services\"\n },\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97d8b582-26a8-40d8-ba6a-6ad7b47d3655", "name": "Validation failed — for example daily minutes cap exceeded or missing peopleUuid.", "originalRequest": { "url": { "path": [ "partners", "time-entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"peopleUuid\": \"f1a2b3c4-d5e6-4789-a012-3456789abcde\",\n \"projectUuid\": \"11223344-5566-7788-99aa-bbccddeeff00\",\n \"timeEntries\": [\n {\n \"date\": \"2026-03-15\",\n \"minutes\": 120,\n \"description\": \"Wireframe review session\",\n \"billable\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "07a79e6d-6c19-4952-9b73-900a7da4fe66", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "time-entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"peopleUuid\": \"f1a2b3c4-d5e6-4789-a012-3456789abcde\",\n \"projectUuid\": \"11223344-5566-7788-99aa-bbccddeeff00\",\n \"timeEntries\": [\n {\n \"date\": \"2026-03-15\",\n \"minutes\": 120,\n \"description\": \"Wireframe review session\",\n \"billable\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cfe62f7e-320a-4b7d-900b-6a44e1888522", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "time-entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"peopleUuid\": \"f1a2b3c4-d5e6-4789-a012-3456789abcde\",\n \"projectUuid\": \"11223344-5566-7788-99aa-bbccddeeff00\",\n \"timeEntries\": [\n {\n \"date\": \"2026-03-15\",\n \"minutes\": 120,\n \"description\": \"Wireframe review session\",\n \"billable\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "866bdd61-60d7-411a-8456-f5308d7dc688", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "time-entries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"peopleUuid\": \"f1a2b3c4-d5e6-4789-a012-3456789abcde\",\n \"projectUuid\": \"11223344-5566-7788-99aa-bbccddeeff00\",\n \"timeEntries\": [\n {\n \"date\": \"2026-03-15\",\n \"minutes\": 120,\n \"description\": \"Wireframe review session\",\n \"billable\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2e798962-d814-4cd3-8be6-6718941d84cd", "name": "Retrieves a single time entry by UUID.", "request": { "name": "Retrieves a single time entry by UUID.", "description": {}, "url": { "path": [ "partners", "time-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Time entry UUID." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "ac975b4c-0b73-46bb-b599-ec047c85301d", "name": "The requested time entry.", "originalRequest": { "url": { "path": [ "partners", "time-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Time entry UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Time entry found successfully\",\n \"data\": {\n \"timeEntry\": {\n \"id\": \"33445566-7788-99aa-bbcc-ddeeff001122\",\n \"date\": \"2026-03-15\",\n \"minutes\": 120,\n \"description\": \"Wireframe review session\",\n \"billable\": true,\n \"wage\": 45,\n \"people\": {\n \"uuid\": \"f1a2b3c4-d5e6-4789-a012-3456789abcde\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\"\n },\n \"project\": {\n \"uuid\": \"11223344-5566-7788-99aa-bbccddeeff00\",\n \"name\": \"Website Redesign\"\n },\n \"customer\": {\n \"uuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\"\n },\n \"productService\": {\n \"uuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Consulting services\"\n },\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "056373c2-ec9d-44d7-9a00-2ca5773416b5", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "time-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Time entry UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "543a91be-f85b-4c7c-af1a-f1456f54b5fe", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "time-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Time entry UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "841d2e09-7d5b-4c9d-9b12-a7f0ee2f331a", "name": "Time entry not found or soft-deleted.", "originalRequest": { "url": { "path": [ "partners", "time-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Time entry UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "35d68ce6-0f73-414e-88fe-a896d48cbbb7", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "time-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Time entry UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "80fb8c4b-1241-4156-b03f-0074463aa952", "name": "Updates an existing time entry. Only the fields you send are changed.", "request": { "name": "Updates an existing time entry. Only the fields you send are changed.", "description": { "content": "Entries in processed pay periods return 400. `projectUuid`, `customerUuid`, and `productServiceUuid` accept a UUID to set or null to clear.", "type": "text/plain" }, "url": { "path": [ "partners", "time-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Time entry UUID to update." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"minutes\": \"\",\n \"description\": \"\",\n \"date\": \"\",\n \"billable\": \"\",\n \"wage\": \"\",\n \"projectUuid\": \"\",\n \"customerUuid\": \"\",\n \"productServiceUuid\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d11ed143-8c5f-4eff-9d77-eb6c1ee1f03b", "name": "Time entry updated successfully.", "originalRequest": { "url": { "path": [ "partners", "time-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Time entry UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"minutes\": 90,\n \"description\": \"Extended review session\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Time entry updated successfully\",\n \"data\": {\n \"timeEntry\": {\n \"id\": \"33445566-7788-99aa-bbcc-ddeeff001122\",\n \"date\": \"2026-03-15\",\n \"minutes\": 90,\n \"description\": \"Wireframe review session\",\n \"billable\": true,\n \"wage\": 45,\n \"people\": {\n \"uuid\": \"f1a2b3c4-d5e6-4789-a012-3456789abcde\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\"\n },\n \"project\": {\n \"uuid\": \"11223344-5566-7788-99aa-bbccddeeff00\",\n \"name\": \"Website Redesign\"\n },\n \"customer\": {\n \"uuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\"\n },\n \"productService\": {\n \"uuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"description\": \"Consulting services\"\n },\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08e4f167-14ab-409d-9f18-9f2e12a9e6df", "name": "Entry is in a processed pay period or validation failed.", "originalRequest": { "url": { "path": [ "partners", "time-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Time entry UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"minutes\": 90,\n \"description\": \"Extended review session\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4b8c10b0-d428-4bbf-bb88-682b21cfc8b0", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "time-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Time entry UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"minutes\": 90,\n \"description\": \"Extended review session\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "73289758-2bd2-49a1-b7b8-6fd1a58e4758", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "time-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Time entry UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"minutes\": 90,\n \"description\": \"Extended review session\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aa6b3086-e92c-4dff-b451-f0936df97256", "name": "Time entry not found.", "originalRequest": { "url": { "path": [ "partners", "time-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Time entry UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"minutes\": 90,\n \"description\": \"Extended review session\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f0624328-1923-431b-839b-da8f9f9f3907", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "time-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Time entry UUID to update." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"minutes\": 90,\n \"description\": \"Extended review session\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25899e43-d910-48fe-aeeb-ee113d05b797", "name": "Soft-deletes a time entry.", "request": { "name": "Soft-deletes a time entry.", "description": { "content": "Entries in processed pay periods cannot be deleted and return 400.", "type": "text/plain" }, "url": { "path": [ "partners", "time-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Time entry UUID to delete." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "51b753cd-39b4-414f-9418-ae517d445246", "name": "Time entry deleted successfully.", "originalRequest": { "url": { "path": [ "partners", "time-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Time entry UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Time entry deleted successfully\",\n \"data\": {\n \"result\": {\n \"deleted\": true\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1382396d-3331-4f51-abe7-63fa0f8b3f67", "name": "Entry is in a processed pay period.", "originalRequest": { "url": { "path": [ "partners", "time-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Time entry UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "643a59b9-1353-4802-97b5-faeb19538722", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "time-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Time entry UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b91f1101-1d63-4e5d-a36e-72629b598afb", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "time-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Time entry UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3db843f4-3f3c-4f54-9bc5-45ffb0eb5fce", "name": "Time entry not found.", "originalRequest": { "url": { "path": [ "partners", "time-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Time entry UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "36b83128-a31d-4d36-97dd-ad8d747f2f38", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "time-entries", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Time entry UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "9605c30b-9bb0-459f-8b6f-dc682fa8751d", "name": "Expense Receipts", "description": { "content": "Expense receipts (pending receipts) capture out-of-pocket expenses before they are matched to bank transactions. Upload receipt images via multipart form data; API responses omit receiptUrl by design.", "type": "text/plain" }, "item": [ { "id": "03158007-51b1-4dc7-820b-a7a737b2a1dc", "name": "Returns a paginated list of expense receipts.", "request": { "name": "Returns a paginated list of expense receipts.", "description": {}, "url": { "path": [ "partners", "expense-receipts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Page number for pagination. The first page is 1." }, { "disabled": false, "key": "limit", "value": "", "description": "Records to return per page." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "8096ab5f-334d-451d-83da-78b6911f673f", "name": "Paginated list of expense receipts.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on fetching pending receipts\",\n \"data\": {\n \"pendingReceipts\": [\n {\n \"id\": \"44556677-8899-aabb-ccdd-eeff00112233\",\n \"amount\": 45.99,\n \"currency\": \"USD\",\n \"date\": \"2026-03-01\",\n \"description\": \"Team lunch\",\n \"matched\": false,\n \"receiptSplited\": false,\n \"account\": {\n \"uuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"name\": \"Business Checking\"\n },\n \"categoryAccount\": {\n \"uuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"name\": \"Meals & Entertainment\"\n },\n \"vendor\": null,\n \"project\": {\n \"uuid\": \"11223344-5566-7788-99aa-bbccddeeff00\",\n \"name\": \"Website Redesign\"\n },\n \"customer\": {\n \"uuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\"\n },\n \"tags\": [],\n \"taxes\": [],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n ],\n \"page\": 1,\n \"limit\": 20,\n \"totalRecords\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f96c4eb-5959-4731-9d6a-d459031986d5", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bb4efd7a-2b26-4304-8587-af4437d49440", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ec06a124-6442-4cb4-b790-ab6af919ee38", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6000cb34-3ed9-4a10-9f5d-6b32e7e2cf15", "name": "Creates an expense receipt, optionally with a receipt image.", "request": { "name": "Creates an expense receipt, optionally with a receipt image.", "description": { "content": "Send multipart/form-data with optional `receipt` file field plus text fields for metadata. UUID fields: accountUuid, categoryAccountUuid, expenseReportTypeUuid, vendorUuid, projectUuid, tagUuids (comma-separated), taxUuids (comma-separated).", "type": "text/plain" }, "url": { "path": [ "partners", "expense-receipts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"receipt\": \"\",\n \"amount\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"accountUuid\": \"\",\n \"categoryAccountUuid\": \"\",\n \"expenseReportTypeUuid\": \"\",\n \"vendorUuid\": \"\",\n \"projectUuid\": \"\",\n \"tagUuids\": \"\",\n \"taxUuids\": \"\",\n \"receiptSplited\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "92110729-ae42-4b8e-996e-28c7eb26dafb", "name": "Expense receipt created.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 45.99,\n \"date\": \"2026-03-01\",\n \"description\": \"Team lunch\",\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"projectUuid\": \"11223344-5566-7788-99aa-bbccddeeff00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on creating pending receipt\",\n \"data\": {\n \"pendingReceipt\": {\n \"id\": \"44556677-8899-aabb-ccdd-eeff00112233\",\n \"amount\": 45.99,\n \"currency\": \"USD\",\n \"date\": \"2026-03-01\",\n \"description\": \"Team lunch\",\n \"matched\": false,\n \"receiptSplited\": false,\n \"account\": {\n \"uuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"name\": \"Business Checking\"\n },\n \"categoryAccount\": {\n \"uuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"name\": \"Meals & Entertainment\"\n },\n \"vendor\": null,\n \"project\": {\n \"uuid\": \"11223344-5566-7788-99aa-bbccddeeff00\",\n \"name\": \"Website Redesign\"\n },\n \"customer\": {\n \"uuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\"\n },\n \"tags\": [],\n \"taxes\": [],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e81948ee-a64e-4241-b298-90e7747142d9", "name": "Validation failed or split amounts do not balance.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 45.99,\n \"date\": \"2026-03-01\",\n \"description\": \"Team lunch\",\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"projectUuid\": \"11223344-5566-7788-99aa-bbccddeeff00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8daf6919-521b-4cc8-9371-058fb6536258", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 45.99,\n \"date\": \"2026-03-01\",\n \"description\": \"Team lunch\",\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"projectUuid\": \"11223344-5566-7788-99aa-bbccddeeff00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c90d535d-82a4-4c40-8f46-ef148431fee2", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 45.99,\n \"date\": \"2026-03-01\",\n \"description\": \"Team lunch\",\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"projectUuid\": \"11223344-5566-7788-99aa-bbccddeeff00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "35a407ae-6390-4072-8776-a87226afade4", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 45.99,\n \"date\": \"2026-03-01\",\n \"description\": \"Team lunch\",\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"categoryAccountUuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"projectUuid\": \"11223344-5566-7788-99aa-bbccddeeff00\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7ee26289-eca4-43a8-9de2-394bfb7a1849", "name": "Returns expense receipts that are not yet matched to a transaction.", "request": { "name": "Returns expense receipts that are not yet matched to a transaction.", "description": {}, "url": { "path": [ "partners", "expense-receipts", "unmatched" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "Page number for pagination. The first page is 1." }, { "disabled": false, "key": "limit", "value": "", "description": "Records to return per page." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "303a36f2-963f-46f6-ac5d-d1d67991931d", "name": "Paginated list of unmatched receipts.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", "unmatched" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on fetching unmatched receipts\",\n \"data\": {\n \"pendingReceipts\": [\n {\n \"id\": \"44556677-8899-aabb-ccdd-eeff00112233\",\n \"amount\": 45.99,\n \"currency\": \"USD\",\n \"date\": \"2026-03-01\",\n \"description\": \"Team lunch\",\n \"matched\": false,\n \"receiptSplited\": false,\n \"account\": {\n \"uuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"name\": \"Business Checking\"\n },\n \"categoryAccount\": {\n \"uuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"name\": \"Meals & Entertainment\"\n },\n \"vendor\": null,\n \"project\": {\n \"uuid\": \"11223344-5566-7788-99aa-bbccddeeff00\",\n \"name\": \"Website Redesign\"\n },\n \"customer\": {\n \"uuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\"\n },\n \"tags\": [],\n \"taxes\": [],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n ],\n \"page\": 1,\n \"limit\": 20,\n \"totalRecords\": 1\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "105b9814-4c10-46b6-8ff2-7cdfafe3c696", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", "unmatched" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9e777162-4003-4ff2-a754-197a847e3f66", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", "unmatched" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b66f1414-6195-4969-95be-8e560da9aa72", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", "unmatched" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "20" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f00397d2-ee94-4f81-9215-f29db1e04dd3", "name": "Updates an unmatched expense receipt.", "request": { "name": "Updates an unmatched expense receipt.", "description": { "content": "Accepts multipart/form-data. Pass a new `receipt` file to replace the image. Returns 400 when the receipt is already matched.", "type": "text/plain" }, "url": { "path": [ "partners", "expense-receipts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"receipt\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"categoryAccountUuid\": \"\",\n \"vendorUuid\": \"\",\n \"projectUuid\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fdeafe22-539f-4ef0-831e-d2e7e3564539", "name": "Expense receipt updated.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"amount\": 52.5,\n \"description\": \"Team lunch (updated total)\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on updating pending receipt\",\n \"data\": {\n \"pendingReceipt\": {\n \"id\": \"44556677-8899-aabb-ccdd-eeff00112233\",\n \"amount\": 52.5,\n \"currency\": \"USD\",\n \"date\": \"2026-03-01\",\n \"description\": \"Team lunch\",\n \"matched\": false,\n \"receiptSplited\": false,\n \"account\": {\n \"uuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"name\": \"Business Checking\"\n },\n \"categoryAccount\": {\n \"uuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"name\": \"Meals & Entertainment\"\n },\n \"vendor\": null,\n \"project\": {\n \"uuid\": \"11223344-5566-7788-99aa-bbccddeeff00\",\n \"name\": \"Website Redesign\"\n },\n \"customer\": {\n \"uuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\"\n },\n \"tags\": [],\n \"taxes\": [],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57a2e805-ab5c-43f2-b228-358c1151728c", "name": "Receipt is already matched.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"amount\": 52.5,\n \"description\": \"Team lunch (updated total)\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3ab1cf85-52c0-4e13-b036-3cbd62599fcd", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"amount\": 52.5,\n \"description\": \"Team lunch (updated total)\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0b9c37d2-6f8e-4076-bdef-2e251b9e2d77", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"amount\": 52.5,\n \"description\": \"Team lunch (updated total)\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bff0c5fd-5a0e-4372-9751-2f28b39194e1", "name": "Expense receipt not found.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"amount\": 52.5,\n \"description\": \"Team lunch (updated total)\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "358bd1c2-521e-443b-ae62-8289b5ee8155", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"amount\": 52.5,\n \"description\": \"Team lunch (updated total)\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0ae33576-db55-4309-90b1-27b4c7a8a3e7", "name": "Deletes an unmatched expense receipt.", "request": { "name": "Deletes an unmatched expense receipt.", "description": {}, "url": { "path": [ "partners", "expense-receipts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID to delete." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "bc11e037-db5c-4c2d-b2fc-2ba3a5275187", "name": "Expense receipt deleted.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on deleting pending receipt\",\n \"data\": {\n \"result\": {\n \"deleted\": true\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "203e071d-ba84-40f6-b08b-ff9695a0940c", "name": "Receipt is already matched.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "21043157-dc63-4063-90f1-90dcd9eb116d", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "115d3817-191e-45b0-845e-97103f48c5e6", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "52b9de27-d532-4dd0-ae40-49d3d6ddb8ad", "name": "Expense receipt not found.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "52e045ea-d617-4914-bd11-9f9ca82cd69b", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID to delete." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "473ac26e-38eb-45e1-a6ed-a6741bdfd976", "name": "Links an expense receipt to an expense transaction.", "request": { "name": "Links an expense receipt to an expense transaction.", "description": {}, "url": { "path": [ "partners", "expense-receipts", ":uuid", "match-manually" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID to match." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"transactionUuid\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "25bec0db-51ed-4844-a74e-4653cfce1fea", "name": "Receipt matched to transaction.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", ":uuid", "match-manually" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID to match." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactionUuid\": \"b7c8d9e0-f1a2-3456-bcde-678901234567\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on matching receipt\",\n \"data\": {\n \"pendingReceipt\": {\n \"id\": \"44556677-8899-aabb-ccdd-eeff00112233\",\n \"amount\": 45.99,\n \"currency\": \"USD\",\n \"date\": \"2026-03-01\",\n \"description\": \"Team lunch\",\n \"matched\": true,\n \"receiptSplited\": false,\n \"account\": {\n \"uuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"name\": \"Business Checking\"\n },\n \"categoryAccount\": {\n \"uuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"name\": \"Meals & Entertainment\"\n },\n \"vendor\": null,\n \"project\": {\n \"uuid\": \"11223344-5566-7788-99aa-bbccddeeff00\",\n \"name\": \"Website Redesign\"\n },\n \"customer\": {\n \"uuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\"\n },\n \"tags\": [],\n \"taxes\": [],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ecb3b4c-b3f5-4960-8515-44bfbfaa0e30", "name": "Receipt already matched or amounts do not align.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", ":uuid", "match-manually" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID to match." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactionUuid\": \"b7c8d9e0-f1a2-3456-bcde-678901234567\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "46d6bbae-7200-4719-9369-648ab111db72", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", ":uuid", "match-manually" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID to match." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactionUuid\": \"b7c8d9e0-f1a2-3456-bcde-678901234567\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3ee37486-340b-4364-85a7-b0f9dece3354", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", ":uuid", "match-manually" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID to match." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactionUuid\": \"b7c8d9e0-f1a2-3456-bcde-678901234567\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0de8810c-8cef-4d67-a7be-1ebcd94c50d9", "name": "Receipt or transaction not found.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", ":uuid", "match-manually" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID to match." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactionUuid\": \"b7c8d9e0-f1a2-3456-bcde-678901234567\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f9389004-a632-404f-ad52-0df46f888343", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", ":uuid", "match-manually" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID to match." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactionUuid\": \"b7c8d9e0-f1a2-3456-bcde-678901234567\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b6473d69-4240-47d7-a733-ce78282545e0", "name": "Removes the link between an expense receipt and its transaction.", "request": { "name": "Removes the link between an expense receipt and its transaction.", "description": {}, "url": { "path": [ "partners", "expense-receipts", ":uuid", "unmatch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID to unmatch." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "f82dfaaf-4d7f-445d-85fe-21bc9382f332", "name": "Receipt unmatched successfully.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", ":uuid", "unmatch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID to unmatch." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on unmatching receipt\",\n \"data\": {\n \"pendingReceipt\": {\n \"id\": \"44556677-8899-aabb-ccdd-eeff00112233\",\n \"amount\": 45.99,\n \"currency\": \"USD\",\n \"date\": \"2026-03-01\",\n \"description\": \"Team lunch\",\n \"matched\": false,\n \"receiptSplited\": false,\n \"account\": {\n \"uuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"name\": \"Business Checking\"\n },\n \"categoryAccount\": {\n \"uuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n \"name\": \"Meals & Entertainment\"\n },\n \"vendor\": null,\n \"project\": {\n \"uuid\": \"11223344-5566-7788-99aa-bbccddeeff00\",\n \"name\": \"Website Redesign\"\n },\n \"customer\": {\n \"uuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\"\n },\n \"tags\": [],\n \"taxes\": [],\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5f4f15e-0910-4be5-b2cb-5ce1d57fff71", "name": "Receipt is not matched to a transaction.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", ":uuid", "unmatch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID to unmatch." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "91bd776c-d5a4-4b54-bae2-d56a6e613d9d", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", ":uuid", "unmatch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID to unmatch." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8bbe2d0a-0c88-46d9-beb2-4c557ec79d64", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", ":uuid", "unmatch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID to unmatch." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0991d0b9-a176-4753-b766-872f629dc9ca", "name": "Expense receipt not found.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", ":uuid", "unmatch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID to unmatch." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "99039c87-501c-42b1-873a-7ce1395d3c3f", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "expense-receipts", ":uuid", "unmatch" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Expense receipt UUID to unmatch." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "3475ca7e-b845-428b-afaf-1d4cc8bbabd4", "name": "Connections", "description": { "content": "List and manage bank-feed connections (Plaid, Akahu, and similar). New connections require a human to complete Plaid Hosted Link in a browser.", "type": "text/plain" }, "item": [ { "id": "c8bfbe29-4029-4107-aa89-cf5f2ea4f8b2", "name": "Lists every bank-feed connection for the workspace.", "request": { "name": "Lists every bank-feed connection for the workspace.", "description": {}, "url": { "path": [ "partners", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "ec684a6c-ae9d-495e-86da-5692151f754e", "name": "Connections retrieved.", "originalRequest": { "url": { "path": [ "partners", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"connections\": [\n {\n \"id\": \"66778899-aabb-ccdd-eeff-001122334455\",\n \"provider\": \"plaid\",\n \"institutionName\": \"Chase\",\n \"status\": \"active\",\n \"lastSyncAt\": \"2026-01-28T14:22:30.000Z\",\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\",\n \"accounts\": [\n {\n \"id\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"name\": \"Business Checking\",\n \"mask\": \"1234\",\n \"type\": \"depository\"\n }\n ]\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffe21c1e-5a20-46dd-9c5c-45c596002d71", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d83ecde9-31ca-47f6-804c-07d626fa47e1", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "955168b8-7963-45b8-9500-24ce4da1bcaa", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "connections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fc8fb4ee-f7c9-4031-8c3f-932c05acda13", "name": "Mints a Plaid Hosted Link URL for connecting a new bank account.", "request": { "name": "Mints a Plaid Hosted Link URL for connecting a new bank account.", "description": { "content": "Hand `hostedLinkUrl` to a human to open in a browser. After they finish, call complete-connect-link with the same `linkToken`.", "type": "text/plain" }, "url": { "path": [ "partners", "connections", "connect-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "0aecd204-1dac-4892-9712-cec6d3f261bd", "name": "Hosted Link session created.", "originalRequest": { "url": { "path": [ "partners", "connections", "connect-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"linkToken\": \"link-sandbox-xxxxxxxx\",\n \"hostedLinkUrl\": \"https://cdn.plaid.com/link/v2/stable/link.html?isWebview=true&token=…\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ea34675-3f27-42ce-aebf-b6d2c7a72414", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "connections", "connect-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b0fc65dc-3485-4224-9de6-397b2b029fc4", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "connections", "connect-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "31adce56-4419-4eae-a1a6-5278a9970582", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "connections", "connect-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f35f0a3d-c43a-4037-bf5a-6095edc59614", "name": "Polls whether the human finished Hosted Link and creates the connection when ready.", "request": { "name": "Polls whether the human finished Hosted Link and creates the connection when ready.", "description": {}, "url": { "path": [ "partners", "connections", "connect-link", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"linkToken\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a95f286e-eb2d-4e3c-85c5-2735e965e89e", "name": "Poll result. status is pending, exited, or completed.", "originalRequest": { "url": { "path": [ "partners", "connections", "connect-link", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"linkToken\": \"link-sandbox-xxxxxxxx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"status\": \"completed\",\n \"connection\": {\n \"id\": \"66778899-aabb-ccdd-eeff-001122334455\",\n \"provider\": \"plaid\",\n \"institutionName\": \"Chase\",\n \"status\": \"active\",\n \"lastSyncAt\": \"2026-01-28T14:22:30.000Z\",\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\",\n \"accounts\": [\n {\n \"id\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"name\": \"Business Checking\",\n \"mask\": \"1234\",\n \"type\": \"depository\"\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c50f23b-85a3-43b6-847e-4dad96907534", "name": "`linkToken` missing or invalid.", "originalRequest": { "url": { "path": [ "partners", "connections", "connect-link", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"linkToken\": \"link-sandbox-xxxxxxxx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "db0fedde-2c13-46db-baf1-e95988a8a808", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "connections", "connect-link", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"linkToken\": \"link-sandbox-xxxxxxxx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "49e265cf-afc2-4333-b319-d93d7c910237", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "connections", "connect-link", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"linkToken\": \"link-sandbox-xxxxxxxx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "48cd2d94-77c9-45ec-b0bf-2578688da1f5", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "connections", "connect-link", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"linkToken\": \"link-sandbox-xxxxxxxx\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6dc7b437-6f9e-438c-b219-e9b8859528df", "name": "Retrieves a single connection by UUID.", "request": { "name": "Retrieves a single connection by UUID.", "description": {}, "url": { "path": [ "partners", "connections", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Connection UUID from list connections." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "591608b3-29b9-49b4-925c-9c03a719d38f", "name": "Connection retrieved.", "originalRequest": { "url": { "path": [ "partners", "connections", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Connection UUID from list connections." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"connection\": {\n \"id\": \"66778899-aabb-ccdd-eeff-001122334455\",\n \"provider\": \"plaid\",\n \"institutionName\": \"Chase\",\n \"status\": \"active\",\n \"lastSyncAt\": \"2026-01-28T14:22:30.000Z\",\n \"createdAt\": \"2026-01-15T10:30:00.000Z\",\n \"updatedAt\": \"2026-01-28T14:22:30.000Z\",\n \"accounts\": [\n {\n \"id\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"name\": \"Business Checking\",\n \"mask\": \"1234\",\n \"type\": \"depository\"\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3dde1dbf-1653-4c09-b7a0-3fe9525b7d1d", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "connections", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Connection UUID from list connections." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ff1af395-fb24-456e-ae4c-dd78c9fcf3b2", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "connections", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Connection UUID from list connections." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6592f9f6-9763-41a0-b79f-343828f5e92b", "name": "Connection not found.", "originalRequest": { "url": { "path": [ "partners", "connections", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Connection UUID from list connections." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8dc7d54a-96b0-42c5-b2e2-e96f67994a33", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "connections", ":uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Connection UUID from list connections." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e7b243f-5b25-4b56-b917-20f49a2593cd", "name": "Revokes the provider access token so the connection stops syncing.", "request": { "name": "Revokes the provider access token so the connection stops syncing.", "description": { "content": "Does not delete historical accounts or transactions.", "type": "text/plain" }, "url": { "path": [ "partners", "connections", ":uuid", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Connection UUID." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "7b48b440-b207-4b7d-8aee-9bb85307f61e", "name": "Connection revoked.", "originalRequest": { "url": { "path": [ "partners", "connections", ":uuid", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Connection UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Connection revoked successfully.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7a4cbba-d9aa-4881-9d47-3a61ff9f39ec", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "connections", ":uuid", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Connection UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "697e923a-8420-44d2-9c1e-c68030bbda8b", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "connections", ":uuid", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Connection UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8c6ee366-fc28-4a31-a66f-48b0f8392cb0", "name": "Connection not found.", "originalRequest": { "url": { "path": [ "partners", "connections", ":uuid", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Connection UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b1c801fc-6848-48b0-9c3b-02ccbe2666ea", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "connections", ":uuid", "revoke" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Connection UUID." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25fbba11-ee20-442f-a292-efb947c30bbc", "name": "Mints a Plaid Hosted Link URL in update mode for an existing connection.", "request": { "name": "Mints a Plaid Hosted Link URL in update mode for an existing connection.", "description": { "content": "Plaid-connected accounts only. Re-authenticates the same connection instead of creating a duplicate.", "type": "text/plain" }, "url": { "path": [ "partners", "connections", ":uuid", "reconnect-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Connection UUID to re-authenticate." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "869308de-7f6b-4357-a7a6-4a314c503ba2", "name": "Update-mode Hosted Link session created.", "originalRequest": { "url": { "path": [ "partners", "connections", ":uuid", "reconnect-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Connection UUID to re-authenticate." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"linkToken\": \"link-sandbox-yyyyyyyy\",\n \"hostedLinkUrl\": \"https://cdn.plaid.com/link/v2/stable/link.html?isWebview=true&token=…\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5acd5e30-f35d-4634-a4ec-0e9b5bae9cbc", "name": "Reconnect links are only supported for Plaid connections.", "originalRequest": { "url": { "path": [ "partners", "connections", ":uuid", "reconnect-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Connection UUID to re-authenticate." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "289bddaa-302d-43e3-ba95-f64aed12112c", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "connections", ":uuid", "reconnect-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Connection UUID to re-authenticate." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8536c16f-861f-4518-93c7-1c8d78bc8d1a", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "connections", ":uuid", "reconnect-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Connection UUID to re-authenticate." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cdcfe6d0-3ca5-4fa9-b255-671427ab7f93", "name": "Connection not found.", "originalRequest": { "url": { "path": [ "partners", "connections", ":uuid", "reconnect-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Connection UUID to re-authenticate." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "14404d19-1542-4cb9-a556-3c392e5949cb", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "connections", ":uuid", "reconnect-link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Connection UUID to re-authenticate." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d8bcfe65-d96d-45fe-b375-be1fc9b0ef3d", "name": "Reconciliations", "description": { "content": "Start a bank reconciliation draft for an account statement period, then complete it to mark reviewed journal entries as reconciled.", "type": "text/plain" }, "item": [ { "id": "14f06c71-28c5-4cb9-b5fb-fbc00b5b46b1", "name": "Creates a draft reconciliation for an account statement period.", "request": { "name": "Creates a draft reconciliation for an account statement period.", "description": {}, "url": { "path": [ "partners", "reconciliations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"accountUuid\": \"\",\n \"endingBalanceDate\": \"\",\n \"endingBalanceAmount\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "13109497-657b-4634-96f0-2ff23882eec8", "name": "Draft reconciliation created.", "originalRequest": { "url": { "path": [ "partners", "reconciliations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"endingBalanceDate\": \"2026-03-31\",\n \"endingBalanceAmount\": 12500.45\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Reconciliation draft created successfully.\",\n \"data\": {\n \"reconciliation\": {\n \"id\": \"778899aa-bbcc-ddee-ff00-112233445566\",\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"endingBalanceDate\": \"2026-03-31\",\n \"endingBalanceAmount\": 12500.45,\n \"status\": \"draft\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fd0e6b4-3c81-40c1-8c2c-bff85b4463f0", "name": "Validation failed or date-order conflict.", "originalRequest": { "url": { "path": [ "partners", "reconciliations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"endingBalanceDate\": \"2026-03-31\",\n \"endingBalanceAmount\": 12500.45\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "94fb021d-7939-4afc-9042-f2f42b577ef3", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "reconciliations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"endingBalanceDate\": \"2026-03-31\",\n \"endingBalanceAmount\": 12500.45\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9608ea07-a7c1-49ed-9c7c-73ccfc2ff968", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "reconciliations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"endingBalanceDate\": \"2026-03-31\",\n \"endingBalanceAmount\": 12500.45\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "03cbbd47-615e-4967-b817-56aff48e3444", "name": "Account not found.", "originalRequest": { "url": { "path": [ "partners", "reconciliations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"endingBalanceDate\": \"2026-03-31\",\n \"endingBalanceAmount\": 12500.45\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f6232b49-7149-4599-af8f-cc7a8fd2fd6f", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "reconciliations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"endingBalanceDate\": \"2026-03-31\",\n \"endingBalanceAmount\": 12500.45\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4b03c0c9-9b7a-4f21-80df-aff52dd661d0", "name": "Locks a draft reconciliation and marks reviewed journal entries reconciled.", "request": { "name": "Locks a draft reconciliation and marks reviewed journal entries reconciled.", "description": {}, "url": { "path": [ "partners", "reconciliations", ":uuid", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Reconciliation UUID from create." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"autoReconcile\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "50bb866c-429e-4130-9ed4-e5b878217c02", "name": "Reconciliation completed.", "originalRequest": { "url": { "path": [ "partners", "reconciliations", ":uuid", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Reconciliation UUID from create." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"autoReconcile\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Reconciliation completed successfully.\",\n \"data\": {\n \"reconciliation\": {\n \"id\": \"778899aa-bbcc-ddee-ff00-112233445566\",\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"endingBalanceDate\": \"2026-03-31\",\n \"endingBalanceAmount\": 12500.45,\n \"status\": \"completed\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fe842c4-f9d0-4637-9ba3-a2070ac97939", "name": "Closed period or date-order violation.", "originalRequest": { "url": { "path": [ "partners", "reconciliations", ":uuid", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Reconciliation UUID from create." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"autoReconcile\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "93ea1846-285b-4784-90ff-712947dcff4d", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "reconciliations", ":uuid", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Reconciliation UUID from create." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"autoReconcile\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7d607a36-f9d5-4bb0-b912-4b2453a9387d", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "reconciliations", ":uuid", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Reconciliation UUID from create." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"autoReconcile\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d0bcabd1-4a36-434f-9415-1f55ed03c10a", "name": "Reconciliation not found or not a pending draft.", "originalRequest": { "url": { "path": [ "partners", "reconciliations", ":uuid", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Reconciliation UUID from create." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"autoReconcile\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a449cb77-d265-4856-88b5-21f02a229ba4", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "reconciliations", ":uuid", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) Reconciliation UUID from create." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"autoReconcile\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "60492509-71f9-460b-95fd-9e677721b7b9", "name": "Opening Balance", "description": { "content": "Read and publish the workspace opening (conversion) balance as of the cutover date. Total debits must equal total credits.", "type": "text/plain" }, "item": [ { "id": "8be3846f-47ea-4f8c-828d-d6073bbbeae3", "name": "Returns the current opening balance status, cutover date, and rows.", "request": { "name": "Returns the current opening balance status, cutover date, and rows.", "description": {}, "url": { "path": [ "partners", "opening-balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "140d2a50-43a8-4719-8c09-f3be05e9ba8e", "name": "Opening balance state retrieved.", "originalRequest": { "url": { "path": [ "partners", "opening-balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"status\": \"published\",\n \"cutoverDate\": \"2026-03-01\",\n \"rows\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"accountName\": \"Business Checking\",\n \"accountType\": \"Assets\",\n \"debit\": \"12500.00\",\n \"credit\": \"0.00\"\n },\n {\n \"accountUuid\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"accountName\": \"Opening Balance Equity\",\n \"accountType\": \"Equity\",\n \"debit\": \"0.00\",\n \"credit\": \"12500.00\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10e05b21-45b2-4842-8be4-569f4c6d1d05", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "opening-balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "179840e4-343a-460f-b6c0-a6d1d228ae91", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "opening-balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0a82bf83-550d-45af-aa10-68d06564a918", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "opening-balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "30f91d91-ad41-408e-bccf-02d8c8440ca1", "name": "Drafts and publishes the opening balance in one call.", "request": { "name": "Drafts and publishes the opening balance in one call.", "description": {}, "url": { "path": [ "partners", "opening-balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"rows\": [\n {\n \"accountUuid\": \"\",\n \"debit\": \"\",\n \"credit\": \"\"\n },\n {\n \"accountUuid\": \"\",\n \"debit\": \"\",\n \"credit\": \"\"\n }\n ],\n \"replaceExisting\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "727f862f-37a5-4a99-acd3-2579d3f55f7c", "name": "Opening balance published.", "originalRequest": { "url": { "path": [ "partners", "opening-balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"replaceExisting\": true,\n \"rows\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"debit\": 12500,\n \"credit\": 0\n },\n {\n \"accountUuid\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"debit\": 0,\n \"credit\": 12500\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Opening balance published successfully.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7787411e-aeaa-485b-bdc6-b55be2be8ab6", "name": "Validation failed, unbalanced rows, or workspace is no longer onboarding.", "originalRequest": { "url": { "path": [ "partners", "opening-balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"replaceExisting\": true,\n \"rows\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"debit\": 12500,\n \"credit\": 0\n },\n {\n \"accountUuid\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"debit\": 0,\n \"credit\": 12500\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3c33d222-c6a3-4508-b12f-de2518c2147c", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "opening-balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"replaceExisting\": true,\n \"rows\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"debit\": 12500,\n \"credit\": 0\n },\n {\n \"accountUuid\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"debit\": 0,\n \"credit\": 12500\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "115ea25e-e91e-4417-8580-b465f1859ad6", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "opening-balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"replaceExisting\": true,\n \"rows\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"debit\": 12500,\n \"credit\": 0\n },\n {\n \"accountUuid\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"debit\": 0,\n \"credit\": 12500\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9935b89b-7e4e-4e0a-ba9d-d0cb309ac0e1", "name": "An opening balance already exists and replaceExisting was not true.", "originalRequest": { "url": { "path": [ "partners", "opening-balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"replaceExisting\": true,\n \"rows\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"debit\": 12500,\n \"credit\": 0\n },\n {\n \"accountUuid\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"debit\": 0,\n \"credit\": 12500\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5bbfde5c-f243-46db-85cb-378b0d275127", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "opening-balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"replaceExisting\": true,\n \"rows\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"debit\": 12500,\n \"credit\": 0\n },\n {\n \"accountUuid\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"debit\": 0,\n \"credit\": 12500\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "39997e82-57df-4caa-a6aa-5893f3f182a6", "name": "Workspace", "description": { "content": "Update workspace-level settings for the authenticated workspace. Currently supports setting the cutover date.", "type": "text/plain" }, "item": [ { "id": "82737284-4565-48a0-bbdd-31a67ba90c16", "name": "Updates workspace settings. Currently `cutoverDate` only.", "request": { "name": "Updates workspace settings. Currently `cutoverDate` only.", "description": {}, "url": { "path": [ "partners", "workspace" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"cutoverDate\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "26e02462-b83b-4bd3-84c8-1472721266a0", "name": "Workspace updated.", "originalRequest": { "url": { "path": [ "partners", "workspace" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"cutoverDate\": \"2026-03-01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Workspace cutover date updated successfully.\",\n \"data\": {\n \"workspace\": {\n \"cutoverDate\": \"2026-03-01\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08048a00-e837-4f21-94be-a2982575d1e4", "name": "Missing/invalid cutoverDate, or cutover move rejected by guards.", "originalRequest": { "url": { "path": [ "partners", "workspace" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"cutoverDate\": \"2026-03-01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5175e4f3-37d2-45f3-a74d-623cdabf9012", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "workspace" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"cutoverDate\": \"2026-03-01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "11aeff6e-89c8-4c01-b6d1-c4c26f32a1eb", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "workspace" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"cutoverDate\": \"2026-03-01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "72586b98-6b55-47c1-b310-eb7dbe5ad337", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "workspace" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"cutoverDate\": \"2026-03-01\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "be859408-59ca-4a97-8f74-7fde908da41a", "name": "Reports", "description": { "content": "Generate trial balance, profit and loss, balance sheet, AR/AP aging, sales analytics, and customer activity reports for a workspace. All routes use POST with filters on the query string — there is no request body.", "type": "text/plain" }, "item": [ { "id": "d749e8e2-b85d-4047-912e-1e8dbb6c1bc1", "name": "Generates a trial balance as of a date.", "request": { "name": "Generates a trial balance as of a date.", "description": { "content": "Filters are query parameters only. Required: endDate (YYYY-MM-DD).", "type": "text/plain" }, "url": { "path": [ "partners", "reports", "trial-balance" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "endDate", "value": "", "description": "(Required) As-of date for the trial balance." }, { "disabled": false, "key": "startDate", "value": "", "description": "Period start. Defaults to fiscal-year start when omitted." }, { "disabled": false, "key": "currency", "value": "", "description": "Report currency. Defaults to workspace currency." }, { "disabled": false, "key": "transactionStatus", "value": "", "description": "Filter transactions by review/reconciliation state." }, { "disabled": false, "key": "accountUuids", "value": "", "description": "Comma-separated account UUIDs to include." }, { "disabled": false, "key": "tagUuids", "value": "", "description": "Comma-separated tag UUIDs to filter by." }, { "disabled": false, "key": "noTags", "value": "", "description": "Set to true to include only entries with no tags." }, { "disabled": false, "key": "accountType", "value": "", "description": "Restrict to a single account type." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "6b60837c-df50-4ee9-8f1d-bfbbcd158d9b", "name": "Trial balance report generated.", "originalRequest": { "url": { "path": [ "partners", "reports", "trial-balance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "endDate", "value": "2026-03-31" }, { "key": "startDate", "value": "2026-01-01" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "accountUuids", "value": "" }, { "key": "tagUuids", "value": "" }, { "key": "noTags", "value": "true" }, { "key": "accountType", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on generating trial balance report\",\n \"data\": {\n \"report\": {\n \"endDate\": \"2026-03-31\",\n \"currency\": \"USD\",\n \"rows\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"accountName\": \"Business Checking\",\n \"accountType\": \"Assets\",\n \"debit\": 12500,\n \"credit\": 0,\n \"balance\": 12500\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8d459dc-2992-4718-8401-561c678ee62f", "name": "Missing or invalid query parameters.", "originalRequest": { "url": { "path": [ "partners", "reports", "trial-balance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "endDate", "value": "2026-03-31" }, { "key": "startDate", "value": "2026-01-01" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "accountUuids", "value": "" }, { "key": "tagUuids", "value": "" }, { "key": "noTags", "value": "true" }, { "key": "accountType", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0bcfc21c-d2f6-41dd-a356-8d3816121dc6", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "reports", "trial-balance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "endDate", "value": "2026-03-31" }, { "key": "startDate", "value": "2026-01-01" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "accountUuids", "value": "" }, { "key": "tagUuids", "value": "" }, { "key": "noTags", "value": "true" }, { "key": "accountType", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "53a35a7d-5a4c-4a78-b530-b6cf10e3d422", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "reports", "trial-balance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "endDate", "value": "2026-03-31" }, { "key": "startDate", "value": "2026-01-01" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "accountUuids", "value": "" }, { "key": "tagUuids", "value": "" }, { "key": "noTags", "value": "true" }, { "key": "accountType", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0ee2f679-8e21-49ad-a4a0-f6c479ebd5e5", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "reports", "trial-balance" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "endDate", "value": "2026-03-31" }, { "key": "startDate", "value": "2026-01-01" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "accountUuids", "value": "" }, { "key": "tagUuids", "value": "" }, { "key": "noTags", "value": "true" }, { "key": "accountType", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a715e3be-1340-48e0-a3b6-a7f28f57ffb1", "name": "Generates a profit and loss (income statement) for a date range.", "request": { "name": "Generates a profit and loss (income statement) for a date range.", "description": { "content": "Filters are query parameters only. Required: startDate and endDate (YYYY-MM-DD).", "type": "text/plain" }, "url": { "path": [ "partners", "reports", "pnl" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "startDate", "value": "", "description": "(Required) Report period start." }, { "disabled": false, "key": "endDate", "value": "", "description": "(Required) Report period end." }, { "disabled": false, "key": "currency", "value": "", "description": "Report currency. Defaults to workspace currency." }, { "disabled": false, "key": "transactionStatus", "value": "", "description": "Filter transactions by review/reconciliation state." }, { "disabled": false, "key": "categoryAccountUuids", "value": "", "description": "Comma-separated income/expense account UUIDs to filter categories." }, { "disabled": false, "key": "customerUuids", "value": "", "description": "Comma-separated customer UUIDs." }, { "disabled": false, "key": "projectUuids", "value": "", "description": "Comma-separated project UUIDs." }, { "disabled": false, "key": "isPnLByTag", "value": "", "description": "Set to true for a column-per-tag breakdown." }, { "disabled": false, "key": "reportYear", "value": "", "description": "Year basis for the report." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "95de959c-d201-4cf7-a399-d412c88fd44c", "name": "Profit and loss report generated.", "originalRequest": { "url": { "path": [ "partners", "reports", "pnl" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "categoryAccountUuids", "value": "" }, { "key": "customerUuids", "value": "dfa3219e-6af8-4c53-997a-037534f63a35" }, { "key": "projectUuids", "value": "11223344-5566-7788-99aa-bbccddeeff00" }, { "key": "isPnLByTag", "value": "true" }, { "key": "reportYear", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on generating P&L report\",\n \"data\": {\n \"report\": {\n \"startDate\": \"2026-01-01\",\n \"endDate\": \"2026-03-31\",\n \"currency\": \"USD\",\n \"netProfit\": 12000,\n \"rows\": [\n {\n \"accountUuid\": \"d4e5f6a7-b8c9-0123-defa-234567890123\",\n \"accountName\": \"Consulting Revenue\",\n \"accountType\": \"Income\",\n \"amount\": 45000\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4afd547d-01d3-4fc1-a0ef-d73f8027ed45", "name": "Missing startDate/endDate or invalid filters.", "originalRequest": { "url": { "path": [ "partners", "reports", "pnl" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "categoryAccountUuids", "value": "" }, { "key": "customerUuids", "value": "dfa3219e-6af8-4c53-997a-037534f63a35" }, { "key": "projectUuids", "value": "11223344-5566-7788-99aa-bbccddeeff00" }, { "key": "isPnLByTag", "value": "true" }, { "key": "reportYear", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "561f7ca8-c028-4963-a354-0d16fa92ffa0", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "reports", "pnl" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "categoryAccountUuids", "value": "" }, { "key": "customerUuids", "value": "dfa3219e-6af8-4c53-997a-037534f63a35" }, { "key": "projectUuids", "value": "11223344-5566-7788-99aa-bbccddeeff00" }, { "key": "isPnLByTag", "value": "true" }, { "key": "reportYear", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eaa18d7b-f522-4b54-a475-9b57b54326f1", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "reports", "pnl" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "categoryAccountUuids", "value": "" }, { "key": "customerUuids", "value": "dfa3219e-6af8-4c53-997a-037534f63a35" }, { "key": "projectUuids", "value": "11223344-5566-7788-99aa-bbccddeeff00" }, { "key": "isPnLByTag", "value": "true" }, { "key": "reportYear", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "80d25398-8407-4615-b815-7e3e1a713702", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "reports", "pnl" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "categoryAccountUuids", "value": "" }, { "key": "customerUuids", "value": "dfa3219e-6af8-4c53-997a-037534f63a35" }, { "key": "projectUuids", "value": "11223344-5566-7788-99aa-bbccddeeff00" }, { "key": "isPnLByTag", "value": "true" }, { "key": "reportYear", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2dba3589-b2c1-4b85-bdad-0fd6c899fa36", "name": "Generates a balance sheet as of a date.", "request": { "name": "Generates a balance sheet as of a date.", "description": { "content": "Filters are query parameters only. Required: endDate (YYYY-MM-DD).", "type": "text/plain" }, "url": { "path": [ "partners", "reports", "balance-sheet" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "endDate", "value": "", "description": "(Required) As-of date for the balance sheet." }, { "disabled": false, "key": "startDate", "value": "", "description": "Prior-period comparison anchor when provided." }, { "disabled": false, "key": "currency", "value": "", "description": "Report currency. Defaults to workspace currency." }, { "disabled": false, "key": "transactionStatus", "value": "", "description": "Filter transactions by review/reconciliation state." }, { "disabled": false, "key": "accountUuids", "value": "", "description": "Comma-separated account UUIDs to include." }, { "disabled": false, "key": "tagUuids", "value": "", "description": "Comma-separated tag UUIDs to filter by." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "02f907f3-47d4-4dbb-b3b8-ca2aad3e62be", "name": "Balance sheet report generated.", "originalRequest": { "url": { "path": [ "partners", "reports", "balance-sheet" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "endDate", "value": "2026-03-31" }, { "key": "startDate", "value": "2025-03-31" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "accountUuids", "value": "" }, { "key": "tagUuids", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on generating balance sheet report\",\n \"data\": {\n \"report\": {\n \"endDate\": \"2026-03-31\",\n \"currency\": \"USD\",\n \"sections\": [\n {\n \"name\": \"Assets\",\n \"total\": 85000,\n \"accounts\": [\n {\n \"accountUuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"accountName\": \"Business Checking\",\n \"balance\": 12500\n }\n ]\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "507a78c4-2e80-4cae-8a98-d2247ce9340a", "name": "Missing endDate or invalid filters.", "originalRequest": { "url": { "path": [ "partners", "reports", "balance-sheet" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "endDate", "value": "2026-03-31" }, { "key": "startDate", "value": "2025-03-31" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "accountUuids", "value": "" }, { "key": "tagUuids", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2d40b910-1445-4955-922b-b4be1c58cb3c", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "reports", "balance-sheet" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "endDate", "value": "2026-03-31" }, { "key": "startDate", "value": "2025-03-31" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "accountUuids", "value": "" }, { "key": "tagUuids", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6713831b-ec89-425a-83a1-6cbcaf9cf105", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "reports", "balance-sheet" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "endDate", "value": "2026-03-31" }, { "key": "startDate", "value": "2025-03-31" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "accountUuids", "value": "" }, { "key": "tagUuids", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "01a5199e-dfab-498d-8eb0-743b08b82ffb", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "reports", "balance-sheet" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "endDate", "value": "2026-03-31" }, { "key": "startDate", "value": "2025-03-31" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "accountUuids", "value": "" }, { "key": "tagUuids", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e7c2a47-b165-42cf-aa28-f55d64cec604", "name": "Generates an AR aging report as of a date.", "request": { "name": "Generates an AR aging report as of a date.", "description": { "content": "Computes open invoice and credit-memo balances off the Accounts Receivable control account. Returns detail rows, customer summaries, bucket totals, and reconciliation against the control account GL balance. Filters are query parameters only.", "type": "text/plain" }, "url": { "path": [ "partners", "reports", "aged-receivables" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "asOfDate", "value": "", "description": "As-of date for aging (YYYY-MM-DD). Alias for endDate — supply one." }, { "disabled": false, "key": "endDate", "value": "", "description": "Alias for asOfDate." }, { "disabled": false, "key": "currency", "value": "", "description": "Report currency. Defaults to workspace currency." }, { "disabled": false, "key": "agingBasis", "value": "", "description": "Age documents off due date (default) or posted/document date." }, { "disabled": false, "key": "tagUuids", "value": "", "description": "Comma-separated tag UUIDs to filter by." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "8c76ef3e-7967-4950-8ec4-2db91fad1583", "name": "Aged receivables report generated.", "originalRequest": { "url": { "path": [ "partners", "reports", "aged-receivables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "asOfDate", "value": "2026-03-31" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "agingBasis", "value": "" }, { "key": "tagUuids", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on generating aged receivables report\",\n \"data\": {\n \"currency\": \"USD\",\n \"asOfDate\": \"2026-03-31\",\n \"rows\": [\n {\n \"documentUuid\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"documentNumber\": \"INV-1042\",\n \"counterpartyUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"counterpartyName\": \"Acme Corporation\",\n \"dueDate\": \"2026-03-31\",\n \"ageDays\": 12,\n \"bucket\": \"notYetOverdue\",\n \"amountDue\": 2500\n }\n ],\n \"customers\": [\n {\n \"counterpartyUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"counterpartyName\": \"Acme Corporation\",\n \"totals\": {\n \"notYetOverdue\": 2500\n }\n }\n ],\n \"totals\": {\n \"notYetOverdue\": 2500\n },\n \"reconciliation\": {\n \"controlAccountBalance\": 2500,\n \"reportTotal\": 2500\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "228ee2a0-caa9-4ebc-b330-eab09c58b8e4", "name": "Missing or invalid query parameters.", "originalRequest": { "url": { "path": [ "partners", "reports", "aged-receivables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "asOfDate", "value": "2026-03-31" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "agingBasis", "value": "" }, { "key": "tagUuids", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e4d917bd-d95d-42dc-ae8e-2eb2244ea51a", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "reports", "aged-receivables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "asOfDate", "value": "2026-03-31" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "agingBasis", "value": "" }, { "key": "tagUuids", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "786ae92a-7f07-4e04-98be-1b6bb2f746c0", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "reports", "aged-receivables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "asOfDate", "value": "2026-03-31" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "agingBasis", "value": "" }, { "key": "tagUuids", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1680559d-6b3a-4b9a-ba74-d0b572246a18", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "reports", "aged-receivables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "asOfDate", "value": "2026-03-31" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "agingBasis", "value": "" }, { "key": "tagUuids", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a5d567ce-77c3-468f-931b-b442ff67a5da", "name": "Generates an AP aging report as of a date.", "request": { "name": "Generates an AP aging report as of a date.", "description": { "content": "Payables mirror of aged receivables: open bills and vendor memos aged off the Accounts Payable control account. Query filters match aged receivables.", "type": "text/plain" }, "url": { "path": [ "partners", "reports", "aged-payables" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "asOfDate", "value": "", "description": "As-of date for aging (YYYY-MM-DD). Alias for endDate — supply one." }, { "disabled": false, "key": "endDate", "value": "", "description": "Alias for asOfDate." }, { "disabled": false, "key": "currency", "value": "", "description": "Report currency. Defaults to workspace currency." }, { "disabled": false, "key": "agingBasis", "value": "", "description": "Age documents off due date (default) or posted/document date." }, { "disabled": false, "key": "tagUuids", "value": "", "description": "Comma-separated tag UUIDs to filter by." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "c9bb0df1-8231-444a-b6c2-1d84eb36403b", "name": "Aged payables report generated.", "originalRequest": { "url": { "path": [ "partners", "reports", "aged-payables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "asOfDate", "value": "2026-03-31" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "agingBasis", "value": "" }, { "key": "tagUuids", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on generating aged payables report\",\n \"data\": {\n \"currency\": \"USD\",\n \"asOfDate\": \"2026-03-31\",\n \"rows\": [\n {\n \"documentUuid\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"documentNumber\": \"BILL-2042\",\n \"counterpartyUuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"counterpartyName\": \"Acme Corporation\",\n \"dueDate\": \"2026-03-31\",\n \"ageDays\": 12,\n \"bucket\": \"notYetOverdue\",\n \"amountDue\": 2500\n }\n ],\n \"vendors\": [\n {\n \"counterpartyUuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889901\",\n \"counterpartyName\": \"Office Supplies Co\",\n \"totals\": {\n \"between31And60\": 900\n }\n }\n ],\n \"totals\": {\n \"between31And60\": 900\n },\n \"reconciliation\": {\n \"controlAccountBalance\": 900,\n \"reportTotal\": 900\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b943119-2935-4382-976f-b6d5e693a90f", "name": "Missing or invalid query parameters.", "originalRequest": { "url": { "path": [ "partners", "reports", "aged-payables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "asOfDate", "value": "2026-03-31" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "agingBasis", "value": "" }, { "key": "tagUuids", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f3160957-135b-4691-a3f9-64443e0b8018", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "reports", "aged-payables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "asOfDate", "value": "2026-03-31" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "agingBasis", "value": "" }, { "key": "tagUuids", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f0740579-96f1-4a20-af68-a41ef6e59a16", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "reports", "aged-payables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "asOfDate", "value": "2026-03-31" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "agingBasis", "value": "" }, { "key": "tagUuids", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "69edced5-0024-4527-9e36-09cc0081eb89", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "reports", "aged-payables" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "asOfDate", "value": "2026-03-31" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "agingBasis", "value": "" }, { "key": "tagUuids", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ce46a596-e768-443b-9b28-bce84f6340e6", "name": "Summarizes invoice line revenue and quantity by product or service.", "request": { "name": "Summarizes invoice line revenue and quantity by product or service.", "description": { "content": "Filters are query parameters only. Optional startDate and endDate bound the period.", "type": "text/plain" }, "url": { "path": [ "partners", "reports", "sales-by-product-service" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "startDate", "value": "", "description": "Report period start." }, { "disabled": false, "key": "endDate", "value": "", "description": "Report period end." }, { "disabled": false, "key": "currency", "value": "", "description": "Report currency. Defaults to workspace currency." }, { "disabled": false, "key": "transactionStatus", "value": "", "description": "Filter transactions by review/reconciliation state." }, { "disabled": false, "key": "productUuids", "value": "", "description": "Comma-separated product/service UUIDs." }, { "disabled": false, "key": "reportType", "value": "", "description": "Accounting basis for the report." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "739fcffa-82b6-419c-919e-bbc7daf34afa", "name": "Sales by product/service report generated.", "originalRequest": { "url": { "path": [ "partners", "reports", "sales-by-product-service" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "productUuids", "value": "aa11bb22-cc33-dd44-ee55-ff6677889900" }, { "key": "reportType", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on generating sales by product/service report\",\n \"data\": {\n \"productsSales\": [\n {\n \"uuid\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"name\": \"Consulting services\",\n \"totalSales\": 18000,\n \"totalQuantity\": 40\n }\n ],\n \"totals\": {\n \"totalSales\": 18000,\n \"totalQuantity\": 40\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbe82198-5105-4819-b467-e6f24ab7519f", "name": "Invalid filters.", "originalRequest": { "url": { "path": [ "partners", "reports", "sales-by-product-service" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "productUuids", "value": "aa11bb22-cc33-dd44-ee55-ff6677889900" }, { "key": "reportType", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "75a7aa8b-c52a-4156-9a5e-2e1796e653ba", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "reports", "sales-by-product-service" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "productUuids", "value": "aa11bb22-cc33-dd44-ee55-ff6677889900" }, { "key": "reportType", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "91b8a846-92b2-46d7-bbc6-87e82e272cf4", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "reports", "sales-by-product-service" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "productUuids", "value": "aa11bb22-cc33-dd44-ee55-ff6677889900" }, { "key": "reportType", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "33674f7b-7fab-473a-83cc-fa49e401d4f0", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "reports", "sales-by-product-service" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "productUuids", "value": "aa11bb22-cc33-dd44-ee55-ff6677889900" }, { "key": "reportType", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3a03f783-8d34-458a-a1b0-be11dd47d901", "name": "Summarizes invoice line revenue and quantity by customer.", "request": { "name": "Summarizes invoice line revenue and quantity by customer.", "description": { "content": "Sales-only aggregation of invoice line items over a date range. Distinct from customer activity, which nets all journal entries per customer.", "type": "text/plain" }, "url": { "path": [ "partners", "reports", "sales-by-customer" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "startDate", "value": "", "description": "Report period start." }, { "disabled": false, "key": "endDate", "value": "", "description": "Report period end." }, { "disabled": false, "key": "currency", "value": "", "description": "Report currency. Defaults to workspace currency." }, { "disabled": false, "key": "transactionStatus", "value": "", "description": "Filter transactions by review/reconciliation state." }, { "disabled": false, "key": "customerUuids", "value": "", "description": "Comma-separated customer UUIDs." }, { "disabled": false, "key": "reportType", "value": "", "description": "Accounting basis for the report." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "01b07a89-43e1-4f6d-9c88-c8991502e0d0", "name": "Sales by customer report generated.", "originalRequest": { "url": { "path": [ "partners", "reports", "sales-by-customer" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "customerUuids", "value": "dfa3219e-6af8-4c53-997a-037534f63a35" }, { "key": "reportType", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on generating sales by customer report\",\n \"data\": {\n \"customersSales\": [\n {\n \"uuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"name\": \"Acme Corporation\",\n \"totalSales\": 45000,\n \"totalQuantity\": 120\n }\n ],\n \"totals\": {\n \"totalSales\": 45000,\n \"totalQuantity\": 120\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "936dbf1b-a669-4c67-9a0d-3c3cc9ccdb27", "name": "Invalid filters.", "originalRequest": { "url": { "path": [ "partners", "reports", "sales-by-customer" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "customerUuids", "value": "dfa3219e-6af8-4c53-997a-037534f63a35" }, { "key": "reportType", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "500319fb-6507-4b3e-a56b-938e9a93a345", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "reports", "sales-by-customer" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "customerUuids", "value": "dfa3219e-6af8-4c53-997a-037534f63a35" }, { "key": "reportType", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "433fbfdf-4b49-4f44-bcd5-cd5861e3e15d", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "reports", "sales-by-customer" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "customerUuids", "value": "dfa3219e-6af8-4c53-997a-037534f63a35" }, { "key": "reportType", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "abb2f22d-68f1-4f42-9844-57ec1cb8df04", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "reports", "sales-by-customer" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "customerUuids", "value": "dfa3219e-6af8-4c53-997a-037534f63a35" }, { "key": "reportType", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b1a300c0-c6d4-4091-b908-385cd8fa4faa", "name": "Returns per-customer accounting activity with underlying journal entries.", "request": { "name": "Returns per-customer accounting activity with underlying journal entries.", "description": { "content": "Nets every journal entry linked to each customer (invoices, payments, tax, manual journals, customer-linked expenses). Not a sales-only summary.", "type": "text/plain" }, "url": { "path": [ "partners", "reports", "customer-report" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "startDate", "value": "", "description": "Report period start." }, { "disabled": false, "key": "endDate", "value": "", "description": "Report period end." }, { "disabled": false, "key": "currency", "value": "", "description": "Report currency. Defaults to workspace currency." }, { "disabled": false, "key": "transactionStatus", "value": "", "description": "Filter transactions by review/reconciliation state." }, { "disabled": false, "key": "customerUuids", "value": "", "description": "Comma-separated customer UUIDs to restrict the report." }, { "disabled": false, "key": "projectUuids", "value": "", "description": "Comma-separated project UUIDs." }, { "disabled": false, "key": "reportType", "value": "", "description": "Accounting basis for the report." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "2c3d5280-7d6d-4a41-8be8-17794f215ce2", "name": "Customer activity report generated.", "originalRequest": { "url": { "path": [ "partners", "reports", "customer-report" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "customerUuids", "value": "dfa3219e-6af8-4c53-997a-037534f63a35" }, { "key": "projectUuids", "value": "11223344-5566-7788-99aa-bbccddeeff00" }, { "key": "reportType", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on generating customer report\",\n \"data\": {\n \"categorized\": [\n {\n \"customer\": {\n \"uuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"customer\": \"Acme Corporation\"\n },\n \"total\": 2500,\n \"openingBalance\": 0,\n \"endingBalance\": 2500,\n \"balanceChange\": 2500,\n \"debitTotal\": 0,\n \"creditTotal\": 2500,\n \"entries\": [\n {\n \"entryUuid\": \"e1f2a3b4-c5d6-7890-abcd-ef1234567890\",\n \"invoiceUuid\": \"f6a7b8c9-d0e1-2345-fabc-456789012345\",\n \"transactionUuid\": null,\n \"billUuid\": null,\n \"date\": \"2026-03-01\",\n \"descriptionEntry\": \"Invoice payment applied\",\n \"entryType\": \"credit\",\n \"amountCredit\": 2500,\n \"amountDebit\": 0,\n \"amount\": 2500,\n \"balance\": 2500,\n \"account\": {\n \"uuid\": \"c8d9e0f1-a2b3-4567-cdef-789012345678\",\n \"name\": \"Accounts Receivable\",\n \"type\": \"Assets\",\n \"accountNumber\": \"1200\",\n \"code\": \"1200\"\n }\n }\n ]\n }\n ],\n \"filters\": {\n \"startDate\": \"2026-01-01\",\n \"endDate\": \"2026-03-31\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a41efe0-fd42-4503-a633-e9b4c8297076", "name": "Invalid filters.", "originalRequest": { "url": { "path": [ "partners", "reports", "customer-report" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "customerUuids", "value": "dfa3219e-6af8-4c53-997a-037534f63a35" }, { "key": "projectUuids", "value": "11223344-5566-7788-99aa-bbccddeeff00" }, { "key": "reportType", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c335f2a1-8e4e-41bb-826e-212211c3568b", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "reports", "customer-report" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "customerUuids", "value": "dfa3219e-6af8-4c53-997a-037534f63a35" }, { "key": "projectUuids", "value": "11223344-5566-7788-99aa-bbccddeeff00" }, { "key": "reportType", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e42bcee3-6c74-4b3c-814a-0651acd96b0b", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "reports", "customer-report" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "customerUuids", "value": "dfa3219e-6af8-4c53-997a-037534f63a35" }, { "key": "projectUuids", "value": "11223344-5566-7788-99aa-bbccddeeff00" }, { "key": "reportType", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fda454ff-afc6-4c07-97a5-b00a98a2554d", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "reports", "customer-report" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "startDate", "value": "2026-01-01" }, { "key": "endDate", "value": "2026-03-31" }, { "key": "currency", "value": "USD" }, { "key": "transactionStatus", "value": "" }, { "key": "customerUuids", "value": "dfa3219e-6af8-4c53-997a-037534f63a35" }, { "key": "projectUuids", "value": "11223344-5566-7788-99aa-bbccddeeff00" }, { "key": "reportType", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c1c423c8-a83a-4ca2-b6d7-6e1d4ff0154b", "name": "Workspace Stats", "description": { "content": "Aggregated CFO-style business snapshot for a workspace — cash, profitability, receivables, payables, tax obligations, and bank connections in one GET call.", "type": "text/plain" }, "item": [ { "id": "d3305408-b410-47d5-ac26-037da72f519a", "name": "Returns an aggregated business snapshot for the workspace.", "request": { "name": "Returns an aggregated business snapshot for the workspace.", "description": { "content": "Computes cash, profitability, receivables, payables, tax obligations, and connection health. Omit include to return all blocks.", "type": "text/plain" }, "url": { "path": [ "partners", "workspace-stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "include", "value": "", "description": "Comma-separated blocks to compute: workspace, cash, profitability, receivables, payables, taxObligations, connections. Omit for all blocks." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-client-id" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "7fe5424f-f904-422d-8626-3836367d560e", "name": "Workspace stats retrieved successfully.", "originalRequest": { "url": { "path": [ "partners", "workspace-stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "include", "value": "cash,profitability,receivables" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"message\": \"Success on retrieving workspace stats\",\n \"data\": {\n \"workspaceStats\": {\n \"workspace\": {\n \"uuid\": \"ws-uuid-example-0000-4000-8000-000000000001\",\n \"name\": \"Acme Workspace\",\n \"currency\": \"USD\",\n \"country\": \"US\",\n \"industry\": \"Professional Services\",\n \"fiscalYearMonth\": 1,\n \"dateFormat\": \"MM/dd/yyyy\",\n \"cutoverDate\": \"2025-01-01\",\n \"reportType\": \"accrual\",\n \"bookClosedThroughDate\": null\n },\n \"cash\": {\n \"currentCash\": 42500.75,\n \"currentCashAsOf\": \"2026-06-21T08:00:00.000Z\",\n \"bankAndCashAssetsTotal\": 45000,\n \"creditCardLiabilitiesTotal\": 2499.25,\n \"accountSourceCounts\": {\n \"provider\": 2,\n \"reconciliation\": 1,\n \"book\": 0,\n \"missing\": 0\n },\n \"staleProviderBalanceAccountCount\": 0\n },\n \"profitability\": {\n \"currentMonth\": {\n \"startDate\": \"2026-06-01\",\n \"endDate\": \"2026-06-21\",\n \"revenue\": 18500,\n \"expenses\": 11200,\n \"netProfit\": 7300\n },\n \"rollingThreeMonths\": {\n \"averageMonthlyRevenue\": 16000,\n \"averageMonthlyExpenses\": 10500,\n \"averageMonthlyNetProfit\": 5500,\n \"netBurn\": 5500,\n \"runwayMonths\": 7.7\n }\n },\n \"receivables\": {\n \"totalOutstanding\": 1085,\n \"currentDueTotal\": 1085,\n \"overdueTotal\": 0,\n \"overdueCount\": 0,\n \"agingBuckets\": {\n \"notYetOverdue\": 1085,\n \"lessThanOrEqualTo30\": 0,\n \"between31And60\": 0,\n \"between61And90\": 0,\n \"moreThan90\": 0\n },\n \"topCustomersOutstanding\": [\n {\n \"uuid\": \"dfa3219e-6af8-4c53-997a-037534f63a35\",\n \"name\": \"Acme Corporation\",\n \"outstanding\": 1085\n }\n ],\n \"daysSalesOutstanding\": 12\n },\n \"payables\": {\n \"totalOutstanding\": 3200,\n \"outstandingBills\": 3200,\n \"dueInNext7Days\": 800,\n \"dueInNext30Days\": 2400,\n \"daysPayableOutstanding\": 18\n },\n \"taxObligations\": {\n \"isTaxRegistered\": false,\n \"taxRegime\": null,\n \"totalObligation\": 0,\n \"hasOverdueOrUpcomingFiling\": false,\n \"obligations\": [],\n \"lastFiledPeriodEnd\": null\n },\n \"connections\": {\n \"totalCount\": 2,\n \"activeCount\": 2,\n \"disconnectedCount\": 0,\n \"revokedCount\": 0,\n \"accountsAwaitingReauthCount\": 0,\n \"staleConnectionCount24h\": 0,\n \"oldestLastSyncAt\": \"2026-06-21T06:30:00.000Z\",\n \"byProvider\": {\n \"plaid\": 1,\n \"akahu\": 1\n }\n },\n \"asOf\": {\n \"computedAt\": \"2026-06-21T12:00:00.000Z\",\n \"cacheTtlSeconds\": 300,\n \"cashAsOf\": \"2026-06-21T08:00:00.000Z\",\n \"currency\": \"USD\",\n \"fromCache\": false\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "295d637e-6312-4091-886c-da3c17990e8a", "name": "Workspace context missing or invalid.", "originalRequest": { "url": { "path": [ "partners", "workspace-stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "include", "value": "cash,profitability,receivables" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7fd80ac9-8321-46e8-abc3-62fb5e36cc68", "name": "Missing or invalid HMAC signature, expired timestamp, or invalid Bearer token.", "originalRequest": { "url": { "path": [ "partners", "workspace-stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "include", "value": "cash,profitability,receivables" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "70c808d7-f5b3-4432-b638-52bddc760fd3", "name": "The credential does not have access to this workspace or resource.", "originalRequest": { "url": { "path": [ "partners", "workspace-stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "include", "value": "cash,profitability,receivables" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d73b707b-28dc-4fea-af4e-0d28a69784a5", "name": "Rate limit exceeded (100 requests per minute per clientId). Retry after the Retry-After header.", "originalRequest": { "url": { "path": [ "partners", "workspace-stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "include", "value": "cash,profitability,receivables" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-client-id", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const partnerMount = '/partners';", "const methodsWithBody = ['POST', 'PUT', 'PATCH'];", "", "const clientId = pm.collectionVariables.get('clientId') || '';", "const clientSecret = pm.collectionVariables.get('clientSecret') || '';", "const accessToken = pm.collectionVariables.get('accessToken') || '';", "", "const method = pm.request.method.toUpperCase();", "const fullPath = pm.request.url.getPath();", "const signingPath = fullPath.startsWith(partnerMount)", " ? (fullPath.slice(partnerMount.length) || '/')", " : fullPath;", "const timestamp = String(Math.floor(Date.now() / 1000));", "", "let bodyHash = '';", "if (methodsWithBody.includes(method) && pm.request.body && pm.request.body.raw && pm.request.body.raw.trim()) {", " const canonicalBody = JSON.stringify(JSON.parse(pm.request.body.raw));", " bodyHash = CryptoJS.SHA256(canonicalBody).toString(CryptoJS.enc.Hex);", "}", "", "const baseString = `${method}:${signingPath}:${timestamp}:${bodyHash}`;", "const signature = CryptoJS.HmacSHA256(baseString, clientSecret).toString(CryptoJS.enc.Hex);", "", "pm.request.headers.upsert({ key: 'x-client-id', value: clientId });", "pm.request.headers.upsert({ key: 'x-signature', value: signature });", "pm.request.headers.upsert({ key: 'x-timestamp', value: timestamp });", "", "if (accessToken) {", " pm.request.headers.upsert({ key: 'Authorization', value: `Bearer ${accessToken}` });", "}" ] } } ], "variable": [ { "type": "string", "value": "https://api.getcount.com", "key": "baseUrl" }, { "key": "clientId", "value": "", "type": "string" }, { "key": "clientSecret", "value": "", "type": "string" }, { "key": "accessToken", "value": "", "type": "string" } ], "info": { "_postman_id": "a3b278f2-fcc1-475e-8ca8-09db8187e9f7", "name": "COUNT Partner API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Official documentation for the COUNT Partner API — build accounting integrations with a consistent reference, guides, and tools.", "type": "text/plain" } } }