{"info":{"_postman_id":"2a5dc1b0-5561-42de-97b3-a973a06a5c09","name":"Kolleno - Open API v1","description":"<html><head></head><body><p>Welcome to Kolleno Open API - the best way to recover your late invoices fully integrated with your custom systems.</p>\n<p>Sending updated and real-time data to Kolleno is important to make sure the account managers always have the most up-to-date informations when they contact your customers.</p>\n<p>If you don't use one of our supported accounting software, you have the possibility to integrate directly into our Kolleno Open API.</p>\n<p>It is designed for companies that have custom-made systems and want to integrate directly with Kolleno in a seamless manner.</p>\n<h1 id=\"authentication\">Authentication</h1>\n<h2 id=\"overview\">Overview</h2>\n<p>The authentication is done with an API Key linked to your user. If you don't want it to be linked to your user, you can create a separate one just for the API Key (i.e. it won't be used in the User Interface).</p>\n<p>The API Key is made of a <code>client_id</code> and a <code>client_secret</code>.</p>\n<h2 id=\"add-the-key-to-your-request\">Add the key to your request</h2>\n<p>In the headers of your HTTP request, send the following:<br><code>Authorization: API client_id:client_secret</code></p>\n<p>The header key is <code>Authorization</code>, and the value is <code>API{blank space}</code> appended with the <code>client_id</code> and <code>client_secret</code> (please make sure these two are separated by a colon <code>:</code>)</p>\n<p>Example:<br>If your <code>client_id</code> is <code>89cc52b4-6433-4b25-8ea5-2f9d4a077552</code> and your <code>client_secret</code> is <code>oa1ObDJEtQebtu</code> then you would send:<br><code>Authorization: API 89cc52b4-6433-4b25-8ea5-2f9d4a077552:oa1ObDJEtQebtu</code></p>\n<h2 id=\"authenticate-in-postman\">Authenticate in Postman</h2>\n<p>The code examples included in this documentation do not include the headers to avoid repetition. However, if you use Postman, you can create environment variables: <a href=\"https://learning.postman.com/docs/sending-requests/managing-environments/#creating-environments\">https://learning.postman.com/docs/sending-requests/managing-environments/#creating-environments</a></p>\n<p>with the following variables: <code>client_id</code> and <code>client_secret</code></p>\n<p>The reason it works is because the \"Authorization\" tab in each request has the pre-selected option \"Inherit auth from parent\". See: <a href=\"https://learning.postman.com/docs/sending-requests/authorization/#inheriting-auth\">https://learning.postman.com/docs/sending-requests/authorization/#inheriting-auth</a></p>\n<p>In this Postman collection, the header has been defined in \"Pre-request Scripts\" at the collection level.</p>\n<h2 id=\"get-your-key\">Get your key</h2>\n<p>Please get in touch with your sales representative in order to get access to the API.</p>\n<h2 id=\"customer-portfolios\">Customer portfolios</h2>\n<p>If your Company restricts access to Customers by portfolio, an API Key only sees the Customers in the portfolios of the user it belongs to, and the records of these Customers. This does not apply to admin users.</p>\n<p>A Customer outside these portfolios gets the same response as a Customer that does not exist, usually <strong>404</strong>. Invoice PDFs and Invoice Custom Fields return <strong>403</strong>, and creating an Invoice or a Person for such a Customer returns <strong>400</strong>.</p>\n<h1 id=\"general-structure\">General structure</h1>\n<ul>\n<li><p>Companies are the organizations your user is part of.</p>\n</li>\n<li><p>Every Company has a number of Customers.</p>\n</li>\n<li><p>Every Customer has a number of Invoices and Persons (your point of contacts at your Customers).</p>\n</li>\n<li><p>Every Customer has a number of Transactions linked to any number of Invoices belonging to that same Customer.</p>\n</li>\n<li><p>Every Customer has a number of Credit Notes linked to any number of Invoices belonging to that same Customer.</p>\n</li>\n<li><p>Every Customer has a number of Card Details and DIrect Debit Details.</p>\n</li>\n</ul>\n<h1 id=\"changes-log\">Changes Log</h1>\n<p><em>2026-10-21</em> - (a) New endpoints to list the Workflows and the Templates. (b) Returning \"template\" on Email Sent objects. (c) List of Steps orders the Steps with the same \"date_event\" by \"id\", so paging with limit and offset does not skip or repeat them.</p>\n<p><em>2026-10-19</em> - (a) New endpoints to generate Report Files, get their status, list the Report Types and manage Report Schedules. (b) New endpoints to list and retrieve the Emails Sent. (c) Filter Invoices by \"payment_status\", \"payment_status__in\" and \"date_modified__gte\", and Customers by \"ref\". (d) Returning \"date_promise_to_pay_valid\" on Invoice objects (read-only). (e) Customer portfolios apply to all the endpoints. (f) The Match endpoints require reconciliation access.</p>\n<p><em>2026-10-13</em> - Customer PATCH can merge \"extra_data\": only the keys sent are updated, and a key sent as null is removed. Off by default, ask your Kolleno representative to turn it on.</p>\n<p><em>2026-10-05</em> - Optional query parameter ?source added to Customer endpoints, to retrieve, update or delete a Customer by its source_id.</p>\n<p><em>2026-09-29</em> - Added \"extra_data\" to Transaction object.</p>\n<p><em>2026-09-03 -</em> New endpoints to manage Tags and Tag Categories. Set and retrieve \"tags\" on Invoices.</p>\n<p><em>2026-06-01</em> - Limits the fields returned in the Customer endpoint with aprameter ?fields= for performance.</p>\n<p><em>2026-05-29</em> - List Reports generated and download a Report.</p>\n<p><em>2026-04-29 -</em> New endpoint to update Custom Fields on Invoice records.</p>\n<p><em>2026-03-19 -</em> Optional query parameters ?source and ?source_customer added to Person endpoints.</p>\n<p><em>2026-03-05 -</em> Added the 'Match' List and Retrieve endpoints. Move Person endpoint to using 'source_id' (backwards compatibility with 'external_id').</p>\n<p><em>2026-03-04</em> - Added <em>extra_data</em> to Invoice record (send any JSON formatted data).</p>\n<p><em>2026-01-13</em> - Send \"source_id\" to update custom fields.</p>\n<p><em>2025-10-27</em> - (a) New endpoint to retrieve the list of Position External. (b) New endpoints for linking Person &lt;&gt; Invoice. (c) Update \"pause_chasing\" of any Invoice.source. (d) Update \"primary\" and \"position_external\" of any Person.source.</p>\n<p><em>2024-11-18</em> - Set and retrieve \"warning_level\" on Customers.</p>\n<p><em>2024-09-25 -</em> Return \"date_created\" for Card Detail and Direct Debit Detail</p>\n<p><em>2024-05-21</em> - Ability to update the field \"extra_data\" for Customer object, no matter the source of the record.</p>\n<p><em>2024-04-04</em> - Returning \"balance\" field on Customer object (read-only)</p>\n<p><em>2024-03-08</em> - Set and retrieve \"persons\" on Invoices.</p>\n<p><em>2024-03-04</em> - Set and retrieve \"amount_remaining\" for Credit Notes.</p>\n<p><em>2023-12-27</em> - Ability to download a Credit Note PDF.</p>\n<p><em>2023-12-20</em> - Ability to upload an Invoice PDF by using its source_id.</p>\n<p><em>2023-12-18</em> - Added endpoint to download any invoice PDF.</p>\n<p><em>2023-11-17</em> - Filter CardDetail and DirectDebitDetail by \"customer__source_id\".</p>\n<p><em>2023-11-09</em> - Ability to filter by \"source_id\" on Card Detail and Direct Debit Detail list endpoints.</p>\n<p><em>2023-10-27</em> - Added endpoints to get the list of Card Details and Direct Debit Detail. For Customers and Invoices, replaced \"external_id\" by \"source_id\".</p>\n<p><em>2023-09-21</em> - Added an extra_field \"bank_account_setup_url\" for Customer GET endpoints.</p>\n<p><em>2023-08-28</em> - Added \"extra_fields\" value \"has_direct_debit_detail\" for Customer GET endpoints. Also added \"extra_fields\" for Timeline GET endpoint with possible values: \"contacts\" and \"content\".</p>\n<p><em>2023-08-23</em> - Return \"extra_fields\" for Customer GET endpoints. First field added: \"gocardless_customer_id\".</p>\n<p><em>2023-05-30</em> - Added endpoints to get the Customer Portal URL and the list of Steps from the timeline.</p>\n<p><em>2022-12-01</em> - Added field 'description' for the Invoice objects.</p>\n<p><em>2022-10-21</em> - Endpoint to get the persons by default returns all Persons in the Company, with possible filtering by ?customer=UUID.</p>\n<p><em>2022-07-04 -</em> Mark Transactions as \"prepayment\" or \"overpayment\". Record amount remaining to be credited on a pre/overpayment. Flag the transaction as \"paid\" or \"voided\".</p>\n<p><em>2022-02-14</em> - Added 'date_invoice' field for Invoice objects.</p>\n<p><em>2022-01-27</em> - Added Credit Notes endpoints to the Open API.</p>\n<p><em>2021-12-14</em> - Added 'ref' field for Customer object.</p>\n<p><em>2021-10-20</em> - Solved inconsistency where PPN was still documenting the UUID.</p>\n<p><em>2021-09-13</em> - Countries and Currencies updated with ISO code (2 characters for country, 3 characters for currency) rather than ID.</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"General structure","slug":"general-structure"},{"content":"Changes Log","slug":"changes-log"}],"owner":"43609274","collectionId":"2a5dc1b0-5561-42de-97b3-a973a06a5c09","publishedId":"2sBYAvvVnT","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-09-03T13:33:37.000Z"},"item":[{"name":"Card Detail","item":[{"name":"List Card Details","id":"b1736d9e-ecf3-400e-b5af-60fcd8d5b3d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/card-detail/:company/","urlObject":{"path":["card-detail",":company",""],"host":[""],"query":[{"disabled":true,"description":{"content":"<p>(optional) Filter to get only a specific Customer's Card Details</p>\n","type":"text/plain"},"key":"customer","value":"f6acf12f-84c2-46aa-9713-5776091e4bec"},{"disabled":true,"description":{"content":"<p>(optional) Filter to get only a specific source_id</p>\n","type":"text/plain"},"key":"source_id","value":"abc"},{"disabled":true,"description":{"content":"<p>(optional) Filter to get only a specific CUstomer's Card Detail (using the source ID)</p>\n","type":"text/plain"},"key":"customer__source_id","value":"def"}],"variable":[{"id":"9be48b83-eeee-4e6c-b926-279db014906d","description":{"content":"<p>Company the Cards belong to</p>\n","type":"text/plain"},"type":"any","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","key":"company"}]}},"response":[{"id":"e59244e3-706d-4263-aa67-8d94a6725408","name":"HTTP 403","originalRequest":{"method":"GET","header":[],"url":{"raw":"/card-detail/:company/","host":[""],"path":["card-detail",":company",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335113","description":"Company the Cards belong to"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 27 Oct 2023 15:57:05 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.11.2"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"63"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Vary","value":"origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You do not have permission to perform this action.\"\n}"},{"id":"7acaa486-19cf-43a4-8623-31a1f62952b1","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/card-detail/:company/","host":[""],"path":["card-detail",":company",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Cards belong to"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 27 Oct 2023 15:49:24 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.11.2"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"327"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Vary","value":"origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"count\": 1,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"aa1c171b-312b-4450-b09c-65e867f89640\",\n            \"customer\": \"f6acf12f-84c2-46aa-9713-5776091e4bec\",\n            \"card_issuer\": \"THE ROYAL BANK OF SCOTLAND PLC\",\n            \"card_number_mask\": \"454305******9982\",\n            \"exp_month\": \"0\",\n            \"exp_year\": \"0\",\n            \"country\": null,\n            \"source\": \"stripe\",\n            \"source_id\": \"card_1O5pFNGO2lY6Bbjqd4l7AQyO\",\n            \"is_valid\": true,\n            \"date_created\": \"2020-11-24T12:53:55.610255Z\"\n        },\n        {\n            \"id\": \"cd2d171b-812b-4450-b19c-65e867f81234\",\n            \"customer\": \"b7bcf12f-14c2-46aa-8713-5776091e4abc\",\n            \"card_issuer\": \"BANK OF AMERICA, N.A.\",\n            \"card_number_mask\": \"510305******7788\",\n            \"exp_month\": \"03\",\n            \"exp_year\": \"25\",\n            \"country\": \"US\",\n            \"source\": \"stripe\",\n            \"source_id\": \"card_1K5pJNGO3mZ6Bajqd4l7BxYO\",\n            \"is_valid\": false,\n            \"date_created\": \"2020-11-24T12:53:55.610829Z\"\n        }\n    ]\n}"}],"_postman_id":"b1736d9e-ecf3-400e-b5af-60fcd8d5b3d7"}],"id":"3800f074-07d1-4bfb-879f-46a9fb56806d","description":"<p>Card Details belong to a Customer.</p>\n<p>Example of an object:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"id\": \"cd2d171b-812b-4450-b19c-65e867f81234\",\n    \"customer\": \"b7bcf12f-14c2-46aa-8713-5776091e4abc\",\n    \"card_issuer\": \"BANK OF AMERICA, N.A.\",\n    \"card_number_mask\": \"510305******7788\",\n    \"exp_month\": \"03\",\n    \"exp_year\": \"25\",\n    \"country\": \"US\",\n    \"source\": \"stripe\",\n    \"source_id\": \"card_1K5pJNGO3mZ6Bajqd4l7BxYO\",\n    \"is_valid\": false,\n}\n\n</code></pre>\n","_postman_id":"3800f074-07d1-4bfb-879f-46a9fb56806d"},{"name":"Company","item":[{"name":"List Companies","id":"876f52fb-b284-4b28-b385-4811a13529e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/company/?limit=5&offset=0","description":"<p>Retrieve all the Companies your API key has access to. Ordered by \"date_created\".</p>\n","urlObject":{"path":["company",""],"host":[""],"query":[{"description":{"content":"<p>(optional) The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles.</p>\n","type":"text/plain"},"key":"limit","value":"5"},{"description":{"content":"<p>(optional) The offset indicates the starting position of the query in relation to the complete set of unpaginated items.</p>\n","type":"text/plain"},"key":"offset","value":"0"}],"variable":[]}},"response":[{"id":"2f2a9ec4-ea21-4ba3-8ad2-8d6cf9fd4f43","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/company/?limit=5&offset=0","host":[""],"path":["company",""],"query":[{"key":"limit","value":"5","description":"(optional) The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles."},{"key":"offset","value":"0","description":"(optional) The offset indicates the starting position of the query in relation to the complete set of unpaginated items."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 19:09:17 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"818"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"count\": 2,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"7017d236-cc07-44bc-bb86-8d0cd4335112\",\n            \"name\": \"Kolleno\",\n            \"address_line_1\": \"\",\n            \"address_line_2\": \"\",\n            \"postal_code\": \"\",\n            \"city\": \"\",\n            \"country\": \"US\",\n            \"currency\": \"USD\",\n            \"date_modified\": \"2021-01-06T17:43:21.549420Z\",\n            \"date_created\": \"2020-10-06T11:46:08.814501Z\"\n        },\n        {\n            \"id\": \"bbf097ff-1a08-4d91-90bf-53ae9805eb78\",\n            \"name\": \"Electricity Ltd\",\n            \"address_line_1\": \"\",\n            \"address_line_2\": \"\",\n            \"postal_code\": \"\",\n            \"city\": \"\",\n            \"country\": \"\",\n            \"currency\": \"\",\n            \"date_modified\": \"2021-01-06T17:42:58.122636Z\",\n            \"date_created\": \"2020-10-06T11:46:08.820445Z\"\n        }\n    ]\n}"}],"_postman_id":"876f52fb-b284-4b28-b385-4811a13529e2"},{"name":"Retrieve Company","id":"53aa65ca-6637-4052-b55b-c673e51ba440","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/company/:company/","description":"<p>Retrieve a specific Company.</p>\n","urlObject":{"path":["company",":company",""],"host":[""],"query":[],"variable":[{"id":"ef5ee692-27d9-47b9-8b35-eb77f418f92e","type":"any","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","key":"company"}]}},"response":[{"id":"8b68c200-099e-4386-b852-b1a1fdcc624d","name":"HTTP 403","originalRequest":{"method":"GET","header":[],"url":{"raw":"/company/:company/","host":[""],"path":["company",":company",""],"variable":[{"key":"company","value":"e1b3631d-fff4-4caf-bba6-dc7d12ec7222"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 17:44:29 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"63"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You do not have permission to perform this action.\"\n}"},{"id":"ca3410a0-abcd-454e-89b0-74f1010472ac","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/company/:company/","host":[""],"path":["company",":company",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 17:44:07 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"506"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"7017d236-cc07-44bc-bb86-8d0cd4335112\",\n    \"name\": \"Kolleno\",\n    \"address_line_1\": \"\",\n    \"address_line_2\": \"\",\n    \"postal_code\": \"\",\n    \"city\": \"\",\n    \"country\": \"US\",\n    \"currency\": \"USD\",\n    \"date_modified\": \"2021-01-06T17:43:21.549420Z\",\n    \"date_created\": \"2020-10-06T11:46:08.814501Z\"\n}"}],"_postman_id":"53aa65ca-6637-4052-b55b-c673e51ba440"}],"id":"4eb32cad-9603-461a-9c8f-5036ef26ca30","description":"<p>Companies are the central point of Kolleno. It is your organization to whom Customers are attached to. A user (API key) can have access to several Companies.</p>\n<p>Example of an object:</p>\n<pre>\n{\n    \"id\": \"7017d236-cc07-44bc-bb86-8d0cd4335112\",\n    \"name\": \"Kolleno\",\n    \"address_line_1\": \"\",\n    \"address_line_2\": \"\",\n    \"postal_code\": \"\",\n    \"city\": \"\",\n    \"country\": \"US\",\n    \"currency\": \"USD\",\n    \"date_modified\": \"2021-01-06T17:43:21.549420Z\",\n    \"date_created\": \"2020-10-06T11:46:08.814501Z\"\n}\n</pre>","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"9dc82f63-ba5e-47e6-96d5-1436a2293f10"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"21a43461-4dc2-4b64-a3b8-f309cc1cbabd"}}],"_postman_id":"4eb32cad-9603-461a-9c8f-5036ef26ca30"},{"name":"Credit Note","item":[{"name":"List Credit Notes","id":"e3adeb37-47d4-4423-a14c-4202914bf85c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/credit-note/:customer/?limit=5&offset=0","description":"<p>Retrieve all the Credit Notes for a given Customer. Ordered by \"date_created\".</p>\n","urlObject":{"path":["credit-note",":customer",""],"host":[""],"query":[{"description":{"content":"<p>(optional) The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles.</p>\n","type":"text/plain"},"key":"limit","value":"5"},{"description":{"content":"<p>(optional) The offset indicates the starting position of the query in relation to the complete set of unpaginated items.</p>\n","type":"text/plain"},"key":"offset","value":"0"}],"variable":[{"id":"74808c43-43b9-4f93-85c3-1e7c6da9e88e","description":{"content":"<p>Customer the Credit Notes belong to</p>\n","type":"text/plain"},"type":"any","value":"c72bb66d-088b-402f-b8d3-11688b12805c","key":"customer"}]}},"response":[{"id":"c800f573-0236-4941-aabb-e8aa55d0b751","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/credit-note/:customer/?limit=5&offset=0","host":[""],"path":["credit-note",":customer",""],"query":[{"key":"limit","value":"5","description":"(optional) The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles."},{"key":"offset","value":"0","description":"(optional) The offset indicates the starting position of the query in relation to the complete set of unpaginated items."}],"variable":[{"key":"customer","value":"c72bb66d-088b-402f-b8d3-11688b12805c","description":"Customer the Credit Notes belong to"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 27 Jan 2022 12:35:54 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"Cache-Control","value":"no-store"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"1059"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"count\": 3,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"ae1f0cf9-83a8-4448-aae4-6bc872ce7b20\",\n            \"customer\": \"c72bb66d-088b-402f-b8d3-11688b12805c\",\n            \"amount\": \"250.00\",\n            \"amount_remaining\": \"0.00\",\n            \"currency\": \"USD\",\n            \"ref\": \"1220-45\",\n            \"date_issued\": \"2021-01-10\",\n            \"source\": \"kolleno_api\",\n            \"date_modified\": \"2022-01-27T12:27:41.916108Z\",\n            \"date_created\": \"2022-01-27T12:27:41.916135Z\",\n            \"credit_note_invoices\": []\n        },\n        {\n            \"id\": \"f79df900-d7f6-47fc-a3a2-bd735bc7f45f\",\n            \"customer\": \"c72bb66d-088b-402f-b8d3-11688b12805c\",\n            \"amount\": \"123.65\",\n            \"amount_remaining\": \"0.00\",\n            \"currency\": \"USD\",\n            \"ref\": \"992-11\",\n            \"date_issued\": \"2022-02-03\",\n            \"source\": \"kolleno_api\",\n            \"date_modified\": \"2022-01-27T12:28:16.447122Z\",\n            \"date_created\": \"2022-01-27T12:28:16.447140Z\",\n            \"credit_note_invoices\": []\n        },\n        {\n            \"id\": \"bfb87c58-013b-4f5f-8cc4-0065026f4125\",\n            \"customer\": \"c72bb66d-088b-402f-b8d3-11688b12805c\",\n            \"amount\": \"123.65\",\n            \"amount_remaining\": \"0.00\",\n            \"currency\": \"USD\",\n            \"ref\": \"992-11\",\n            \"date_issued\": \"2022-02-03\",\n            \"source\": \"kolleno_api\",\n            \"date_modified\": \"2022-01-27T12:29:30.463500Z\",\n            \"date_created\": \"2022-01-27T12:29:30.463519Z\",\n            \"credit_note_invoices\": [\n                {\n                    \"invoice\": \"20d513ab-94d0-497d-a1d5-4fd0c8d42282\",\n                    \"amount\": \"250.00\"\n                }\n            ]\n        }\n    ]\n}"},{"id":"51070867-c490-436f-a839-9acc6a5377ad","name":"HTTP 403","originalRequest":{"method":"GET","header":[],"url":{"raw":"/credit-note/:customer/?limit=5&offset=0","host":[""],"path":["credit-note",":customer",""],"query":[{"key":"limit","value":"5","description":"(optional) The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles."},{"key":"offset","value":"0","description":"(optional) The offset indicates the starting position of the query in relation to the complete set of unpaginated items."}],"variable":[{"key":"customer","value":"4a29d3a7-84b3-45eb-aa43-f3f18195e076","description":"Customer the Credit Notes belong to"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 27 Jan 2022 12:36:30 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"Cache-Control","value":"no-store"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"63"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You do not have permission to perform this action.\"\n}"}],"_postman_id":"e3adeb37-47d4-4423-a14c-4202914bf85c"},{"name":"Retrieve Credit Note","id":"0697925f-69bc-4e83-b6d7-bc33099ddf27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/credit-note/:customer/:credit-note/","description":"<p>Retrieve a specific Credit Note</p>\n","urlObject":{"path":["credit-note",":customer",":credit-note",""],"host":[""],"query":[],"variable":[{"id":"881d8232-460e-4847-8700-67852f74eb5b","description":{"content":"<p>Customer the Credit Note belongs to</p>\n","type":"text/plain"},"type":"any","value":"4a29d3a7-84b3-45eb-aa43-f3f18195e076","key":"customer"},{"id":"e5064127-80bc-4c63-a7e5-414f758fd08a","description":{"content":"<p>ID of the Credit Note to retrieve</p>\n","type":"text/plain"},"type":"any","value":"ae1f0cf9-83a8-4448-aae4-6bc872ce7b20","key":"credit-note"}]}},"response":[{"id":"6428439f-0e07-4254-8cec-05b4448694af","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/credit-note/:customer/:credit-note/","host":[""],"path":["credit-note",":customer",":credit-note",""],"variable":[{"key":"customer","value":"c72bb66d-088b-402f-b8d3-11688b12805c","description":"Customer the Credit Note belongs to"},{"key":"credit-note","value":"ae1f0cf9-83a8-4448-aae4-6bc872ce7b20","description":"ID of the Credit Note to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 27 Jan 2022 12:37:23 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"Cache-Control","value":"no-store"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"313"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"ae1f0cf9-83a8-4448-aae4-6bc872ce7b20\",\n    \"customer\": \"c72bb66d-088b-402f-b8d3-11688b12805c\",\n    \"amount\": \"250.00\",\n    \"amount_remaining\": \"0.00\",\n    \"currency\": \"USD\",\n    \"ref\": \"1220-45\",\n    \"date_issued\": \"2021-01-10\",\n    \"source\": \"kolleno_api\",\n    \"date_modified\": \"2022-01-27T12:27:41.916108Z\",\n    \"date_created\": \"2022-01-27T12:27:41.916135Z\",\n    \"credit_note_invoices\": []\n}"},{"id":"6d2f857c-8372-40bf-9568-11e892cef7f7","name":"HTTP 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"/credit-note/:customer/:credit-note/","host":[""],"path":["credit-note",":customer",":credit-note",""],"variable":[{"key":"customer","value":"c72bb66d-088b-402f-b8d3-11688b12805c","description":"Customer the Credit Note belongs to"},{"key":"credit-note","value":"4a29d3a7-84b3-45eb-aa43-f3f18195e076","description":"ID of the Credit Note to retrieve"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 27 Jan 2022 12:37:45 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"Cache-Control","value":"no-store"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"23"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"Not found.\"\n}"},{"id":"b248b18c-d23a-43d2-87d1-2f96d545a887","name":"HTTP 403","originalRequest":{"method":"GET","header":[],"url":{"raw":"/credit-note/:customer/:credit-note/","host":[""],"path":["credit-note",":customer",":credit-note",""],"variable":[{"key":"customer","value":"4a29d3a7-84b3-45eb-aa43-f3f18195e076","description":"Customer the Credit Note belongs to"},{"key":"credit-note","value":"ae1f0cf9-83a8-4448-aae4-6bc872ce7b20","description":"ID of the Credit Note to retrieve"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 27 Jan 2022 12:38:17 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"Cache-Control","value":"no-store"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"63"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You do not have permission to perform this action.\"\n}"}],"_postman_id":"0697925f-69bc-4e83-b6d7-bc33099ddf27"},{"name":"Create Credit Note","id":"656753c5-27a5-45e0-b094-46d8d2a819e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"amount\": 123.65,\n    \"amount_remaining\": 0.00,\n    \"currency\": \"USD\",\n    \"credit_note_invoices\": [{\"invoice\": \"20d513ab-94d0-497d-a1d5-4fd0c8d42282\", \"amount\": 250.00}],\n    \"ref\": \"992-11\",\n    \"date_issued\": \"2022-02-03\"\n}","options":{"raw":{"language":"json"}}},"url":"/credit-note/:customer/","description":"<p>Create a Credit Note. It will set the field \"source\" to \"kolleno_api\" automatically.</p>\n<p>Info on parameters:</p>\n<pre>\n{\n    \"amount\": 250.00, // string or float\n    \"currency\": \"USD\", // string ISO\n    \"credit_note_invoices\": [\n        {\"invoice\": \"20d513ab-94d0-497d-a1d5-4fd0c8d42282\", \"amount\": 250.00}\n    ],  // list of \"invoices\" (UUID) and \"amount\" assigned to that invoice (string or float)\n    \"ref\": \"1220-45\", // string (255 characters), the reference for this Credit Note\n    \"date_paid\": \"2021-01-10\" // string YYYY-MM-DD (can be null)\n}\n</pre>","urlObject":{"path":["credit-note",":customer",""],"host":[""],"query":[],"variable":[{"id":"0a2e5a48-23b6-48d0-807c-db4e08086b72","description":{"content":"<p>Customer the Credit Note belongs to</p>\n","type":"text/plain"},"type":"any","value":"c72bb66d-088b-402f-b8d3-11688b12805c","key":"customer"}]}},"response":[{"id":"e443d7b5-f605-4695-8eb7-ebc43a6a392f","name":"HTTP 201","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"amount\": 250.00,\n    \"currency\": \"USD\",\n    \"credit_note_invoices\": [{\"invoice\": \"20d513ab-94d0-497d-a1d5-4fd0c8d42282\", \"amount\": 250.00}],\n    \"ref\": \"1135-01\",\n    \"date_issued\": \"2022-01-15\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/credit-note/:customer/","host":[""],"path":["credit-note",":customer",""],"variable":[{"key":"customer","value":"c72bb66d-088b-402f-b8d3-11688b12805c","description":"Customer the Credit Note belongs to"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 27 Jan 2022 12:29:50 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"Cache-Control","value":"no-store"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"381"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"87edd0b8-14c4-4cdc-a9ac-725ce2c49d70\",\n    \"customer\": \"c72bb66d-088b-402f-b8d3-11688b12805c\",\n    \"amount\": \"250.00\",\n    \"amount_remaining\": \"0.00\",\n    \"currency\": \"USD\",\n    \"ref\": \"1135-01\",\n    \"date_issued\": \"2022-01-15\",\n    \"source\": \"kolleno_api\",\n    \"date_modified\": \"2022-01-27T12:29:50.885988Z\",\n    \"date_created\": \"2022-01-27T12:29:50.886006Z\",\n    \"credit_note_invoices\": [\n        {\n            \"invoice\": \"20d513ab-94d0-497d-a1d5-4fd0c8d42282\",\n            \"amount\": \"250.00\"\n        }\n    ]\n}"},{"id":"34fd7460-3af2-4fbd-87a8-43503c430188","name":"HTTP 403","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"amount\": 250.00,\n    \"currency\": \"USD\",\n    \"credit_note_invoices\": [{\"invoice\": \"20d513ab-94d0-497d-a1d5-4fd0c8d42282\", \"amount\": 250.00}],\n    \"ref\": \"1135-01\",\n    \"date_issued\": \"2022-01-15\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/credit-note/:customer/","host":[""],"path":["credit-note",":customer",""],"variable":[{"key":"customer","value":"4a29d3a7-84b3-45eb-aa43-f3f18195e076","description":"Customer the Credit Note belongs to"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 27 Jan 2022 12:30:28 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"Cache-Control","value":"no-store"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"63"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You do not have permission to perform this action.\"\n}"}],"_postman_id":"656753c5-27a5-45e0-b094-46d8d2a819e7"},{"name":"Update Credit Note","id":"3b601a7f-85f0-463d-b244-c4d963a1fc33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n    \"amount\": 399.12,\n    \"amount_remaining\": 0.00,\n    \"currency\": \"USD\",\n    \"credit_note_invoices\": [{\"invoice\": \"20d513ab-94d0-497d-a1d5-4fd0c8d42282\", \"amount\": 103.28}],\n    \"ref\": \"1220-45\",\n    \"date_issued\": \"2021-01-10\"\n}","options":{"raw":{"language":"json"}}},"url":"/credit-note/:customer/:credit-note/","description":"<p>Update details about a specific Credit Note. You can only edit Credit Notes if \"source\" equals to: [\"manual\", \"kolleno_api\"]</p>\n","urlObject":{"path":["credit-note",":customer",":credit-note",""],"host":[""],"query":[],"variable":[{"id":"242efe4f-5a9c-4a31-9806-2b4c3c7a623e","description":{"content":"<p>Customer the Credit Note belong to</p>\n","type":"text/plain"},"type":"any","value":"c72bb66d-088b-402f-b8d3-11688b12805c","key":"customer"},{"id":"58cfc8e3-d806-4978-b0a1-b08502682701","description":{"content":"<p>ID of the Credit Note to update</p>\n","type":"text/plain"},"type":"any","value":"87edd0b8-14c4-4cdc-a9ac-725ce2c49d70","key":"credit-note"}]}},"response":[{"id":"7839fbe4-90df-4527-bfd3-7d7de00548c0","name":"HTTP 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n    \"amount\": 399.12,\n    \"currency\": \"USD\",\n    \"credit_note_invoices\": [{\"invoice\": \"20d513ab-94d0-497d-a1d5-4fd0c8d42282\", \"amount\": 103.28}],\n    \"ref\": \"1220-45\",\n    \"date_issued\": \"2021-01-10\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/credit-note/:customer/:credit-note/","host":[""],"path":["credit-note",":customer",":credit-note",""],"variable":[{"key":"customer","value":"c72bb66d-088b-402f-b8d3-11688b12805c","description":"Customer the Credit Note belong to"},{"key":"credit-note","value":"87edd0b8-14c4-4cdc-a9ac-725ce2c49d70","description":"ID of the Credit Note to update"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 27 Jan 2022 12:32:21 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"Cache-Control","value":"no-store"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"381"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"87edd0b8-14c4-4cdc-a9ac-725ce2c49d70\",\n    \"customer\": \"c72bb66d-088b-402f-b8d3-11688b12805c\",\n    \"amount\": \"399.12\",\n    \"amount_remaining\": \"0.00\",\n    \"currency\": \"USD\",\n    \"ref\": \"1220-45\",\n    \"date_issued\": \"2021-01-10\",\n    \"source\": \"kolleno_api\",\n    \"date_modified\": \"2022-01-27T12:32:21.545235Z\",\n    \"date_created\": \"2022-01-27T12:29:50.886006Z\",\n    \"credit_note_invoices\": [\n        {\n            \"invoice\": \"20d513ab-94d0-497d-a1d5-4fd0c8d42282\",\n            \"amount\": \"250.00\"\n        }\n    ]\n}"},{"id":"308b1d50-004c-4c57-8034-775e32e44821","name":"HTTP 404","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n    \"amount\": 399.12,\n    \"currency\": \"USD\",\n    \"credit_note_invoices\": [{\"invoice\": \"20d513ab-94d0-497d-a1d5-4fd0c8d42282\", \"amount\": 103.28}],\n    \"ref\": \"1220-45\",\n    \"date_issued\": \"2021-01-10\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/credit-note/:customer/:credit-note/","host":[""],"path":["credit-note",":customer",":credit-note",""],"variable":[{"key":"customer","value":"c72bb66d-088b-402f-b8d3-11688b12805c","description":"Customer the Credit Note belong to"},{"key":"credit-note","value":"4a29d3a7-84b3-45eb-aa43-f3f18195e076","description":"ID of the Credit Note to update"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 27 Jan 2022 12:32:46 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"Cache-Control","value":"no-store"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"23"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"Not found.\"\n}"},{"id":"3e9845ab-c5a6-4055-87b6-0644b2710092","name":"HTTP 403","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n    \"amount\": 399.12,\n    \"currency\": \"USD\",\n    \"credit_note_invoices\": [{\"invoice\": \"20d513ab-94d0-497d-a1d5-4fd0c8d42282\", \"amount\": 103.28}],\n    \"ref\": \"1220-45\",\n    \"date_issued\": \"2021-01-10\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/credit-note/:customer/:credit-note/","host":[""],"path":["credit-note",":customer",":credit-note",""],"variable":[{"key":"customer","value":"4a29d3a7-84b3-45eb-aa43-f3f18195e076","description":"Customer the Credit Note belong to"},{"key":"credit-note","value":"87edd0b8-14c4-4cdc-a9ac-725ce2c49d70","description":"ID of the Credit Note to update"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 27 Jan 2022 12:33:16 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"Cache-Control","value":"no-store"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"63"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You do not have permission to perform this action.\"\n}"}],"_postman_id":"3b601a7f-85f0-463d-b244-c4d963a1fc33"},{"name":"Delete Credit Note","id":"6b2feebc-cae4-48f3-9a16-a7e9eb86d4f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"/credit-note/:customer/:credit-note/","description":"<p>Permanently delete a specific Credit Note. You can only delete Credit Notes if \"source\" equals to: [\"manual\", \"kolleno_api\"]</p>\n","urlObject":{"path":["credit-note",":customer",":credit-note",""],"host":[""],"query":[],"variable":[{"id":"57231224-bb06-4732-bb31-acd4b3d01962","description":{"content":"<p>Customer the Credit Note belong to</p>\n","type":"text/plain"},"type":"any","value":"c72bb66d-088b-402f-b8d3-11688b12805c","key":"customer"},{"id":"d563f41e-4e79-4c39-86b0-9e5f2d81563c","description":{"content":"<p>ID of the Credit Note to delete</p>\n","type":"text/plain"},"type":"any","value":"4a29d3a7-84b3-45eb-aa43-f3f18195e076","key":"credit-note"}]}},"response":[{"id":"b76c67c2-d9b9-447d-8729-21a504485381","name":"HTTP 204","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/credit-note/:customer/:credit-note/","host":[""],"path":["credit-note",":customer",":credit-note",""],"variable":[{"key":"customer","value":"c72bb66d-088b-402f-b8d3-11688b12805c","description":"Customer the Credit Note belong to"},{"key":"credit-note","value":"87edd0b8-14c4-4cdc-a9ac-725ce2c49d70","description":"ID of the Credit Note to delete"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Thu, 27 Jan 2022 12:34:49 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"Cache-Control","value":"no-store"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":""},{"id":"8dd7c281-91df-43ba-a8bd-3bdd4fe79f47","name":"HTTP 404","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/credit-note/:customer/:credit-note/","host":[""],"path":["credit-note",":customer",":credit-note",""],"variable":[{"key":"customer","value":"c72bb66d-088b-402f-b8d3-11688b12805c","description":"Customer the Credit Note belong to"},{"key":"credit-note","value":"4a29d3a7-84b3-45eb-aa43-f3f18195e076","description":"ID of the Credit Note to delete"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 27 Jan 2022 12:35:15 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"Cache-Control","value":"no-store"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"23"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"Not found.\"\n}"}],"_postman_id":"6b2feebc-cae4-48f3-9a16-a7e9eb86d4f5"}],"id":"7ab1bdaa-b841-4f8c-bf6f-57eb4e4d4c27","description":"<p>The Credit Notes (or 'Credit Memos') belong to a Customer but have Invoices related to them.</p>\n<p>Example of an object:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>{\n    \"id\": \"05d5a320-bbb3-4250-b81c-984079dedb7f\",\n    \"customer\": \"c72bb66d-088b-402f-b8d3-11688b12805c\",\n    \"amount\": \"250.00\",\n    \"amount_remaining\": \"0.00\", // unallocated amount\n    \"currency\": \"USD\",\n    \"ref\": \"1220-45\",\n    \"date_issued\": \"2020-11-01\",\n    \"source\": \"kolleno_api\",\n    \"date_modified\": \"2020-11-24T12:53:55.687545Z\",\n    \"date_created\": \"2020-11-24T12:53:55.687564Z\",\n    \"credit_note_invoices\": [\n        {\n            \"invoice\": \"20d513ab-94d0-497d-a1d5-4fd0c8d42282\",\n            \"amount\": \"200.00\" // amount of the Credit Note that was assigned to this Invoice\n        },\n        {\n            \"invoice\": \"4a29d3a7-84b3-45eb-aa43-f3f18195e076\",\n            \"amount\": \"50.00\" // amount of the Credit Note that was assigned to this Invoice\n        }\n    ]\n}\n\n</code></pre>","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"3dcb80b3-b627-44de-8d6b-a14df80f61ac"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"77ec1e86-b4b5-4c85-a8f2-f393fcd4b5d8"}}],"_postman_id":"7ab1bdaa-b841-4f8c-bf6f-57eb4e4d4c27"},{"name":"Credit Note PDF","item":[{"name":"Download Credit Note PDF","id":"8c8046de-8078-48a9-bdab-e43102efea9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"/credit-note/pdf/:company/:credit-note/","urlObject":{"path":["credit-note","pdf",":company",":credit-note",""],"host":[""],"query":[{"disabled":true,"description":{"content":"<p>(optional) Pass ?id_from=source when the Credit Note ID in the URL is not the Kolleno ID but the source ID</p>\n","type":"text/plain"},"key":"id_from","value":"source"}],"variable":[{"id":"025b809a-6031-4c19-8f4b-89b3ba2b3382","type":"any","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","key":"company"},{"id":"c1c3707b-d077-4fbc-a3e7-467254435daa","type":"any","value":"e6b29da2-098b-4550-b0fb-71f9fdde9884","key":"credit-note"}]}},"response":[],"_postman_id":"8c8046de-8078-48a9-bdab-e43102efea9b"}],"id":"4e567043-6de7-4308-ba49-b575027233c8","description":"<p>Every Credit Note can have up to one PDF.</p>\n","_postman_id":"4e567043-6de7-4308-ba49-b575027233c8"},{"name":"Customer","item":[{"name":"List Customers","id":"92894a77-089b-4f13-88ba-af80065f4c25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/customer/:company/?fields=source_id,balance","description":"<p>Retrieve all the Customers in a given Company. Ordered by \"date_created\".</p>\n","urlObject":{"path":["customer",":company",""],"host":[""],"query":[{"disabled":true,"description":{"content":"<p>(optional) The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles.</p>\n","type":"text/plain"},"key":"limit","value":"5"},{"disabled":true,"description":{"content":"<p>(optional) The offset indicates the starting position of the query in relation to the complete set of unpaginated items.</p>\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"<p>(optional) Filter to get only a specific source_id</p>\n","type":"text/plain"},"key":"source_id","value":"abc"},{"disabled":true,"description":{"content":"<p>(optional) Filter to get only the Customers with a specific ref (exact match)</p>\n","type":"text/plain"},"key":"ref","value":"CUST-0042"},{"description":{"content":"<p>(optional) Restrict the response to only the named fields (comma separated). When set, this is the single source of truth: it limits the returned fields AND prunes the underlying SQL query to fetch only those columns, so responses are smaller and faster. It can also opt-in extra fields (gocardless_customer_id, has_direct_debit_detail, bank_account_setup_url) directly, with no need for ?extra_fields=. <code>id</code> is always included; unknown field names are silently ignored. </p>\n","type":"text/plain"},"key":"fields","value":"source_id,balance"},{"disabled":true,"description":{"content":"<p>(optional) Get additional fields in the response (comma separated)</p>\n","type":"text/plain"},"key":"extra_fields","value":"gocardless_customer_id,has_direct_debit_detail,bank_account_setup_url"}],"variable":[{"id":"67b60615-ce95-4631-996a-d33598b27c69","description":{"content":"<p>Company the Customer belongs to</p>\n","type":"text/plain"},"type":"any","value":"b91f62cc-02fc-458a-b5dd-546ae748151c","key":"company"}]}},"response":[{"id":"ef4a5f81-70c7-45f5-9b8f-f02532d1ab8c","name":"HTTP 403","originalRequest":{"method":"GET","header":[],"url":{"raw":"/customer/:company/?limit=5&offset=0","host":[""],"path":["customer",":company",""],"query":[{"key":"limit","value":"5","description":"(optional) The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles."},{"key":"offset","value":"0","description":"(optional) The offset indicates the starting position of the query in relation to the complete set of unpaginated items."}],"variable":[{"key":"company","value":"4a29d3a7-84b3-45eb-aa43-f3f18195e076","description":"Company the Customer belongs to"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Jan 2021 13:21:25 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"63"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You do not have permission to perform this action.\"\n}"},{"id":"29fb732e-a1b7-4d6f-8a97-3d0f958dc0f7","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/customer/:company/?limit=5&offset=0","host":[""],"path":["customer",":company",""],"query":[{"key":"limit","value":"5","description":"(optional) The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles."},{"key":"offset","value":"0","description":"(optional) The offset indicates the starting position of the query in relation to the complete set of unpaginated items."}],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Customer belongs to"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Jan 2021 13:21:10 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"2508"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"count\": 15,\n    \"next\": \"https://api.kolleno.com/v1/customer/7017d236-cc07-44bc-bb86-8d0cd4335112/?limit=5&offset=5\",\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"b703ea7c-5463-4f82-bfeb-e5c14bed37ef\",\n            \"name\": \"Bayside Club\",\n            \"address_line_1\": \"P O Box 3354\",\n            \"address_line_2\": \"South Mailing Centre\",\n            \"postal_code\": \"MA12 VL3\",\n            \"city\": \"Oaktown\",\n            \"state\": \"Madeupville\",\n            \"country\": \"US\",\n            \"ref\": \"\",\n            \"currency\": \"USD\",\n            \"balance\": \"45.67\",\n            \"pause_chasing\": false,\n            \"warning_level\": 0,\n            \"extra_data\": {},\n            \"source\": \"xero\",\n            \"source_id\": \"524aa975-17d1-4bfd-acf3-4efba8fc3091\",\n            \"date_modified\": \"2020-11-24T12:53:55.610239Z\",\n            \"date_created\": \"2020-11-24T12:53:55.610255Z\"\n        },\n        {\n            \"id\": \"a4c1a484-102d-45db-80cb-e20b2da985e8\",\n            \"name\": \"Marine Systems\",\n            \"address_line_1\": \"145 Longdale Way\",\n            \"address_line_2\": \"\",\n            \"postal_code\": \"CP89 TN8\",\n            \"city\": \"Coppertown\",\n            \"state\": \"\",\n            \"country\": \"\",\n            \"ref\": \"\",\n            \"currency\": \"USD\",\n            \"balance\": \"96383.00\",\n            \"pause_chasing\": false,\n            \"warning_level\": 0,\n            \"extra_data\": {},\n            \"source\": \"xero\",\n            \"source_id\": \"e4c9888b-4f81-475a-b099-b649616deaac\",\n            \"date_modified\": \"2020-11-24T12:53:55.610535Z\",\n            \"date_created\": \"2020-11-24T12:53:55.610546Z\"\n        },\n        {\n            \"id\": \"8b718009-129d-4a70-ae51-6e97207a4ade\",\n            \"name\": \"Basket Case\",\n            \"address_line_1\": \"\",\n            \"address_line_2\": \"\",\n            \"postal_code\": \"\",\n            \"city\": \"\",\n            \"state\": \"\",\n            \"country\": \"\",\n            \"ref\": \"\",\n            \"currency\": \"USD\",\n            \"pause_chasing\": false,\n            \"warning_level\": 0,\n            \"extra_data\": {},\n            \"source\": \"xero\",\n            \"source_id\": \"c5ec596a-782a-4368-ad40-eb121e160a3b\",\n            \"date_modified\": \"2020-11-24T12:53:55.610640Z\",\n            \"date_created\": \"2020-11-24T12:53:55.610648Z\"\n        },\n        {\n            \"id\": \"ad7ec99a-57d6-4a68-a047-710ff7b5c82d\",\n            \"name\": \"City Limousines\",\n            \"address_line_1\": \"\",\n            \"address_line_2\": \"\",\n            \"postal_code\": \"\",\n            \"city\": \"\",\n            \"state\": \"\",\n            \"country\": \"\",\n            \"ref\": \"\",\n            \"currency\": \"USD\",\n            \"balance\": \"235235.67\",\n            \"pause_chasing\": false,\n            \"warning_level\": 0,\n            \"extra_data\": {},\n            \"source\": \"xero\",\n            \"source_id\": \"902c6f01-aeaf-44a8-84fb-2b136e0cf09c\",\n            \"date_modified\": \"2020-11-24T12:53:55.610732Z\",\n            \"date_created\": \"2020-11-24T12:53:55.610740Z\"\n        },\n        {\n            \"id\": \"680f9add-7579-4613-a086-dc1e91664819\",\n            \"name\": \"Port & Philip Freight\",\n            \"address_line_1\": \"\",\n            \"address_line_2\": \"\",\n            \"postal_code\": \"\",\n            \"city\": \"\",\n            \"state\": \"\",\n            \"country\": \"\",\n            \"ref\": \"\",\n            \"currency\": \"USD\",\n            \"balance\": \"2134254.56\",\n            \"pause_chasing\": false,\n            \"warning_level\": 0,\n            \"extra_data\": {},\n            \"source\": \"xero\",\n            \"source_id\": \"76624c6c-fac8-41e3-ada5-e0aba8d7ce2f\",\n            \"date_modified\": \"2020-11-24T12:53:55.610822Z\",\n            \"date_created\": \"2020-11-24T12:53:55.610829Z\"\n        }\n    ]\n}"}],"_postman_id":"92894a77-089b-4f13-88ba-af80065f4c25"},{"name":"Retrieve Customer","id":"3562ce29-25af-4258-9d97-540a44c5df14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/customer/:company/:customer/","description":"<p>Retrieve a specific Customer</p>\n","urlObject":{"path":["customer",":company",":customer",""],"host":[""],"query":[{"disabled":true,"description":{"content":"<p>(optional) Get additional fields in the response (comma separated)</p>\n","type":"text/plain"},"key":"extra_fields","value":"gocardless_customer_id,has_direct_debit_detail,bank_account_setup_url"}],"variable":[{"id":"9f9b295e-25c8-4164-a47e-a1e9e74b5a83","description":{"content":"<p>Company the Customer belongs to</p>\n","type":"text/plain"},"type":"any","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","key":"company"},{"id":"3382d8a8-fb8f-4d22-aa6f-28a17f0add40","description":{"content":"<p>ID of the Customer to retrieve</p>\n","type":"text/plain"},"type":"any","value":"72bdecef-cfc4-4695-bcdd-41f4da1c8b5e","key":"customer"}]}},"response":[{"id":"173665d2-429e-4983-af65-4b460e4531be","name":"HTTP 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"/customer/:company/:customer/","host":[""],"path":["customer",":company",":customer",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Customer belongs to"},{"key":"customer","value":"wrong_uuid","description":"ID of the Customer to retrieve"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 13:31:20 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"23"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"Not found.\"\n}"},{"id":"0785b60d-673c-4cf1-a544-aeb78799b920","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/customer/:company/:customer/","host":[""],"path":["customer",":company",":customer",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Customer belongs to"},{"key":"customer","value":"72bdecef-cfc4-4695-bcdd-41f4da1c8b5e","description":"ID of the Customer to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 13:30:45 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"650"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"72bdecef-cfc4-4695-bcdd-41f4da1c8b5e\",\n    \"name\": \"Bank West\",\n    \"address_line_1\": \"Procurement Services\",\n    \"address_line_2\": \"GPO 12345\",\n    \"postal_code\": \"PI98 7HV\",\n    \"city\": \"Pinehaven\",\n    \"state\": \"Montreal\",\n    \"country\": \"US\",\n    \"ref\": \"ABC\",\n    \"currency\": \"USD\",\n    \"balance\": \"2354.67\",\n    \"pause_chasing\": false,\n    \"warning_level\": 0,\n    \"extra_data\": {},\n    \"source\": \"kolleno_api\",\n    \"source_id\": \"my_company_ref\",\n    \"date_modified\": \"2021-01-06T11:40:35.748841Z\",\n    \"date_created\": \"2020-11-24T12:53:55.611646Z\"\n}"}],"_postman_id":"3562ce29-25af-4258-9d97-540a44c5df14"},{"name":"Create Customer","id":"e205ff5f-a93c-49c5-a637-9f2c50aa7bf9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Bank West","description":"<p>string (255 characters)</p>\n","type":"text","contentType":""},{"key":"address_line_1","value":"Procurement Services","description":"<p>string (255 characters)</p>\n","type":"text"},{"key":"address_line_2","value":"GPO 12345","description":"<p>string (255 characters)</p>\n","type":"text"},{"key":"postal_code","value":"PI98 7HV","description":"<p>string (255 characters)</p>\n","type":"text"},{"key":"city","value":"Pinehaven","description":"<p>string (255 characters)</p>\n","type":"text"},{"key":"state","value":"Montreal","description":"<p>string (255 characters)</p>\n","type":"text"},{"key":"country","value":"{{country}}","description":"<p>ISO2 of the country</p>\n","type":"text"},{"key":"source_id","value":"my_company_ref","description":"<p>ID in your system so you can keep track of the Customer</p>\n","type":"text"},{"key":"ref","value":"ABC","description":"<p>Reference for this Customer (user friendly reference)</p>\n","type":"text"},{"key":"currency","value":"{{currency}}","description":"<p>ISO of the currency</p>\n","type":"text"},{"key":"pause_chasing","value":"false","description":"<p>Boolean (true/false)</p>\n","type":"text"},{"key":"warning_level","value":"1","description":"<p>Integer corresponding to the customer strike level</p>\n","type":"text"},{"key":"extra_data","value":"{}","description":"<p>JSON dictionary</p>\n","type":"text"}]},"url":"/customer/:company/","description":"<p>Create a Customer. It will set the field \"source\" to \"kolleno_api\" automatically.</p>\n","urlObject":{"path":["customer",":company",""],"host":[""],"query":[],"variable":[{"id":"404db211-25e9-4d94-833d-e6ea058e47e6","description":{"content":"<p>Company the Customer belongs to</p>\n","type":"text/plain"},"type":"any","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","key":"company"}]}},"response":[{"id":"6c8d52cf-4216-41d8-8828-abbe1117a98f","name":"HTTP 400","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Bank West","description":"string (255 characters)","type":"text","contentType":"","disabled":true},{"key":"address_line_1","value":"Procurement Services","description":"string (255 characters)","type":"text"},{"key":"address_line_2","value":"GPO 12345","description":"string (255 characters)","type":"text"},{"key":"postal_code","value":"PI98 7HV","description":"string (255 characters)","type":"text"},{"key":"city","value":"Pinehaven","description":"string (255 characters)","type":"text"},{"key":"state","value":"Montreal","description":"string (255 characters)","type":"text"},{"key":"country","value":"{{country}}","description":"UUID from /v1/metacontent/country/","type":"text"},{"key":"external_id","value":"my_company_ref","description":"Reference in your system so you can keep track of the Customer","type":"text"},{"key":"currency","value":"{{currency}}","description":"UUID from /v1/metacontent/currency/","type":"text"},{"key":"pause_chasing","value":"false","description":"Boolean (true/false)","type":"text"}]},"url":{"raw":"/customer/:company/","host":[""],"path":["customer",":company",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Customer belongs to"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 13:49:33 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"36"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"name\": [\n        \"This field is required.\"\n    ]\n}"},{"id":"f82f5c56-ec5d-4987-9b79-65ad0ff3cc6c","name":"HTTP 201","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Bank West","description":"string (255 characters)","type":"text","contentType":""},{"key":"address_line_1","value":"Procurement Services","description":"string (255 characters)","type":"text"},{"key":"address_line_2","value":"GPO 12345","description":"string (255 characters)","type":"text"},{"key":"postal_code","value":"PI98 7HV","description":"string (255 characters)","type":"text"},{"key":"city","value":"Pinehaven","description":"string (255 characters)","type":"text"},{"key":"state","value":"Montreal","description":"string (255 characters)","type":"text"},{"key":"country","value":"{{country}}","description":"ISO2 of the country","type":"text"},{"key":"external_id","value":"my_company_ref","description":"Reference in your system so you can keep track of the Customer","type":"text"},{"key":"ref","value":"ABC","description":"Reference for this Customer (user friendly reference)","type":"text"},{"key":"currency","value":"{{currency}}","description":"ISO of the currency","type":"text"},{"key":"pause_chasing","value":"false","description":"Boolean (true/false)","type":"text"},{"key":"warning_level","value":"0","description":"Positive integer corresponding to the customer strike level","type":"text"},{"key":"extra_data","value":"{}","description":"JSON dictionary","type":"text"}]},"url":{"raw":"/customer/:company/","host":[""],"path":["customer",":company",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Customer belongs to"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 11:40:44 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"650"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"840cbb48-f30a-4b26-98d0-5c7252515d7a\",\n    \"name\": \"Bank West\",\n    \"address_line_1\": \"Procurement Services\",\n    \"address_line_2\": \"GPO 12345\",\n    \"postal_code\": \"PI98 7HV\",\n    \"city\": \"Pinehaven\",\n    \"state\": \"Montreal\",\n    \"country\": \"US\",\n    \"ref\": \"ABC\",\n    \"currency\": \"USD\",\n    \"balance\": \"45.67\",\n    \"pause_chasing\": false,\n    \"warning_level\": 0,\n    \"extra_data\": {},\n    \"source\": \"kolleno_api\",\n    \"source_id\": \"my_company_ref\",\n    \"date_modified\": \"2021-01-06T11:40:44.547605Z\",\n    \"date_created\": \"2021-01-06T11:40:44.547631Z\"\n}"}],"_postman_id":"e205ff5f-a93c-49c5-a637-9f2c50aa7bf9"},{"name":"Update Customer","id":"96aef6a9-ab71-439c-a2d5-379373682f92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"formdata","formdata":[{"contentType":"","description":"<p>string (255 characters)</p>\n","key":"name","type":"text","value":"Bank West"},{"description":"<p>string (255 characters)</p>\n","key":"address_line_1","type":"text","value":"Procurement Services"},{"description":"<p>string (255 characters)</p>\n","key":"address_line_2","type":"text","value":"GPO 12345"},{"description":"<p>string (255 characters)</p>\n","key":"postal_code","type":"text","value":"PI98 7HV"},{"description":"<p>string (255 characters)</p>\n","key":"city","type":"text","value":"Pinehaven"},{"description":"<p>string (255 characters)</p>\n","key":"state","type":"text","value":"Montreal"},{"description":"<p>ISO2 of the country</p>\n","key":"country","type":"text","value":"{{country}}"},{"description":"<p>ID in your system so you can keep track of the Customer</p>\n","key":"source_id","type":"text","value":"my_company_ref"},{"key":"ref","value":"ABC","description":"<p>Reference for this Customer (user friendly reference)</p>\n","type":"text"},{"description":"<p>ISO of the currency</p>\n","key":"currency","type":"text","value":"{{currency}}"},{"description":"<p>Boolean (true/false)</p>\n","key":"pause_chasing","type":"text","value":"false"},{"key":"warning_level","value":"1","description":"<p>Integer corresponding to the customer strike level</p>\n","type":"text"},{"key":"extra_data","value":"{}","description":"<p>JSON dictionary. Replaces the stored object, or merges into it when merge mode is on.</p>\n","type":"text"}]},"url":"/customer/:company/:customer/","description":"<p>Update details about a specific Customer. You can only edit customers if \"source\" equals to: [\"manual\", \"kolleno_api\"] OR if you update the field \"extra_data\".</p>\n<p><strong>extra_data on PATCH</strong></p>\n<p>By default, PATCH replaces the full \"extra_data\" object with the object you send.</p>\n<p>Your Kolleno representative can turn on merge mode for your company. With merge mode on:</p>\n<ul>\n<li><p>Keys you send are added or updated.</p>\n</li>\n<li><p>Keys you do not send keep their values.</p>\n</li>\n<li><p>A key sent as <code>null</code> is removed.</p>\n</li>\n<li><p>Only top-level keys are merged. A nested object is replaced as a whole.</p>\n</li>\n<li><p>An empty object <code>{}</code> changes nothing.</p>\n</li>\n<li><p>PUT does not merge. It always replaces the full object.</p>\n</li>\n<li><p>It works with the customer UUID and with <code>?source=</code>.</p>\n</li>\n</ul>\n<p>Example with merge mode on. Stored value:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\"a\": \"0\", \"b\": \"2\", \"c\": \"3\"}\n\n</code></pre>\n<p>Request body:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\"extra_data\": {\"a\": \"1\", \"c\": null}}\n\n</code></pre>\n<p>Result:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\"a\": \"1\", \"b\": \"2\"}\n\n</code></pre>\n","urlObject":{"path":["customer",":company",":customer",""],"host":[""],"query":[],"variable":[{"description":{"content":"<p>Company the Customer belongs to</p>\n","type":"text/plain"},"type":"any","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","key":"company"},{"description":{"content":"<p>ID of the Customer to update</p>\n","type":"text/plain"},"type":"any","value":"72bdecef-cfc4-4695-bcdd-41f4da1c8b5e","key":"customer"}]}},"response":[{"id":"17fca8a3-a3e8-4851-a9b8-0986d6578981","name":"HTTP 404","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"formdata","formdata":[{"contentType":"","description":"string (255 characters)","key":"name","type":"text","value":"Bank West"},{"description":"string (255 characters)","key":"address_line_1","type":"text","value":"Procurement Services"},{"description":"string (255 characters)","key":"address_line_2","type":"text","value":"GPO 12345"},{"description":"string (255 characters)","key":"postal_code","type":"text","value":"PI98 7HV"},{"description":"string (255 characters)","key":"city","type":"text","value":"Pinehaven"},{"description":"string (255 characters)","key":"state","type":"text","value":"Montreal"},{"description":"UUID from /v1/metacontent/country/","key":"country","type":"text","value":"{{country}}"},{"description":"Reference in your system so you can keep track of the Customer","key":"external_ref","type":"text","value":"my_company_ref"},{"description":"UUID from /v1/metacontent/currency/","key":"currency","type":"text","value":"{{currency}}"},{"description":"Boolean (true/false)","key":"pause_chasing","type":"text","value":"false"}]},"url":{"raw":"/customer/:company/:customer/","host":[""],"path":["customer",":company",":customer",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Customer belongs to"},{"key":"customer","value":"wrong_uuid","description":"ID of the Customer to update"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 13:48:16 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"23"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"Not found.\"\n}"},{"id":"bd086a49-4695-43ee-895e-8cacadea8f77","name":"HTTP 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"formdata","formdata":[{"contentType":"","description":"string (255 characters)","key":"name","type":"text","value":"Bank West"},{"description":"string (255 characters)","key":"address_line_1","type":"text","value":"Procurement Services"},{"description":"string (255 characters)","key":"address_line_2","type":"text","value":"GPO 12345"},{"description":"string (255 characters)","key":"postal_code","type":"text","value":"PI98 7HV"},{"description":"string (255 characters)","key":"city","type":"text","value":"Pinehaven"},{"description":"string (255 characters)","key":"state","type":"text","value":"Montreal"},{"description":"ISO2 of the country","key":"country","type":"text","value":"{{country}}"},{"description":"ID in your system so you can keep track of the Customer","key":"external_id","type":"text","value":"my_company_ref"},{"key":"ref","value":"ABC","description":"Reference for this Customer (user friendly reference)","type":"text"},{"description":"ISO of the currency","key":"currency","type":"text","value":"{{currency}}"},{"description":"Boolean (true/false)","key":"pause_chasing","type":"text","value":"false"},{"key":"warning_level","value":"1","description":"Positive integer corresponding to the customer strike level","type":"text"},{"key":"extra_data","value":"{}","description":"JSON dictionary","type":"text"}]},"url":{"raw":"/customer/:company/:customer/","host":[""],"path":["customer",":company",":customer",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Customer belongs to"},{"key":"customer","value":"72bdecef-cfc4-4695-bcdd-41f4da1c8b5e","description":"ID of the Customer to update"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 13:47:26 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"650"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"72bdecef-cfc4-4695-bcdd-41f4da1c8b5e\",\n    \"name\": \"Bank West\",\n    \"address_line_1\": \"Procurement Services\",\n    \"address_line_2\": \"GPO 12345\",\n    \"postal_code\": \"PI98 7HV\",\n    \"city\": \"Pinehaven\",\n    \"state\": \"Montreal\",\n    \"country\": \"USD\",\n    \"ref\": \"ABC\",\n    \"currency\": \"US\",\n    \"balance\": \"45.67\",\n    \"pause_chasing\": false,\n    \"warning_level\": 1,\n    \"extra_data\": {},\n    \"source\": \"kolleno_api\",\n    \"source_id\": \"my_company_ref\",\n    \"date_modified\": \"2021-01-06T13:47:26.170436Z\",\n    \"date_created\": \"2021-01-06T13:47:18.243928Z\"\n}"}],"_postman_id":"96aef6a9-ab71-439c-a2d5-379373682f92"},{"name":"Delete Customer","id":"f287a487-588c-4c6d-a9c7-8d87616f48a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"/customer/:company/:customer/","description":"<p>Permanently delete a specific Customer. You can only delete customers if \"source\" equals to: [\"manual\", \"kolleno_api\"]</p>\n","urlObject":{"path":["customer",":company",":customer",""],"host":[""],"query":[],"variable":[{"id":"7c1c07ba-160d-40b6-a266-0d629227286d","description":{"content":"<p>Company the Customer belongs to</p>\n","type":"text/plain"},"type":"any","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","key":"company"},{"id":"206c4a73-5edc-465b-8259-55bfacbbc901","description":{"content":"<p>ID of the Customer to delete</p>\n","type":"text/plain"},"type":"any","value":"72bdecef-cfc4-4695-bcdd-41f4da1c8b5e","key":"customer"}]}},"response":[{"id":"05c0c670-a6b9-45d5-b915-a59d9e0d0059","name":"HTTP 204","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/customer/:company/:customer/","host":[""],"path":["customer",":company",":customer",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Customer belongs to"},{"key":"customer","value":"72bdecef-cfc4-4695-bcdd-41f4da1c8b5e","description":"ID of the Customer to retrieve"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Wed, 06 Jan 2021 13:31:54 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":""},{"id":"27f2e894-6ca7-436a-af1c-d8db0a439f3b","name":"HTTP 404","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/customer/:company/:customer/","host":[""],"path":["customer",":company",":customer",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Customer belongs to"},{"key":"customer","value":"wrong_uuid","description":"ID of the Customer to retrieve"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 13:32:24 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"23"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"Not found.\"\n}"}],"_postman_id":"f287a487-588c-4c6d-a9c7-8d87616f48a8"},{"name":"Retrieve Customer Portal URL","id":"fc5c0bcd-ee69-496d-ba89-ad299b2c2883","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/customer/portal-url/:company/?customer=85a62229-fe89-4ce5-88d0-7aa2931a42d5","description":"<p>In order to retrieve the URL to the Kolleno Customer Portal. You can search the Customer either by the Kolleno Customer ID OR the source_id from your ERP/accounting platform.</p>\n","urlObject":{"path":["customer","portal-url",":company",""],"host":[""],"query":[{"description":{"content":"<p>ID of the Customer to retrieve</p>\n","type":"text/plain"},"key":"customer","value":"85a62229-fe89-4ce5-88d0-7aa2931a42d5"},{"disabled":true,"description":{"content":"<p>The source_id from the ERP/accounting platform rather than the Kolleno Customer ID</p>\n","type":"text/plain"},"key":"source_id","value":"abcdef"}],"variable":[{"id":"8d525d10-8133-4a41-9c87-630c60d0321c","description":{"content":"<p>Company the Customer belongs to</p>\n","type":"text/plain"},"type":"any","value":"14659a82-ee9d-4d70-8251-5798dd30190e","key":"company"}]}},"response":[{"id":"a530cb6e-c1e9-4381-ad2c-6e92488f842c","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/customer/portal-url/:company/?customer=b703ea7c-5463-4f82-bfeb-e5c14bed37ef","host":[""],"path":["customer","portal-url",":company",""],"query":[{"key":"customer","value":"b703ea7c-5463-4f82-bfeb-e5c14bed37ef","description":"ID of the Customer to retrieve"},{"key":"source_id","value":"abcdef","description":"The source_id from the ERP/accounting platform rather than the Kolleno Customer ID","type":"text","disabled":true}],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Customer belongs to"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 30 May 2023 13:03:57 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.8.5"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"322"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"b703ea7c-5463-4f82-bfeb-e5c14bed37ef\",\n    \"customer_portal_url\": \"https://www.example.com\"\n}"},{"id":"43a7c5bb-b509-4c68-a90f-ee7fcb4fa2bd","name":"HTTP 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"/customer/portal-url/:company/?customer=wrong_uuid","host":[""],"path":["customer","portal-url",":company",""],"query":[{"key":"customer","value":"wrong_uuid","description":"ID of the Customer to retrieve"}],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Customer belongs to"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 30 May 2023 12:58:38 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.8.5"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"58"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"non_field_errors\": [\n        \"This customer could not be found.\"\n    ]\n}"}],"_postman_id":"fc5c0bcd-ee69-496d-ba89-ad299b2c2883"}],"id":"b913f9d6-a928-4ee1-9542-cb4fdd511d2b","description":"<p>Customers belong to a company.</p>\n<p>Example of an object:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"id\": \"72bdecef-cfc4-4695-bcdd-41f4da1c8b5e\",\n    \"name\": \"Bank West\",\n    \"address_line_1\": \"Procurement Services\",\n    \"address_line_2\": \"GPO 12345\",\n    \"postal_code\": \"PI98 7HV\",\n    \"city\": \"London\",\n    \"state\": \"Greater London\",\n    \"country\": \"US\",\n    \"ref\": \"ABC,\n    \"currency\": \"USD\",\n    \"balance\": \"45.67\", // read-only\n    \"pause_chasing\": false,\n    \"warning_level\": 0,\n    \"extra_data\": {},\n    \"source\": \"kolleno_api\", // read-only\n    \"source_id\": \"my_company_ref\",\n    \"date_modified\": \"2021-01-06T11:25:03.415043Z\",\n    \"date_created\": \"2020-11-24T12:53:55.611646Z\"\n}\n\n</code></pre>\n<p>In addition, there are also the following extra fields available:</p>\n<ul>\n<li><p>gocardless_customer_id: ID coming from GoCardless</p>\n</li>\n<li><p>has_direct_debit_detail: boolean whether direct debit details have been set up</p>\n</li>\n<li><p>bank_account_setup_url: string returning the URL to set up the direct debit</p>\n</li>\n</ul>\n<h3 id=\"query-parameter-behavior-matrix\">Query Parameter Behavior Matrix</h3>\n<p>The <code>/v1/customer/{company}/</code> endpoint supports an optional <code>?source=</code> query parameter that enables source-based ID resolution. <code>?source=</code> controls how <code>{customer}</code> in the URL is resolved (UUID vs source_id).</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>HTTP Method</th>\n<th>?source</th>\n<th>Behavior</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>POST</td>\n<td>No effect</td>\n<td>Creates the customer with <code>source</code> = <code>kolleno_api</code></td>\n</tr>\n<tr>\n<td>GET list</td>\n<td>No effect</td>\n<td>Returns all customers. <code>?source_id=</code> filters by source_id</td>\n</tr>\n<tr>\n<td>GET retrieve</td>\n<td>Not set</td>\n<td><code>{customer}</code> = customer UUID</td>\n</tr>\n<tr>\n<td>GET retrieve</td>\n<td>kolleno_api</td>\n<td><code>{customer}</code> = customer's source_id where source=kolleno_api</td>\n</tr>\n<tr>\n<td>PATCH/PUT</td>\n<td>Not set</td>\n<td><code>{customer}</code> = customer UUID</td>\n</tr>\n<tr>\n<td>PATCH/PUT</td>\n<td>kolleno_api</td>\n<td><code>{customer}</code> = customer's source_id where source=kolleno_api</td>\n</tr>\n<tr>\n<td>DELETE</td>\n<td>Not set</td>\n<td><code>{customer}</code> = customer UUID. Returns 204</td>\n</tr>\n<tr>\n<td>DELETE</td>\n<td>kolleno_api</td>\n<td><code>{customer}</code> = customer's source_id. Returns 204</td>\n</tr>\n</tbody>\n</table>\n</div><p>Summary: <code>?source</code> accepts any source value (for example <code>kolleno_api</code> or <code>csv</code>). If no customer matches that source and source_id, the endpoint returns 404 with <code>{\"detail\": \"No customer found with the given source_id.\"}</code>.</p>\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"886b34a4-c33a-4be9-acdc-db40c6079707"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"5287ac76-5054-4394-9efb-9429e0013356"}}],"_postman_id":"b913f9d6-a928-4ee1-9542-cb4fdd511d2b"},{"name":"Customer Custom Fields","item":[{"name":"Update Custom Fields","id":"7eca93d3-0f66-4acf-964a-e114c37f67bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n    \"upsell\": true,\n    \"amount_requested\": 10.12\n}","options":{"raw":{"language":"json"}}},"url":"/customer/custom-fields/:company/:customer/","urlObject":{"path":["customer","custom-fields",":company",":customer",""],"host":[""],"query":[{"disabled":true,"description":{"content":"<p>Send if using the \"source_id\"</p>\n","type":"text/plain"},"key":"source","value":"netsuite"}],"variable":[{"id":"050b1f70-dac2-4ddf-b93c-687c4c1599ec","description":{"content":"<p>Company that owns the customer</p>\n","type":"text/plain"},"type":"any","value":"4bf830c9-ffe7-4c0c-b346-bf4ef5df54fa","key":"company"},{"id":"b054b302-feda-484b-a35e-554a4d42e1f8","description":{"content":"<p>Customer to update (Kolleno UUID <em>or</em> source_id from ERP)</p>\n","type":"text/plain"},"type":"any","value":"3863388f-16de-4e79-b746-9a791ea308a9","key":"customer"}]}},"response":[{"id":"a7d71e74-33c7-455f-b0c3-47b1eaf120af","name":"HTTP 200 (customer UUID)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n    \"upsell\": true,\n    \"amount_requested\": 10.12\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/customer/custom-fields/:company/:customer/","host":[""],"path":["customer","custom-fields",":company",":customer",""],"variable":[{"key":"company","value":"4bf830c9-ffe7-4c0c-b346-bf4ef5df54fa"},{"key":"customer","value":"3863388f-16de-4e79-b746-9a791ea308a9","description":"Customer to update"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Tue, 13 Jan 2026 17:33:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"PUT, PATCH, OPTIONS"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"Server","value":"HTTPServer/19.1.4"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"40"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Vary","value":"origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"upsell\": true,\n    \"amount_requested\": 10.12\n}"},{"id":"684124c7-843b-4f46-a4bf-8091fc44630e","name":"HTTP 200 (source ID)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n    \"upsell\": true,\n    \"amount_requested\": 10.13\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/customer/custom-fields/:company/:customer/?source=netsuite","host":[""],"path":["customer","custom-fields",":company",":customer",""],"query":[{"key":"source","value":"netsuite","description":"Send if using the \"source_id\"","type":"text"}],"variable":[{"key":"company","value":"4bf830c9-ffe7-4c0c-b346-bf4ef5df54fa","description":"Company that owns the customer"},{"key":"customer","value":"83893955","description":"Customer to update (Kolleno UUID *or* source_id from ERP)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Tue, 13 Jan 2026 17:35:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"PUT, PATCH, OPTIONS"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"Server","value":"HTTPServer/19.1.4"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"40"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Vary","value":"origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"upsell\": true,\n    \"amount_requested\": 10.13\n}"}],"_postman_id":"7eca93d3-0f66-4acf-964a-e114c37f67bf"}],"id":"01956b83-088a-44cf-9200-8bb383faf57e","description":"<p>This endpoint is used for you to update values for your Custom Fields on Customer records.</p>\n<p>See: <a href=\"https://help.kolleno.com/en/articles/11660969-add-custom-fields-to-your-kolleno-customers\">https://help.kolleno.com/en/articles/11660969-add-custom-fields-to-your-kolleno-customers</a></p>\n<p>If you are unsure about the fields API names, please reach out to support.</p>\n","_postman_id":"01956b83-088a-44cf-9200-8bb383faf57e"},{"name":"Direct Debit Detail","item":[{"name":"List Direct Debit Details","id":"d4d6c2ea-24a2-4562-9c99-000ef9693c5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/direct-debit-detail/:company/","urlObject":{"path":["direct-debit-detail",":company",""],"host":[""],"query":[{"disabled":true,"description":{"content":"<p>(optional) Filter to get only a specific Customer's Direct Debit Details</p>\n","type":"text/plain"},"key":"customer","value":"f6acf12f-84c2-46aa-9713-5776091e4bec"},{"disabled":true,"description":{"content":"<p>(optional) Filter to get only a specific source_id</p>\n","type":"text/plain"},"key":"source_id","value":"abc"},{"disabled":true,"description":{"content":"<p>(optional) Filter to get only a specific CUstomer's Card Detail (using the source ID)</p>\n","type":"text/plain"},"key":"customer__source_id","value":"def"}],"variable":[{"id":"3d4160b0-cf59-4fc5-8123-e039b9f47440","description":{"content":"<p>Company the Direct Debit Details belong to</p>\n","type":"text/plain"},"type":"any","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","key":"company"}]}},"response":[{"id":"d6699535-b048-46b3-bf26-714cda782642","name":"HTTP 403","originalRequest":{"method":"GET","header":[],"url":{"raw":"/direct-debit-detail/:company/","host":[""],"path":["direct-debit-detail",":company",""],"query":[{"key":"customer","value":"f6acf12f-84c2-46aa-9713-5776091e4bec","description":"(optional) Filter to get only a specific Customer's Direct Debit Details","disabled":true}],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335113","description":"Company the Direct Debit Details belong to"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 27 Oct 2023 16:08:04 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.11.2"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"63"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Vary","value":"origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You do not have permission to perform this action.\"\n}"},{"id":"78553bdf-92ec-4641-b446-1b2740f0a3ac","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/direct-debit-detail/:company/","host":[""],"path":["direct-debit-detail",":company",""],"query":[{"key":"customer","value":"f6acf12f-84c2-46aa-9713-5776091e4bec","description":"(optional) Filter to get only a specific Customer's Direct Debit Details","disabled":true}],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Direct Debit Details belong to"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 27 Oct 2023 16:06:12 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.11.2"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"522"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Vary","value":"origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"count\": 1,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"79357a7a-df1d-4371-8b2d-1868081e14d5\",\n            \"customer\": \"841f727d-efdc-4f8a-a6dc-f486afc3faf8\",\n            \"country\": \"93da621f-816e-41da-89fc-8015f3ab4ab8\",\n            \"currency\": \"GBP\",\n            \"bank_name\": \"Concorde Bank Inc.\",\n            \"account_type\": \"Business account\",\n            \"account_holder_name\": \"Archway Security\",\n            \"account_number_ending\": \"7589\",\n            \"mandate_ref\": \"45869586\",\n            \"mandate_scheme\": \"\",\n            \"mandate_status\": \"active\",\n            \"next_possible_charge_date\": null,\n            \"payments_require_approval\": false,\n            \"source\": \"gocardless\",\n            \"source_id\": \"\",\n            \"date_created\": \"2020-11-24T12:53:55.610255Z\"\n        },\n        {\n            \"id\": \"12357a7a-df1d-4371-8b2d-1868081e14d5\",\n            \"customer\": \"456f727d-efdc-4f8a-a6dc-f486afc3faf8\",\n            \"country\": \"789a621f-816e-41da-89fc-8015f3ab4ab8\",\n            \"currency\": \"USD\",\n            \"bank_name\": \"Wells Fargo Bank, N.A.\",\n            \"account_type\": \"Checking account\",\n            \"account_holder_name\": \"Greenwood Security\",\n            \"account_number_ending\": \"1234\",\n            \"mandate_ref\": \"85236974\",\n            \"mandate_scheme\": \"SEPA\",\n            \"mandate_status\": \"inactive\",\n            \"next_possible_charge_date\": \"2023-11-01\",\n            \"payments_require_approval\": false,\n            \"source\": \"gocardless\",\n            \"source_id\": \"acc_1H5pJNGO3mZ6Bajqd4l7BxYO\",\n            \"date_created\": \"2020-11-24T12:53:55.610829Z\"\n        }\n    ]\n}"}],"_postman_id":"d4d6c2ea-24a2-4562-9c99-000ef9693c5d"}],"id":"21ce3c4d-879b-4fcf-9869-5dcc7cb72f92","description":"<p>Direct Debit Details belong to a Customer.</p>\n<p>Example of an object:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"id\": \"12357a7a-df1d-4371-8b2d-1868081e14d5\",\n    \"customer\": \"456f727d-efdc-4f8a-a6dc-f486afc3faf8\",\n    \"country\": \"789a621f-816e-41da-89fc-8015f3ab4ab8\",\n    \"currency\": \"USD\",\n    \"bank_name\": \"Wells Fargo Bank, N.A.\",\n    \"account_type\": \"Checking account\",\n    \"account_holder_name\": \"Greenwood Security\",\n    \"account_number_ending\": \"1234\",\n    \"mandate_ref\": \"85236974\",\n    \"mandate_scheme\": \"SEPA\",\n    \"mandate_status\": \"inactive\",\n    \"next_possible_charge_date\": \"2023-11-01\",\n    \"payments_require_approval\": false,\n    \"source\": \"gocardless\",\n    \"source_id\": \"acc_1H5pJNGO3mZ6Bajqd4l7BxYO\",\n}\n\n</code></pre>\n","_postman_id":"21ce3c4d-879b-4fcf-9869-5dcc7cb72f92"},{"name":"Email Sent","item":[{"name":"List Emails Sent","id":"b223fe4d-2bde-41e4-89ca-11c49733ba0d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/email-sent/:company/","description":"<p>Retrieve the emails sent in a given Company. Ordered by \"date_sent\", oldest first. Only the emails that have a \"date_sent\" are returned.</p>\n<p>To get the emails of the Steps from <strong>List of Steps</strong>, use <code>step__in</code>. Send at most 100 to 200 Step IDs per request: a URL longer than about 16 KB returns <strong>414</strong>.</p>\n","urlObject":{"path":["email-sent",":company",""],"host":[""],"query":[{"disabled":true,"description":{"content":"<p>(optional) The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles.</p>\n","type":"text/plain"},"key":"limit","value":"5"},{"disabled":true,"description":{"content":"<p>(optional) The offset indicates the starting position of the query in relation to the complete set of unpaginated items.</p>\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"<p>(optional) Filter to get only the emails sent to a specific Customer</p>\n","type":"text/plain"},"key":"customer","value":"b703ea7c-5463-4f82-bfeb-e5c14bed37ef"},{"disabled":true,"description":{"content":"<p>(optional) Filter to get only the emails about a specific Invoice</p>\n","type":"text/plain"},"key":"invoice","value":"96574ca1-6114-43d2-8caa-91d2ef738773"},{"disabled":true,"description":{"content":"<p>(optional) Filter to get only the email of a specific Step (see List of Steps)</p>\n","type":"text/plain"},"key":"step","value":"7236d78e-4fa4-4a1d-8488-133eb6f8a550"},{"disabled":true,"description":{"content":"<p>(optional) Filter to get only the emails of a list of Steps (comma separated). Send at most 100 to 200 Step IDs per request.</p>\n","type":"text/plain"},"key":"step__in","value":"7236d78e-4fa4-4a1d-8488-133eb6f8a550,43ae1616-edc1-421b-b116-6b644a2d3026"},{"disabled":true,"description":{"content":"<p>(optional) To get all the emails sent at or after an ISO 8601 datetime</p>\n","type":"text/plain"},"key":"date_sent__gte","value":"2026-10-01T00:00:00Z"},{"disabled":true,"description":{"content":"<p>(optional) Get additional fields in the response (comma separated)</p>\n","type":"text/plain"},"key":"extra_fields","value":"body,body_text"}],"variable":[{"id":"ef5ee692-27d9-47b9-8b35-eb77f418f92e","type":"any","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","key":"company"}]}},"response":[{"id":"2b9aff69-1c42-45a0-b655-d531d300c94b","name":"HTTP 403","originalRequest":{"method":"GET","header":[],"url":{"raw":"/email-sent/:company/","host":[""],"path":["email-sent",":company",""],"variable":[{"key":"company","value":"6805ead8-9a89-47a0-8144-83ab6975279b","description":"A company you don't have access to"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You do not have permission to perform this action.\"\n}"},{"id":"086358f6-e00c-41cd-aea3-55d4b0504ab5","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/email-sent/:company/?customer=b703ea7c-5463-4f82-bfeb-e5c14bed37ef","host":[""],"path":["email-sent",":company",""],"query":[{"key":"customer","value":"b703ea7c-5463-4f82-bfeb-e5c14bed37ef"}],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n    \"count\": 1,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"5c1e8a2f-3b7d-4e9a-8f6c-2d4b1a9e7c03\",\n            \"customer\": \"b703ea7c-5463-4f82-bfeb-e5c14bed37ef\",\n            \"step\": \"7236d78e-4fa4-4a1d-8488-133eb6f8a550\",\n            \"invoices\": [\"96574ca1-6114-43d2-8caa-91d2ef738773\"],\n            \"email_address_from\": \"accounts@example.com\",\n            \"name_from\": \"Accounts Team\",\n            \"to_recipients\": [{\"name\": \"Jane Doe\", \"email_address\": \"jane.doe@example.com\"}],\n            \"cc_recipients\": [],\n            \"bcc_recipients\": [],\n            \"subject\": \"Invoice INV-0038 is overdue\",\n            \"status\": \"delivered\",\n            \"workflow\": \"e2a7c9d1-4f3b-4a8e-9c6d-1b5f7a3e2d48\",\n            \"template\": \"3f8b6d2a-9c41-4e7f-b5a3-8d1e6c2f4a97\",\n            \"date_sent\": \"2026-10-12T09:00:04.118263Z\",\n            \"date_created\": \"2026-10-12T09:00:01.902114Z\"\n        }\n    ]\n}"}],"_postman_id":"b223fe4d-2bde-41e4-89ca-11c49733ba0d"},{"name":"Retrieve Email Sent","id":"974e4ddc-ee49-78e3-3950-891a8fc00af3","request":{"method":"GET","header":[],"url":"/email-sent/:company/:email_sent/","description":"<p>Retrieve a specific email sent.</p>\n<p>Returns <strong>404</strong> if the email does not exist or was not sent.</p>\n","urlObject":{"path":["email-sent",":company",":email_sent",""],"host":[""],"query":[{"disabled":true,"description":{"content":"<p>(optional) Get additional fields in the response (comma separated)</p>\n","type":"text/plain"},"key":"extra_fields","value":"body,body_text"}],"variable":[{"type":"any","key":"company"},{"type":"any","key":"email_sent"}]}},"response":[{"id":"3642574c-dd2f-4d4f-8fad-aee19aeee570","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/email-sent/:company/:email_sent/?extra_fields=body,body_text","host":[""],"path":["email-sent",":company",":email_sent",""],"query":[{"key":"extra_fields","value":"body,body_text"}],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112"},{"key":"email_sent","value":"5c1e8a2f-3b7d-4e9a-8f6c-2d4b1a9e7c03"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"5c1e8a2f-3b7d-4e9a-8f6c-2d4b1a9e7c03\",\n    \"customer\": \"b703ea7c-5463-4f82-bfeb-e5c14bed37ef\",\n    \"step\": \"7236d78e-4fa4-4a1d-8488-133eb6f8a550\",\n    \"invoices\": [\"96574ca1-6114-43d2-8caa-91d2ef738773\"],\n    \"email_address_from\": \"accounts@example.com\",\n    \"name_from\": \"Accounts Team\",\n    \"to_recipients\": [{\"name\": \"Jane Doe\", \"email_address\": \"jane.doe@example.com\"}],\n    \"cc_recipients\": [],\n    \"bcc_recipients\": [],\n    \"subject\": \"Invoice INV-0038 is overdue\",\n    \"status\": \"delivered\",\n    \"workflow\": \"e2a7c9d1-4f3b-4a8e-9c6d-1b5f7a3e2d48\",\n    \"template\": \"3f8b6d2a-9c41-4e7f-b5a3-8d1e6c2f4a97\",\n    \"date_sent\": \"2026-10-12T09:00:04.118263Z\",\n    \"date_created\": \"2026-10-12T09:00:01.902114Z\",\n    \"body\": \"<p>Dear Jane,</p><p>Invoice INV-0038 for USD 234.00 was due on 2020-12-01.</p>\",\n    \"body_text\": \"Dear Jane,\\nInvoice INV-0038 for USD 234.00 was due on 2020-12-01.\"\n}"},{"id":"71954a51-6049-4b7c-9e2a-ad9044edb587","name":"HTTP 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"/email-sent/:company/:email_sent/","host":[""],"path":["email-sent",":company",":email_sent",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112"},{"key":"email_sent","value":"0b6f3a52-7d1e-4c8a-9f2b-5e4d3c2a1b09"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"No EmailSent matches the given query.\"\n}"}],"_postman_id":"974e4ddc-ee49-78e3-3950-891a8fc00af3"}],"id":"09ab0f45-56ec-045c-0687-7c18c96a6765","description":"<p>The emails Kolleno sent to your Customers, from a workflow or by a user.</p>\n<p>The \"step\" is the Step of the email in the Customer's timeline (see <strong>Timeline</strong>), and is null when the email has no Customer. The \"invoices\" are the Invoices the email is about, in no fixed order. The \"workflow\" is null when no workflow sent the email.</p>\n<p>The \"template\" is the Template the workflow used to send the email. It is null when no workflow sent the email, and for emails sent before this field was added.</p>\n<p>To get the names of the \"workflow\" and the \"template\", use <strong>List Workflows</strong> and <strong>List Templates</strong>.</p>\n<p>The \"status\" shows the delivery of the email, for example: delivered, read, read_clicked, bounced or error.</p>\n<p>Add <code>?extra_fields=body,body_text</code> to also get the HTML \"body\" and the plain text \"body_text\" of the email.</p>\n<p>Example of an object:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>{\n    \"id\": \"5c1e8a2f-3b7d-4e9a-8f6c-2d4b1a9e7c03\",\n    \"customer\": \"b703ea7c-5463-4f82-bfeb-e5c14bed37ef\",\n    \"step\": \"7236d78e-4fa4-4a1d-8488-133eb6f8a550\",\n    \"invoices\": [\"96574ca1-6114-43d2-8caa-91d2ef738773\"],\n    \"email_address_from\": \"accounts@example.com\",\n    \"name_from\": \"Accounts Team\",\n    \"to_recipients\": [{\"name\": \"Jane Doe\", \"email_address\": \"jane.doe@example.com\"}],\n    \"cc_recipients\": [],\n    \"bcc_recipients\": [],\n    \"subject\": \"Invoice INV-0038 is overdue\",\n    \"status\": \"delivered\",\n    \"workflow\": \"e2a7c9d1-4f3b-4a8e-9c6d-1b5f7a3e2d48\",\n    \"template\": \"3f8b6d2a-9c41-4e7f-b5a3-8d1e6c2f4a97\",\n    \"date_sent\": \"2026-10-12T09:00:04.118263Z\",\n    \"date_created\": \"2026-10-12T09:00:01.902114Z\"\n}\n</code></pre>","_postman_id":"09ab0f45-56ec-045c-0687-7c18c96a6765"},{"name":"Invoice","item":[{"name":"List Invoices","id":"377d5c29-c0b0-43b0-a2ed-131a56c2bdad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/invoice/:company/","description":"<p>Retrieve all the Invoice in a given Company. Ordered by \"date_created\".</p>\n<p>To get only the Invoices that changed since your last sync, use <code>date_modified__gte</code>.</p>\n","urlObject":{"path":["invoice",":company",""],"host":[""],"query":[{"disabled":true,"description":{"content":"<p>(optional) The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles.</p>\n","type":"text/plain"},"key":"limit","value":"5"},{"disabled":true,"description":{"content":"<p>(optional) The offset indicates the starting position of the query in relation to the complete set of unpaginated items.</p>\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"<p>(optional) Filter to get only a specific Customer's Invoices</p>\n","type":"text/plain"},"key":"customer","value":"b703ea7c-5463-4f82-bfeb-e5c14bed37ef"},{"disabled":true,"description":{"content":"<p>(optional) Filter to get only a specific source_id</p>\n","type":"text/plain"},"key":"source_id","value":"abc"},{"disabled":true,"description":{"content":"<p>(optional) Filter to get only the Invoices with a specific payment_status. One of: 'paid', 'partially_paid', 'paid_pending_confirmation', 'payment_scheduled', 'installments', 'open', 'dispute', 'draft', 'closed', 'hold_back', 'bad_debt', 'credited'</p>\n","type":"text/plain"},"key":"payment_status","value":"open"},{"disabled":true,"description":{"content":"<p>(optional) Filter to get only the Invoices with one of a list of payment_status (comma separated, lowercase, no spaces). An unknown value returns 400.</p>\n","type":"text/plain"},"key":"payment_status__in","value":"open,partially_paid"},{"disabled":true,"description":{"content":"<p>(optional) To get all the Invoices modified at or after an ISO 8601 datetime</p>\n","type":"text/plain"},"key":"date_modified__gte","value":"2026-10-01T00:00:00Z"}],"variable":[{"id":"ea915ea8-0cf2-47d8-a289-235df606311e","description":{"content":"<p>Company the Invoice belongs to</p>\n","type":"text/plain"},"type":"any","value":"5a3f7069-56be-443a-978f-bd2a202617de","key":"company"}]}},"response":[{"id":"ae66e133-022e-4cb5-946a-ba3b964ae45e","name":"HTTP 403","originalRequest":{"method":"GET","header":[],"url":{"raw":"/invoice/:company/?limit=5&offset=0","host":[""],"path":["invoice",":company",""],"query":[{"key":"limit","value":"5","description":"(optional) The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles."},{"key":"offset","value":"0","description":"(optional) The offset indicates the starting position of the query in relation to the complete set of unpaginated items."}],"variable":[{"key":"company","value":"472ad18f-ff66-413e-8bb9-02ded72b614f","description":"Company the Invoice belongs to"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 19:10:23 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"63"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You do not have permission to perform this action.\"\n}"},{"id":"f83c41b4-7387-41b1-a3e1-eccf15001cc0","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/invoice/:company/?limit=5&offset=0","host":[""],"path":["invoice",":company",""],"query":[{"key":"limit","value":"5","description":"(optional) The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles."},{"key":"offset","value":"0","description":"(optional) The offset indicates the starting position of the query in relation to the complete set of unpaginated items."}],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 19:09:30 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"2418"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"count\": 38,\n    \"next\": \"/invoice/7017d236-cc07-44bc-bb86-8d0cd4335112/?limit=5&offset=5\",\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"96574ca1-6114-43d2-8caa-91d2ef738773\",\n            \"customer\": \"b703ea7c-5463-4f82-bfeb-e5c14bed37ef\",\n            \"amount\": \"234.00\",\n            \"balance\": \"234.00\",\n            \"currency\": \"USD\",\n            \"ref\": \"INV-0038\",\n            \"description\": \"\",\n            \"payment_status\": \"open\",\n            \"date_invoice\": \"2019-01-01\",\n            \"date_due\": \"2020-12-01\",\n            \"date_promise_to_pay_valid\": \"2020-12-15\",\n            \"pause_chasing\": false,\n            \"persons\": [\"e36f4355-819c-4996-adc8-eac50721e2f4\", \"f7ac89b0-f13b-4b84-9cb0-aed7d1384304\"],\n            \"extra_data\": {\"mykey\": \"myval\", \"somelist\": [1,2,3]},\n            \"source\": \"kolleno_api\",\n            \"source_id\": \"c032a257-0587-4b9c-a6c8-5286558471e1\",\n            \"date_modified\": \"2020-11-24T12:53:55.615229Z\",\n            \"date_created\": \"2020-11-24T12:53:55.615242Z\"\n        },\n        {\n            \"id\": \"11fb74c4-d98f-4865-bc05-cae890f7edec\",\n            \"customer\": \"a4c1a484-102d-45db-80cb-e20b2da985e8\",\n            \"amount\": \"396.00\",\n            \"balance\": \"396.00\",\n            \"currency\": \"USD\",\n            \"ref\": \"INV-0037\",\n            \"description\": \"\",\n            \"payment_status\": \"open\",\n            \"date_invoice\": \"2020-10-29\",\n            \"date_due\": \"2020-11-30\",\n            \"date_promise_to_pay_valid\": null,\n            \"pause_chasing\": false,\n            \"external_id\": \"\",\n            \"persons\": [\"e36f4355-819c-4996-adc8-eac50721e2f4\", \"f7ac89b0-f13b-4b84-9cb0-aed7d1384304\"],\n            \"extra_data\": {},\n            \"source\": \"xero\",\n            \"source_id\": \"218f4892-dbe9-4f9e-8c56-fed5cdb41d2f\",\n            \"date_modified\": \"2020-11-24T12:53:55.615386Z\",\n            \"date_created\": \"2020-11-24T12:53:55.615395Z\"\n        },\n        {\n            \"id\": \"d4730944-13c4-4b32-8a82-a94633be53e8\",\n            \"customer\": \"8b718009-129d-4a70-ae51-6e97207a4ade\",\n            \"amount\": \"914.55\",\n            \"balance\": \"914.55\",\n            \"currency\": \"USD\",\n            \"ref\": \"INV-0036\",\n            \"description\": \"\",\n            \"payment_status\": \"open\",\n            \"date_invoice\": \"2020-10-28\",\n            \"date_due\": \"2020-11-29\",\n            \"date_promise_to_pay_valid\": null,\n            \"pause_chasing\": false,\n            \"persons\": [\"e36f4355-819c-4996-adc8-eac50721e2f4\", \"f7ac89b0-f13b-4b84-9cb0-aed7d1384304\"],\n            \"extra_data\": {},\n            \"source\": \"xero\",\n            \"source_id\": \"3e09ae2f-d6cb-4164-9665-141fba0c634c\",\n            \"date_modified\": \"2020-11-24T12:53:55.615494Z\",\n            \"date_created\": \"2020-11-24T12:53:55.615502Z\"\n        },\n        {\n            \"id\": \"647e81fc-f05a-4b79-bff3-5b843dd7dd68\",\n            \"customer\": \"ad7ec99a-57d6-4a68-a047-710ff7b5c82d\",\n            \"amount\": \"650.00\",\n            \"balance\": \"650.00\",\n            \"currency\": \"USD\",\n            \"ref\": \"INV-0034\",\n            \"description\": \"\",\n            \"payment_status\": \"open\",\n            \"date_invoice\": \"2020-10-27\",\n            \"date_due\": \"2020-11-28\",\n            \"date_promise_to_pay_valid\": null,\n            \"pause_chasing\": false,\n            \"persons\": [\"e36f4355-819c-4996-adc8-eac50721e2f4\", \"f7ac89b0-f13b-4b84-9cb0-aed7d1384304\"],\n            \"extra_data\": {},\n            \"source\": \"xero\",\n            \"source_id\": \"c8f4695e-883e-47ae-8cac-e85ff983bb59\",\n            \"date_modified\": \"2020-11-24T12:53:55.615615Z\",\n            \"date_created\": \"2020-11-24T12:53:55.615622Z\"\n        },\n        {\n            \"id\": \"519db875-ee86-459a-89fb-b79837fed270\",\n            \"customer\": \"680f9add-7579-4613-a086-dc1e91664819\",\n            \"amount\": \"1995.00\",\n            \"balance\": \"1995.00\",\n            \"currency\": \"USD\",\n            \"ref\": \"INV-0042\",\n            \"description\": \"\",\n            \"payment_status\": \"open\",\n            \"date_invoice\": \"2020-10-23\",\n            \"date_due\": \"2020-11-24\",\n            \"date_promise_to_pay_valid\": null,\n            \"pause_chasing\": false,\n            \"persons\": [\"e36f4355-819c-4996-adc8-eac50721e2f4\", \"f7ac89b0-f13b-4b84-9cb0-aed7d1384304\"],\n            \"extra_data\": {},\n            \"source\": \"xero\",\n            \"source_id\": \"49737b7b-f473-44a1-a51e-cfcf086224aa\",\n            \"date_modified\": \"2020-11-24T12:53:55.615720Z\",\n            \"date_created\": \"2020-11-24T12:53:55.615727Z\"\n        }\n    ]\n}"}],"_postman_id":"377d5c29-c0b0-43b0-a2ed-131a56c2bdad"},{"name":"Retrieve Invoice","id":"5b6a379f-5727-4346-a08a-92423726bfee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/invoice/:company/:invoice/","urlObject":{"path":["invoice",":company",":invoice",""],"host":[""],"query":[],"variable":[{"id":"09ed2e50-3ff0-4ec2-962e-2e16ca1bc318","description":{"content":"<p>Company the Invoice belongs to</p>\n","type":"text/plain"},"type":"any","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","key":"company"},{"id":"9257c540-4383-4ad7-a09b-18275580aa15","description":{"content":"<p>ID of the Invoice to retrieve</p>\n","type":"text/plain"},"type":"any","value":"96574ca1-6114-43d2-8caa-91d2ef738773\"","key":"invoice"}]}},"response":[{"id":"72e55740-f92b-47d6-a3bb-76a9b7e186a4","name":"HTTP 403","originalRequest":{"method":"GET","header":[],"url":{"raw":"/invoice/:company/:invoice/","host":[""],"path":["invoice",":company",":invoice",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Invoice belongs to"},{"key":"invoice","value":"56e5d51e-928a-4978-82fc-0c89928d6d75","description":"ID of the Invoice to retrieve"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 19:13:18 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"63"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You do not have permission to perform this action.\"\n}"},{"id":"a82987a2-8a14-4b02-94ab-ed5dcaa9ee49","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/invoice/:company/:invoice/","host":[""],"path":["invoice",":company",":invoice",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Invoice belongs to"},{"key":"invoice","value":"96574ca1-6114-43d2-8caa-91d2ef738773","description":"ID of the Invoice to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 19:13:02 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"455"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"96574ca1-6114-43d2-8caa-91d2ef738773\",\n    \"customer\": \"b703ea7c-5463-4f82-bfeb-e5c14bed37ef\",\n    \"amount\": \"234.00\",\n    \"balance\": \"234.00\",\n    \"currency\": \"USD\",\n    \"ref\": \"INV-0038\",\n    \"description\": \"\",\n    \"payment_status\": \"open\",\n    \"date_invoice\": \"2020-11-01\",\n    \"date_due\": \"2020-12-01\",\n    \"date_promise_to_pay_valid\": null,\n    \"pause_chasing\": false,\n    \"persons\": [\"e36f4355-819c-4996-adc8-eac50721e2f4\", \"f7ac89b0-f13b-4b84-9cb0-aed7d1384304\"],\n    \"source\": \"kolleno_api\",\n    \"source_id\": \"49737b7b-f473-44a1-a51e-cfcf086224aa\",\n    \"date_modified\": \"2020-11-24T12:53:55.615229Z\",\n    \"date_created\": \"2020-11-24T12:53:55.615242Z\"\n}"}],"_postman_id":"5b6a379f-5727-4346-a08a-92423726bfee"},{"name":"Create Invoice","id":"21ad2a00-9a11-47ec-8f9d-525d92d72f9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"customer\": \"754be872-234e-4784-84cf-08f0f0bcec07\", // UUID of the Customer it refers to\n    \"amount\": 330.20, // (float/string) total amount of the invoice\n    \"balance\": 115.73, // (float/string) remaining balance to be paid\n    \"currency\": \"USD\", // ISO of the currency\n    \"ref\": \"abc\", // (string) reference of the invoice\n    \"description\": \"Monthly fee\", // (string) optional description\n    \"payment_status\": \"open\", // (string) open, partially_paid, paid, installments, dispute, closed, hold_back\n    \"date_invoice\": \"2020-09-14\", // (string) YYYY-MM-DD when the invoice was issued\n    \"date_due\": \"2020-10-15\", // (string) YYYY-MM-DD when the invoice is due\n    \"pause_chasing\": false, // (boolean)\n    \"persons\": [\n        \"cd31a679-9ee9-4e13-9003-75239ffd2e0c\",\n        \"b4a76517-9e1b-472a-b575-51ae50fe462f\"\n    ], // List of person UUIDs assigned to the invoice\n    \"tags\": [\n        \"0f0d9f34-1f0c-4a0e-9f6a-4e3f2f5c9b21\",\n        \"b0a4b3d2-7c19-4f2e-8a1c-3d6f9e2b7a55\"\n    ], // List of tag UUIDs assigned to the invoice (see the \"Tag\" endpoints)\n    \"extra_data\": {\n        \"mykey\": \"myval\",\n        \"somelist\": [1,2,3]\n    }, // any JSON formatted extra data\n    \"source_id\": \"my_company_ref\" // ID in your system so you can keep track of the Invoice\n}","options":{"raw":{"language":"json"}}},"url":"/invoice/:company/","description":"<p>Create an Invoice. It will set the field \"source\" to \"kolleno_api\" automatically.</p>\n","urlObject":{"path":["invoice",":company",""],"host":[""],"query":[],"variable":[{"id":"48b4671d-87c7-47e2-9054-182af4989b17","description":{"content":"<p>Company the Invoice belongs to</p>\n","type":"text/plain"},"type":"any","value":"5a3f7069-56be-443a-978f-bd2a202617de","key":"company"}]}},"response":[{"id":"5ed6f3a6-8394-4eed-9a13-8c451f12a381","name":"HTTP 400 - wrong Customer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"customer\": \"754be872-234e-4784-84cf-08f0f0bcec07\", \n    \"amount\": 330.20, \n    \"balance\": 115.73, \n    \"currency\": \"USD\", \n    \"ref\": \"abc\",\n    \"description\": \"Monthly fee\",\n    \"payment_status\": \"open\", \n    \"date_invoice\": \"2020-09-14\", \n    \"date_due\": \"2020-10-15\",\n    \"pause_chasing\": false,\n    \"persons\": [\n        \"cd31a679-9ee9-4e13-9003-75239ffd2e0c\",\n        \"b4a76517-9e1b-472a-b575-51ae50fe462f\"\n    ], \n    \"source_id\": \"my_company_ref\" \n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/invoice/:company/","host":[""],"path":["invoice",":company",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Invoice belongs to"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 21 Jan 2021 15:00:45 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"72"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"customer\": [\n        \"This customer could not be found for the given company.\"\n    ]\n}"},{"id":"92b3a7ce-cb8d-439f-9efe-a95773328793","name":"HTTP 200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"customer\": \"754be872-234e-4784-84cf-08f0f0bcec07\", \n    \"amount\": 330.20, \n    \"balance\": 115.73, \n    \"currency\": \"USD\", \n    \"ref\": \"abc\", \n    \"description\": \"Monthly fee\", \n    \"payment_status\": \"open\",\n    \"date_invoice\": \"2020-09-14\", \n    \"date_due\": \"2020-10-15\", \n    \"pause_chasing\": false, \n    \"persons\": [\n        \"cd31a679-9ee9-4e13-9003-75239ffd2e0c\",\n        \"b4a76517-9e1b-472a-b575-51ae50fe462f\"\n    ], \n    \"source_id\": \"my_company_ref\" \n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/invoice/:company/","host":[""],"path":["invoice",":company",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Invoice belongs to"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 19:20:05 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"439"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"bd50dd3e-b239-4c07-a699-a8ac8b597736\",\n    \"customer\": \"754be872-234e-4784-84cf-0f80f0bcec07\",\n    \"amount\": \"330.20\",\n    \"balance\": \"115.73\",\n    \"currency\": \"USD\",\n    \"ref\": \"abc\",\n    \"description\": \"Monthly fee\",\n    \"payment_status\": \"open\",\n    \"date_invoice\": \"2020-09-14\",\n    \"date_due\": \"2020-10-15\",\n    \"date_promise_to_pay_valid\": null,\n    \"pause_chasing\": false,\n    \"persons\": [\"e36f4355-819c-4996-adc8-eac50721e2f4\", \"f7ac89b0-f13b-4b84-9cb0-aed7d1384304\"],\n    \"extra_data\": {\"mykey\": \"myval\", \"somelist\": [1,2,3]},\n    \"source\": \"kolleno_api\",\n    \"source_id\": \"my_company_ref\",\n    \"date_modified\": \"2021-01-06T19:20:05.154364Z\",\n    \"date_created\": \"2021-01-06T19:20:05.154383Z\"\n}"},{"id":"dfbd9438-afc7-4acf-9d11-ad8eaf913f30","name":"HTTP 400 - missing fields","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"customer\": \"754be872-234e-4784-84cf-08f0f0bcec07\",\n    \"amount\": 330.20,\n    \"balance\": 115.73,\n    \"currency\": \"USD\",\n    \"ref\": \"abc\",\n    \"description\": \"Monthly fee\",\n    \"payment_status\": \"open\",\n    \"date_invoice\": \"2020-09-14\",\n    \"date_due\": \"2020-10-15\",\n    \"pause_chasing\": false,\n    \"persons\": [\n        \"cd31a679-9ee9-4e13-9003-75239ffd2e0c\",\n        \"b4a76517-9e1b-472a-b575-51ae50fe462f\"\n    ],\n    \"source_id\": \"my_company_ref\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/invoice/:company/","host":[""],"path":["invoice",":company",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Invoice belongs to"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 19:20:17 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"79"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"customer\": [\n        \"This field is required.\"\n    ],\n    \"currency\": [\n        \"This field is required.\"\n    ]\n}"}],"_postman_id":"21ad2a00-9a11-47ec-8f9d-525d92d72f9d"},{"name":"Update Invoice","id":"1a8a4e32-a21d-4576-bcf7-2992e67cd816","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n    \"amount\": 330.20, // (float/string) total amount of the invoice\n    \"balance\": 115.73, // (float/string) remaining balance to be paid\n    \"currency\": \"USD\", // ISO of the currency\n    \"ref\": \"abc\", // (string) reference of the invoice\n    \"description\": \"Monthly fee\", // (string) optional description\n    \"payment_status\": \"open\", // (string) open, partially_paid, paid, installments, dispute, closed, hold_back\n    \"date_invoice\": \"2020-09-14\", // (string) YYYY-MM-DD when the invoice was issued\n    \"date_due\": \"2020-10-15\", // (string) YYYY-MM-DD when the invoice is due\n    \"pause_chasing\": false, // (boolean)\n    \"persons\": [\n        \"cd31a679-9ee9-4e13-9003-75239ffd2e0c\",\n        \"b4a76517-9e1b-472a-b575-51ae50fe462f\"\n    ], // List of person UUIDs assigned to the invoice\n    \"tags\": [\n        \"0f0d9f34-1f0c-4a0e-9f6a-4e3f2f5c9b21\",\n        \"b0a4b3d2-7c19-4f2e-8a1c-3d6f9e2b7a55\"\n    ], // List of tag UUIDs assigned to the invoice (see the \"Tag\" endpoints)\n    \"extra_data\": {\n        \"mykey\": \"myval\",\n        \"somelist\": [1,2,3]\n    }, // any JSON formatted extra data\n    \"source_id\": \"my_company_ref\" // ID in your system so you can keep track of the Invoice\n}","options":{"raw":{"language":"json"}}},"url":"/invoice/:company/:invoice/","description":"<p>Update details about a specific Invoice.<br />Once you have created an Invoice, it is not possible to move it to another Customer. You will need to delete the Invoice then re-create it with the correct Customer.  </p>\n<p>You can edit all the fields of an Invoice if \"source\" equals to: [\"manual\", \"kolleno_api\"]. Otherwise, you can only update the fields \"<em>pause_chasing</em>\", \"<em>extra_data</em>\" and \"<em>tags</em>\".</p>\n","urlObject":{"path":["invoice",":company",":invoice",""],"host":[""],"query":[],"variable":[{"id":"80a19ab9-0601-4493-98d7-0134bab6f02d","description":{"content":"<p>Company the Invoice belongs to</p>\n","type":"text/plain"},"type":"any","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","key":"company"},{"id":"30fa7c60-3363-44da-b430-fe60fcd889b5","description":{"content":"<p>ID of the Invoice to update</p>\n","type":"text/plain"},"type":"any","value":"d537c185-7697-48a0-9faa-7103c6729eda","key":"invoice"}]}},"response":[{"id":"5e4bd6fe-ff28-4275-b567-1a1b1621a5f1","name":"HTTP 200","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"amount\": 330.20,\n    \"balance\": 115.73,\n    \"currency\": \"USD\",\n    \"ref\": \"abc\",\n    \"description\": \"Monthly fee\",\n    \"payment_status\": \"open\",\n    \"date_invoice\": \"2020-09-14\",\n    \"date_due\": \"2020-10-15\",\n    \"pause_chasing\": false,\n    \"persons\": [\n        \"cd31a679-9ee9-4e13-9003-75239ffd2e0c\",\n        \"b4a76517-9e1b-472a-b575-51ae50fe462f\"\n    ],\n    \"source_id\": \"my_company_ref\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/invoice/:company/:invoice/","host":[""],"path":["invoice",":company",":invoice",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Invoice belongs to"},{"key":"invoice","value":"d537c185-7697-48a0-9faa-7103c6729eda","description":"ID of the Invoice to update"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 19:23:36 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"438"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"d537c185-7697-48a0-9faa-7103c6729eda\",\n    \"customer\": \"754be872-234e-4784-84cf-0f80f0bcec07\",\n    \"amount\": \"330.20\",\n    \"balance\": \"72.12\",\n    \"currency\": \"USD\",\n    \"ref\": \"abc\",\n    \"description\": \"Monthly fee\",\n    \"payment_status\": \"open\",\n    \"date_invoice\": \"2020-10-14\",\n    \"date_due\": \"2020-10-15\",\n    \"date_promise_to_pay_valid\": null,\n    \"pause_chasing\": false,\n    \"persons\": [\"6f7b1430-e0b9-42a7-897c-62c99de712e5\"],\n    \"extra_data\": {\"mykey\": \"myval\", \"somelist\": [1,2,3]},\n    \"source\": \"kolleno_api\",\n    \"source_id\": \"my_company_ref\",\n    \"date_modified\": \"2021-01-06T19:23:36.237872Z\",\n    \"date_created\": \"2021-01-06T19:20:30.772675Z\"\n}"},{"id":"b81ce198-9a52-4581-845d-d3739654b277","name":"HTTP 400","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"amount\": 330.20,\n    \"balance\": 115.73,\n    \"currency\": \"USD\",\n    \"ref\": \"abc\",\n    \"description\": \"Monthly fee\",\n    \"payment_status\": \"open\",\n    \"date_invoice\": \"2020-09-14\",\n    \"date_due\": \"2020-10-15\",\n    \"pause_chasing\": false,\n    \"persons\": [\n        \"cd31a679-9ee9-4e13-9003-75239ffd2e0c\",\n        \"b4a76517-9e1b-472a-b575-51ae50fe462f\"\n    ],\n    \"source_id\": \"my_company_ref\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/invoice/:company/:invoice/","host":[""],"path":["invoice",":company",":invoice",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Invoice belongs to"},{"key":"invoice","value":"d537c185-7697-48a0-9faa-7103c6729eda","description":"ID of the Invoice to update"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 19:26:22 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"81"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"non_field_errors\": [\n        \"Invoice imported from external source cannot be updated.\"\n    ]\n}"}],"_postman_id":"1a8a4e32-a21d-4576-bcf7-2992e67cd816"},{"name":"Delete Invoice","id":"b578cbd6-00f9-48a1-8644-74a4f4f386e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"/invoice/:company/:invoice/","description":"<p>Permanently delete a specific Invoice. You can only delete Invoices if \"source\" equals to: [\"manual\", \"kolleno_api\"]</p>\n","urlObject":{"path":["invoice",":company",":invoice",""],"host":[""],"query":[],"variable":[{"id":"e26a0d44-8965-4dff-a214-eb39d72f19db","description":{"content":"<p>Company the Invoice belongs to</p>\n","type":"text/plain"},"type":"any","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","key":"company"},{"id":"d333270c-c907-499e-8398-fec782febaa4","description":{"content":"<p>ID of the Invoice to update</p>\n","type":"text/plain"},"type":"any","value":"06ee50a3-bef6-4b69-8249-1bde56d12a77","key":"invoice"}]}},"response":[{"id":"d48d778d-bed1-43b1-9283-b3360411de26","name":"HTTP 204","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"/invoice/:company/:invoice/","host":[""],"path":["invoice",":company",":invoice",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Invoice belongs to"},{"key":"invoice","value":"d537c185-7697-48a0-9faa-7103c6729eda","description":"ID of the Invoice to update"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Wed, 06 Jan 2021 19:27:57 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":""},{"id":"28cc2e5a-a7dd-4e3d-ab1c-a1523af15af1","name":"HTTP 403","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"/invoice/:company/:invoice/","host":[""],"path":["invoice",":company",":invoice",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Invoice belongs to"},{"key":"invoice","value":"06ee50a3-bef6-4b69-8249-1bde56d12a77","description":"ID of the Invoice to update"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 19:28:26 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"63"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You do not have permission to perform this action.\"\n}"},{"id":"8e4c4de0-ffd7-4c58-8c88-8b0b2c33c90b","name":"HTTP 400","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"/invoice/:company/:invoice/","host":[""],"path":["invoice",":company",":invoice",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Invoice belongs to"},{"key":"invoice","value":"06ee50a3-bef6-4b69-8249-1bde56d12a77","description":"ID of the Invoice to update"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 19:28:26 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"63"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n  \"non_field_errors\": [\n    \"Invoice imported from external source cannot be deleted.\"\n  ]\n}"}],"_postman_id":"b578cbd6-00f9-48a1-8644-74a4f4f386e3"}],"id":"71f2c465-df66-490b-b03d-17b895a0485c","description":"<p>Invoices belong to a Customer.</p>\n<p>Example of an object:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>{\n    \"id\": \"96574ca1-6114-43d2-8caa-91d2ef738773\",\n    \"customer\": \"b703ea7c-5463-4f82-bfeb-e5c14bed37ef\",\n    \"amount\": \"234.00\",\n    \"balance\": \"234.00\",\n    \"currency\": \"USD\",\n    \"ref\": \"INV-0038\",\n    \"payment_status\": \"open\",\n    \"date_invoice\": \"2020-11-15\",\n    \"date_due\": \"2020-12-01\",\n    \"date_promise_to_pay_valid\": null,\n    \"pause_chasing\": false,\n    \"persons\": [\"99a45277-6dab-40c8-95df-20196dc7a740\", \"ac0b061a-8b32-4733-80b1-094af855e850\"],\n    \"tags\": [\n        {\n            \"id\": \"0f0d9f34-1f0c-4a0e-9f6a-4e3f2f5c9b21\",\n            \"name\": \"Disputed\",\n            \"color\": \"FF0000\",\n            \"description\": \"The customer raised a dispute\",\n            \"tag_category\": {\n                \"id\": \"6f2c1a7d-9c31-4e6b-8b52-1d5e9a7c4f80\",\n                \"name\": \"Collections\"\n            }\n        }\n    ],\n    \"extra_data\": {\n        \"mykey\": \"myval\",\n        \"somelist\": [1,2,3]\n    },\n    \"source\": \"kolleno_api\",\n    \"source_id\": \"my_company_ref\",\n    \"date_modified\": \"2020-11-24T12:53:55.615229Z\",\n    \"date_created\": \"2020-11-24T12:53:55.615242Z\"\n}\n\n</code></pre><p>The \"tags\" are returned as objects, but you send a list of Tag UUIDs to assign them. Sending \"tags\" replaces the whole list, so send an empty list to remove them all. The Tags have to belong to the same Company as the Invoice.</p>\n<p>The \"date_promise_to_pay_valid\" is the date of the active promise to pay on the Invoice, and is null when there is none. It is read-only, and can take a few seconds to show a new promise to pay.</p>\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"afc0b7c6-319f-4efd-807a-3f58d2753c80"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"b25495de-11ff-42ed-abf4-9dda30fc2ba2"}}],"_postman_id":"71f2c465-df66-490b-b03d-17b895a0485c"},{"name":"Invoice Custom Fields","item":[{"name":"Update Custom Fields","id":"725364a3-c413-4e5f-8041-a8ac2724157c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n    \"invoice_priority\": \"high\",\n    \"approved_amount\": 10.12\n}","options":{"raw":{"language":"json"}}},"url":"/invoice/custom-fields/:company/:invoice/","urlObject":{"path":["invoice","custom-fields",":company",":invoice",""],"host":[""],"query":[{"disabled":true,"description":{"content":"<p>Send if using the \"source_id\"</p>\n","type":"text/plain"},"key":"source","value":"netsuite"}],"variable":[{"id":"a895724b-86ca-4957-b3aa-b7aaec34be3e","description":{"content":"<p>Company that owns the invoice</p>\n","type":"text/plain"},"type":"any","value":"4bf830c9-ffe7-4c0c-b346-bf4ef5df54fa","key":"company"},{"id":"1dff8f5e-b7d7-4709-8718-9f52f4e171e9","description":{"content":"<p>Invoice to update (Kolleno UUID <em>or</em> source_id from ERP)</p>\n","type":"text/plain"},"type":"any","value":"a5a95331-4400-4a7a-85fd-da3f84d6f138","key":"invoice"}]}},"response":[{"id":"046ffa15-1352-4d66-96fe-af20736af326","name":"HTTP 200 (customer UUID)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n    \"invoice_priority\": \"high\",\n    \"approved_amount\": 10.12\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/invoice/custom-fields/:company/:invoice/","host":[""],"path":["invoice","custom-fields",":company",":invoice",""],"variable":[{"key":"company","value":"4bf830c9-ffe7-4c0c-b346-bf4ef5df54fa"},{"key":"invoice","value":"a5a95331-4400-4a7a-85fd-da3f84d6f138","description":"Invoice to update"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Tue, 13 Jan 2026 17:33:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"PUT, PATCH, OPTIONS"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"Server","value":"HTTPServer/19.1.4"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"40"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Vary","value":"origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"invoice_priority\": \"high\",\n    \"approved_amount\": 10.12\n}"},{"id":"303e6fa6-7c45-4f1f-8ed7-c88cd444bc0d","name":"HTTP 200 (source ID)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n    \"invoice_priority\": \"high\",\n    \"approved_amount\": 10.13\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/invoice/custom-fields/:company/:invoice/?source=netsuite","host":[""],"path":["invoice","custom-fields",":company",":invoice",""],"query":[{"key":"source","value":"netsuite","description":"Send if using the \"source_id\"","type":"text"}],"variable":[{"key":"company","value":"4bf830c9-ffe7-4c0c-b346-bf4ef5df54fa","description":"Company that owns the invoice"},{"key":"invoice","value":"83893955","description":"Invoice to update (Kolleno UUID *or* source_id from ERP)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Tue, 13 Jan 2026 17:35:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"PUT, PATCH, OPTIONS"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"Server","value":"HTTPServer/19.1.4"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"40"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Vary","value":"origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"invoice_priority\": \"high\",\n    \"approved_amount\": 10.13\n}"}],"_postman_id":"725364a3-c413-4e5f-8041-a8ac2724157c"}],"id":"8c2c58e2-4885-4de0-84dc-af112c79817a","description":"<p>This endpoint is used to update values for your Custom Fields on Invoice records.</p>\n<p>See: <a href=\"https://help.kolleno.com/en/articles/11660969-add-custom-fields-to-your-kolleno-customers\">https://help.kolleno.com/en/articles/11660969-add-custom-fields-to-your-kolleno-customers</a> (the same configuration mechanism is used for invoice-scoped custom fields).</p>\n<p>If you are unsure about the fields API names, please reach out to support.</p>\n","_postman_id":"8c2c58e2-4885-4de0-84dc-af112c79817a"},{"name":"Invoice PDF","item":[{"name":"List Invoice PDFs","id":"c7b6fd8a-e89d-43ef-be89-0a204405cee9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"/invoice-pdf/:invoice/","description":"<p>Retrieve all the PDFs uploaded via the API for a given Invoice. At the moment, the API only supports one PDF per Invoice.</p>\n","urlObject":{"path":["invoice-pdf",":invoice",""],"host":[""],"query":[],"variable":[{"id":"242fd19f-cfce-4da3-943b-ac33ed184b5f","description":{"content":"<p>Invoice the PDF belongs to</p>\n","type":"text/plain"},"type":"any","value":"e65c0b7b-25d7-4bfe-a21c-2e4a8cc2d189","key":"invoice"}]}},"response":[{"id":"571323b4-01b5-4270-b20b-45b8f95da8f7","name":"HTTP 403","originalRequest":{"method":"GET","header":[],"url":{"raw":"/invoice-pdf/:invoice/","host":[""],"path":["invoice-pdf",":invoice",""],"variable":[{"key":"invoice","value":"6805ead8-9a89-47a0-8144-83ab6975279b","description":"Invoice the PDF belongs to"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 21 Jan 2021 15:12:59 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"63"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You do not have permission to perform this action.\"\n}"},{"id":"282b9d04-0b99-43d2-ba71-282e41310b15","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/invoice-pdf/:invoice/","host":[""],"path":["invoice-pdf",":invoice",""],"variable":[{"key":"invoice","value":"e65c0b7b-25d7-4bfe-a21c-2e4a8cc2d189","description":"Invoice the PDF belongs to"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 21 Jan 2021 15:12:20 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"239"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"count\": 1,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"a1cfad35-f191-4b5e-95e6-4274dcc1db0b\",\n            \"invoice\": \"e65c0b7b-25d7-4bfe-a21c-2e4a8cc2d189\",\n            \"name\": \"Invoice\",\n            \"extension\": \"pdf\",\n            \"size\": 32026,\n            \"date_created\": \"2021-01-21T15:08:11.025264Z\"\n        }\n    ]\n}"}],"_postman_id":"c7b6fd8a-e89d-43ef-be89-0a204405cee9"},{"name":"Upload Invoice PDF","id":"a50a0a0f-ee8e-4179-ab88-07a089d01611","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"<p>File must be one of: PDF, JPG, JPEG, PNG</p>\n","key":"file","type":"file","src":"/Users/Ron/Downloads/Invoice.pdf"}]},"url":"/invoice-pdf/:invoice/","description":"<p>Upload an Invoice PDF. The uploaded PDF will overwrite the PDF coming from any other source.</p>\n","urlObject":{"path":["invoice-pdf",":invoice",""],"host":[""],"query":[{"disabled":true,"description":{"content":"<p>(optional) Pass ?id_from=source when the Invoice ID in the URL is not the Kolleno ID but the source ID</p>\n","type":"text/plain"},"key":"id_from","value":"source"},{"disabled":true,"description":{"content":"<p>(optional) You must pass it if you link the Invoice by its source_id</p>\n","type":"text/plain"},"key":"company","value":"327b6380-f9f3-4816-ba91-baef6f618e3e"}],"variable":[{"id":"9a4dbf66-d978-4cd5-9396-067507e2ab78","description":{"content":"<p>Invoice ID or Invoice source ID</p>\n","type":"text/plain"},"type":"any","value":"e65c0b7b-25d7-4bfe-a21c-2e4a8cc2d189","key":"invoice"}]}},"response":[{"id":"404ec24b-8b19-418c-95f3-06d9d404a3f9","name":"HTTP 201","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"File must be one of: PDF, JPG, JPEG, PNG","key":"file","type":"file","src":["/Users/Ron/Downloads/Invoice.pdf"]}]},"url":{"raw":"/invoice-pdf/:invoice/","host":[""],"path":["invoice-pdf",":invoice",""],"variable":[{"key":"invoice","value":"e65c0b7b-25d7-4bfe-a21c-2e4a8cc2d189","description":"Invoice the PDF belongs to"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 21 Jan 2021 15:08:11 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"187"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"a1cfad35-f191-4b5e-95e6-4274dcc1db0b\",\n    \"invoice\": \"e65c0b7b-25d7-4bfe-a21c-2e4a8cc2d189\",\n    \"name\": \"Invoice\",\n    \"extension\": \"pdf\",\n    \"size\": 32026,\n    \"date_created\": \"2021-01-21T15:08:11.025264Z\"\n}"},{"id":"c6eb8d0f-d00a-4272-bf8a-43448187923d","name":"HTTP 400","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"File must be one of: PDF, JPG, JPEG, PNG","key":"file","type":"file","src":["/Users/Ron/Downloads/Invoice.pdf"]}]},"url":{"raw":"/invoice-pdf/:invoice/","host":[""],"path":["invoice-pdf",":invoice",""],"variable":[{"key":"invoice","value":"e65c0b7b-25d7-4bfe-a21c-2e4a8cc2d189","description":"Invoice the PDF belongs to"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 21 Jan 2021 15:08:54 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"101"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"non_field_errors\": [\n        \"This invoice already has a PDF. Please delete it before uploading a new one.\"\n    ]\n}"}],"_postman_id":"a50a0a0f-ee8e-4179-ab88-07a089d01611"},{"name":"Delete Invoice PDF","id":"dc336810-d2c7-49c6-89a8-0a127d6387cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[]},"url":"/invoice-pdf/:invoice/:invoice_pdf/","description":"<p>Permanently delete a specific PDF. You can only delete the PDF if the Invoice it refers to has its \"source\" equal to: [\"manual\", \"kolleno_api\"]</p>\n","urlObject":{"path":["invoice-pdf",":invoice",":invoice_pdf",""],"host":[""],"query":[],"variable":[{"id":"0c4ba7b2-6147-4192-8ee6-abfc86078f7a","description":{"content":"<p>Invoice the PDF belongs to</p>\n","type":"text/plain"},"type":"any","value":"e65c0b7b-25d7-4bfe-a21c-2e4a8cc2d189","key":"invoice"},{"id":"e4e7e50d-5e3c-4410-895f-c478b30eb88a","description":{"content":"<p>ID of the PDF to delete</p>\n","type":"text/plain"},"type":"any","value":"12737656-4881-4836-9030-ac5a280214c3","key":"invoice_pdf"}]}},"response":[{"id":"c864e102-f955-4664-a1df-8cf724e7dbfb","name":"HTTP 204","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"/invoice-pdf/:invoice/:invoice_pdf/","host":[""],"path":["invoice-pdf",":invoice",":invoice_pdf",""],"variable":[{"key":"invoice","value":"e65c0b7b-25d7-4bfe-a21c-2e4a8cc2d189","description":"Invoice the PDF belongs to"},{"key":"invoice_pdf","value":"12737656-4881-4836-9030-ac5a280214c3","description":"ID of the PDF to delete"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Thu, 21 Jan 2021 15:06:07 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Allow","value":"DELETE, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"dc336810-d2c7-49c6-89a8-0a127d6387cd"},{"name":"Download Invoice PDF","id":"b2c177bf-21ee-47df-931d-0ba9f17cee43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"/invoice/pdf/:company/:invoice/","description":"<p>It returns a PDF in bytes. The file name can be found in the \"Content-Disposition\" header.</p>\n","urlObject":{"path":["invoice","pdf",":company",":invoice",""],"host":[""],"query":[{"disabled":true,"description":{"content":"<p>(optional) Pass ?id_from=source when the Invoice ID in the URL is not the Kolleno ID but the source ID</p>\n","type":"text/plain"},"key":"id_from","value":"source"}],"variable":[{"id":"21fa7986-494a-4f5d-be9a-056c02125184","type":"any","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","key":"company"},{"id":"c9c51cd0-5dae-44ec-afe0-b2084d05e5fb","description":{"content":"<p>Invoice ID or Invoice source ID</p>\n","type":"text/plain"},"type":"any","value":"f6907627-39c6-4fdc-a692-e11979b03591","key":"invoice"}]}},"response":[],"_postman_id":"b2c177bf-21ee-47df-931d-0ba9f17cee43"}],"id":"fbe25965-35bb-430f-a984-cd86dc9d7e24","description":"<p>Every Invoice can have up to one PDF.</p>\n<p>Example of an object:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>{\n  \"id\": \"a1cfad35-f191-4b5e-95e6-4274dcc1db0b\",\n  \"invoice\": \"e65c0b7b-25d7-4bfe-a21c-2e4a8cc2d189\",\n  \"name\": \"Invoice\",\n  \"extension\": \"pdf\",\n  \"size\": 32026,\n  \"date_created\": \"2021-01-21T15:08:11.025264Z\"\n}\n\n</code></pre>","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"65a9b799-0245-4fd5-8c88-a0ad6aab3b05"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"bf222f92-8968-443a-8630-5b31d2a63715"}}],"_postman_id":"fbe25965-35bb-430f-a984-cd86dc9d7e24"},{"name":"Match","item":[{"name":"List Matches","id":"c323982b-3286-48ab-b8a1-794ae94d7d18","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/match/:company/","description":"<p>Retrieve all the Matches in a given Company. Ordered by \"date_created\".</p>\n<p>Returns <strong>403</strong> if the user the API Key belongs to does not have reconciliation access.</p>\n","urlObject":{"path":["match",":company",""],"host":[""],"query":[{"disabled":true,"description":{"content":"<p>(optional) One of: 'matched', 'confirmed', 'reconciled'</p>\n","type":"text/plain"},"key":"status","value":"wrongvalue"},{"disabled":true,"description":{"content":"<p>(optional) UUID of the Account</p>\n","type":"text/plain"},"key":"account","value":"1536404b-6acd-4730-8878-e7e0928bb06e"},{"disabled":true,"description":{"content":"<p>(optional) To get all records modified at or after a timestamp</p>\n","type":"text/plain"},"key":"date_modified__gte","value":"2026-03-05T13:02:00Z"},{"disabled":true,"description":{"content":"<p>(optional) To get all records modified at or before a timestamp</p>\n","type":"text/plain"},"key":"date_modified__lte","value":"2026-03-05T14:02:00Z"}],"variable":[{"id":"5c439a45-d616-4450-b408-c64394b78260","description":{"content":"<p>UUID of the Company the Matches belong to</p>\n","type":"text/plain"},"type":"any","value":"5a3f7069-56be-443a-978f-bd2a202617de","key":"company"}]}},"response":[{"id":"df01cce3-cbfe-4d33-ae44-f84369c802d4","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/match/:company/","host":[""],"path":["match",":company",""],"query":[{"key":"status","value":"matched","description":"(optional) One of: 'matched', 'confirmed', 'reconciled'","type":"text","disabled":true},{"key":"account","value":"1536404b-6acd-4730-8878-e7e0928bb06e","description":"(optional) UUID of the Account","type":"text","disabled":true},{"key":"date_modified__gte","value":"2026-03-05:13:02:00","description":"(optional) To get all records modified at or after a timestamp","type":"text","disabled":true},{"key":"date_modified__lte","value":"2026-03-05:14:02:00","description":"(optional) To get all records modified at or after a timestamp","type":"text","disabled":true}],"variable":[{"key":"company","value":"5a3f7069-56be-443a-978f-bd2a202617de","description":"UUID of the Company the Matches belong to"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Thu, 05 Mar 2026 13:39:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"Server","value":"HTTPServer/19.1.4"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"510"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Vary","value":"origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"count\": 1,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"80c60f3d-0064-4130-bbee-ced831f34d29\",\n            \"customer\": \"6f969727-9c68-40b0-8611-a02996b3bfb5\",\n            \"account\": \"1536404b-6acd-4730-8878-e7e0928bb06e\",\n            \"account_transaction\": {\n                \"id\": \"39172330-57ba-46c5-9fa7-87cd59fa2c8f\",\n                \"amount\": \"57606.31\",\n                \"currency\": \"USD\",\n                \"reference\": \"PY-398\",\n                \"date_paid\": \"2026-01-06T14:39:20.979237Z\",\n                \"description\": \"For INV-398 INV-084\"\n            },\n            \"status\": \"matched\",\n            \"date_created\": \"2026-03-05T13:26:02.417655Z\",\n            \"date_modified\": \"2026-03-05T13:26:02.417642Z\"\n        }\n    ]\n}"},{"id":"d6860109-f5ff-4e19-abc6-4393e0cad066","name":"HTTP 400","originalRequest":{"method":"GET","header":[],"url":{"raw":"/match/:company/?status=wrongvalue","host":[""],"path":["match",":company",""],"query":[{"key":"status","value":"wrongvalue","description":"(optional) One of: 'matched', 'confirmed', 'reconciled'","type":"text"},{"key":"account","value":"1536404b-6acd-4730-8878-e7e0928bb06e","description":"(optional) UUID of the Account","type":"text","disabled":true},{"key":"date_modified__gte","value":"2026-03-05:13:02:00","description":"(optional) To get all records modified at or after a timestamp","type":"text","disabled":true},{"key":"date_modified__lte","value":"2026-03-05:14:02:00","description":"(optional) To get all records modified at or after a timestamp","type":"text","disabled":true}],"variable":[{"key":"company","value":"5a3f7069-56be-443a-978f-bd2a202617de","description":"UUID of the Company the Matches belong to"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Thu, 05 Mar 2026 13:45:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"Server","value":"HTTPServer/19.1.4"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"85"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Vary","value":"origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": [\n        \"Select a valid choice. wrongvalue is not one of the available choices.\"\n    ]\n}"},{"id":"5ff1bcd3-af6e-4074-608b-d57853b5b23d","name":"HTTP 403","originalRequest":{"method":"GET","header":[],"url":{"raw":"/match/:company/","host":[""],"path":["match",":company",""],"variable":[{"key":"company","value":"5a3f7069-56be-443a-978f-bd2a202617de","description":"A company where you don't have reconciliation access"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You do not have permission to perform this action.\"\n}"}],"_postman_id":"c323982b-3286-48ab-b8a1-794ae94d7d18"},{"name":"Retrieve Match","id":"6581e2da-d84a-41d2-a629-843590e22a54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/match/:company/:match/","description":"<p>Retrieve a specific Match.</p>\n<p>Returns <strong>403</strong> if the user the API Key belongs to does not have reconciliation access.</p>\n","urlObject":{"path":["match",":company",":match",""],"host":[""],"query":[],"variable":[{"id":"ea20800d-3387-447d-9b0a-98459ce4b447","description":{"content":"<p>UUID of the Company the Match belongs to</p>\n","type":"text/plain"},"type":"any","value":"5a3f7069-56be-443a-978f-bd2a202617de","key":"company"},{"id":"59ea710c-2d11-4cfa-8347-91abf18d1214","description":{"content":"<p>UUID of the Match</p>\n","type":"text/plain"},"type":"any","value":"80c60f3d-0064-4130-bbee-ced831f34d29","key":"match"}]}},"response":[{"id":"3bec269d-3293-493b-8132-5103799f85fb","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/match/:company/:match/","host":[""],"path":["match",":company",":match",""],"variable":[{"key":"company","value":"5a3f7069-56be-443a-978f-bd2a202617de","description":"UUID of the Company the Match belongs to"},{"key":"match","value":"80c60f3d-0064-4130-bbee-ced831f34d29"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Thu, 05 Mar 2026 16:05:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"Server","value":"HTTPServer/19.1.4"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"458"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Vary","value":"origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"80c60f3d-0064-4130-bbee-ced831f34d29\",\n    \"customer\": \"6f969727-9c68-40b0-8611-a02996b3bfb5\",\n    \"account\": \"1536404b-6acd-4730-8878-e7e0928bb06e\",\n    \"account_transaction\": {\n        \"id\": \"39172330-57ba-46c5-9fa7-87cd59fa2c8f\",\n        \"amount\": \"57606.31\",\n        \"currency\": \"USD\",\n        \"reference\": \"PY-398\",\n        \"date_paid\": \"2026-01-06T14:39:20.979237Z\",\n        \"description\": \"For INV-398 INV-084\"\n    },\n    \"status\": \"matched\",\n    \"date_created\": \"2026-03-05T13:26:02.417655Z\",\n    \"date_modified\": \"2026-03-05T13:26:02.417642Z\"\n}"},{"id":"011519ac-688a-3b36-9635-f2c9df1d72c3","name":"HTTP 403","originalRequest":{"method":"GET","header":[],"url":{"raw":"/match/:company/:match/","host":[""],"path":["match",":company",":match",""],"variable":[{"key":"company","value":"5a3f7069-56be-443a-978f-bd2a202617de","description":"A company where you don't have reconciliation access"},{"key":"match","value":"80c60f3d-0064-4130-bbee-ced831f34d29"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You do not have permission to perform this action.\"\n}"}],"_postman_id":"6581e2da-d84a-41d2-a629-843590e22a54"}],"id":"e7442931-829e-4ab2-baee-5611bf9d12cd","description":"<p>Matches represent a reconciliation record for a bank transaction. A Match links an account_transaction (the bank/payment movement) to a customer, and tracks where that reconciliation is in its lifecycle.Typical lifecycle:</p>\n<ul>\n<li><p>matched: automatically or manually identified as a likely match</p>\n</li>\n<li><p>confirmed: reviewed/approved and ready to push</p>\n</li>\n<li><p>reconciled: successfully reconciled in the accounting platform</p>\n</li>\n</ul>\n<p>A Match object includes the customer reference, the matched account transaction details, and audit timestamps.</p>\n<p>Example of an object:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"id\": \"0de1f378-8ca1-49a8-8a06-20b2f98fd57f\",\n  \"customer\": \"b703ea7c-5463-4f82-bfeb-e5c14bed37ef\",\n  \"account\": \"1536404b-6acd-4730-8878-e7e0928bb06e\",\n  \"account_transaction\": {\n    \"id\": \"2eb8d54b-4b2b-4a04-bf35-5f74fd47d239\",\n    \"amount\": \"234.00\",\n    \"currency\": \"USD\",\n    \"reference\": \"BANK-TXN-100238\",\n    \"date_paid\": \"2020-11-15T09:30:00Z\",\n    \"description\": \"Payment received via bank transfer\"\n  },\n  \"status\": \"matched\",\n  \"date_modified\": \"2020-11-24T12:53:55.615229Z\",\n  \"date_created\": \"2020-11-24T12:53:55.615242Z\"\n}\n\n</code></pre>\n<p>The Match endpoints require the user the API Key belongs to to have reconciliation access.</p>\n","_postman_id":"e7442931-829e-4ab2-baee-5611bf9d12cd"},{"name":"Person","item":[{"name":"List Persons","id":"c7431ece-c1a7-4622-8c65-395381ba7909","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/person/company/:company/?limit=5&offset=0&customer=c72bb66d-088b-402f-b8d3-11688b12805c","description":"<p>Retrieve all the Persons for a given Company. Ordered by \"date_created\".</p>\n","urlObject":{"path":["person","company",":company",""],"host":[""],"query":[{"description":{"content":"<p>(optional) The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles.</p>\n","type":"text/plain"},"key":"limit","value":"5"},{"description":{"content":"<p>(optional) The offset indicates the starting position of the query in relation to the complete set of unpaginated items.</p>\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"<p>(optional) UUID of the Customer to get all the persons attached to a specific Customer</p>\n","type":"text/plain"},"key":"customer","value":"c72bb66d-088b-402f-b8d3-11688b12805c"},{"disabled":true,"description":{"content":"<p>(optionla) If you pass ?customer query param, you can use the source ID. It returns 'customer_source_id' in the response.</p>\n","type":"text/plain"},"key":"source_customer","value":"kolleno_api"}],"variable":[{"id":"38192b77-4cb4-43cd-9601-e7fb852cdf6c","description":{"content":"<p>Company the Person belongs to</p>\n","type":"text/plain"},"type":"any","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","key":"company"}]}},"response":[{"id":"2b225f8f-6eb9-4b5f-983d-a58c41b3ed95","name":"HTTP 403","originalRequest":{"method":"GET","header":[],"url":{"raw":"/person/company/:company/?limit=5&offset=0","host":[""],"path":["person","company",":company",""],"query":[{"key":"limit","value":"5","description":"(optional) The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles."},{"key":"offset","value":"0","description":"(optional) The offset indicates the starting position of the query in relation to the complete set of unpaginated items."},{"key":"customer","value":"c72bb66d-088b-402f-b8d3-11688b12805c","description":"(optional) UUID of the Customer to get all the persons attached to a specific Customer","type":"text","disabled":true}],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Person belongs to"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 16:52:10 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"63"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You do not have permission to perform this action.\"\n}"},{"id":"ef5fee7e-d2a7-4ee6-a9a6-e1109d79fa58","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/person/company/:company/?limit=5&offset=0","host":[""],"path":["person","company",":company",""],"query":[{"key":"limit","value":"5","description":"(optional) The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles."},{"key":"offset","value":"0","description":"(optional) The offset indicates the starting position of the query in relation to the complete set of unpaginated items."},{"key":"customer","value":"c72bb66d-088b-402f-b8d3-11688b12805c","description":"(optional) UUID of the Customer to get all the persons attached to a specific Customer","disabled":true}],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Person belongs to"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 16:51:32 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"2358"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"count\": 9,\n    \"next\": \"http://localhost:8000/v1/person/c72bb66d-088b-402f-b8d3-11688b12805c/?limit=5&offset=5\",\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"c1575657-d34f-4568-b922-3e21e540ce7d\",\n            \"customer\": \"c72bb66d-088b-402f-b8d3-11688b12805c\",\n            \"email_address\": \"cad@diisr.govt\",\n            \"first_name\": \"\",\n            \"last_name\": \"\",\n            \"gender\": \"\",\n            \"position\": \"\",\n            \"phone_numbers\": [\n                {\n                    \"country\": \"\",\n                    \"number\": \"018009001\",\n                    \"extension\": \"\",\n                    \"carrier_type\": \"undefined\",\n                    \"phone_prefix\": \"\"\n                }\n            ],\n            \"primary\": false,\n            \"source\": \"xero\",\n            \"date_modified\": \"2020-11-24T12:53:56.735961Z\",\n            \"date_created\": \"2020-11-24T12:53:56.735967Z\"\n        },\n        {\n            \"id\": \"20fa0153-eb99-42e1-a7c7-3c17ad95646e\",\n            \"customer\": \"c72bb66d-088b-402f-b8d3-11688b12805c\",\n            \"email_address\": \"\",\n            \"first_name\": \"John\",\n            \"last_name\": \"Doe\",\n            \"gender\": \"m\",\n            \"position\": \"\",\n            \"phone_numbers\": [\n                {\n                    \"country\": \"GB\",\n                    \"number\": \"123\",\n                    \"extension\": \"45\",\n                    \"carrier_type\": \"mobile\",\n                    \"phone_prefix\": \"33\"\n                }\n            ],\n            \"primary\": false,\n            \"source\": \"manual\",\n            \"date_modified\": \"2020-12-06T20:33:08.989130Z\",\n            \"date_created\": \"2020-12-06T20:33:08.989156Z\"\n        },\n        {\n            \"id\": \"139c5947-5f3d-4d16-92c7-69a32e835ce5\",\n            \"customer\": \"c72bb66d-088b-402f-b8d3-11688b12805c\",\n            \"email_address\": \"\",\n            \"first_name\": \"John\",\n            \"last_name\": \"Doe\",\n            \"gender\": \"\",\n            \"position\": \"\",\n            \"phone_numbers\": [\n                {\n                    \"country\": \"GB\",\n                    \"number\": \"123\",\n                    \"extension\": \"45\",\n                    \"carrier_type\": \"mobile\",\n                    \"phone_prefix\": \"33\"\n                }\n            ],\n            \"primary\": false,\n            \"source\": \"kolleno_api\",\n            \"date_modified\": \"2021-01-06T14:53:13.648778Z\",\n            \"date_created\": \"2021-01-06T14:53:13.648802Z\"\n        },\n        {\n            \"id\": \"d99b9115-04ff-4800-a2f4-fb6e8a42b1f7\",\n            \"customer\": \"c72bb66d-088b-402f-b8d3-11688b12805c\",\n            \"email_address\": \"\",\n            \"first_name\": \"John\",\n            \"last_name\": \"Doe\",\n            \"gender\": \"\",\n            \"position\": \"\",\n            \"phone_numbers\": [\n                {\n                    \"country\": \"GB\",\n                    \"number\": \"123\",\n                    \"extension\": \"45\",\n                    \"carrier_type\": \"mobile\",\n                    \"phone_prefix\": \"44\"\n                }\n            ],\n            \"primary\": false,\n            \"external_id\": \"\",\n            \"source\": \"kolleno_api\",\n            \"date_modified\": \"2021-01-06T14:53:41.384241Z\",\n            \"date_created\": \"2021-01-06T14:53:41.384260Z\"\n        },\n        {\n            \"id\": \"6fb439b2-601f-4452-8bba-2ca5366eeb14\",\n            \"customer\": \"c72bb66d-088b-402f-b8d3-11688b12805c\",\n            \"email_address\": \"\",\n            \"first_name\": \"\",\n            \"last_name\": \"\",\n            \"gender\": \"\",\n            \"position\": \"\",\n            \"phone_numbers\": [\n                {\n                    \"country\": \"GB\",\n                    \"number\": \"123\",\n                    \"extension\": \"45\",\n                    \"carrier_type\": \"mobile\",\n                    \"phone_prefix\": \"44\"\n                }\n            ],\n            \"primary\": false,\n            \"external_id\": \"\",\n            \"source\": \"kolleno_api\",\n            \"date_modified\": \"2021-01-06T14:54:20.412171Z\",\n            \"date_created\": \"2021-01-06T14:54:20.412190Z\"\n        }\n    ]\n}"}],"_postman_id":"c7431ece-c1a7-4622-8c65-395381ba7909"},{"name":"Retrieve Person","id":"64e825e1-404b-4697-863b-ee4d89b9a583","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/person/company/:company/:person/","description":"<p>Retrieve a specific Person.</p>\n","urlObject":{"path":["person","company",":company",":person",""],"host":[""],"query":[{"disabled":true,"description":{"content":"<p>(optional) It changes how the {person} in the URL is interpreted.</p>\n","type":"text/plain"},"key":"source","value":"kolleno_api"},{"disabled":true,"description":{"content":"<p>(optional) Adds customer_source_id to response</p>\n","type":"text/plain"},"key":"source_customer","value":"kolleno_api"}],"variable":[{"id":"2b708466-1949-453b-a240-901c93221fc0","description":{"content":"<p>Company the Person belongs to</p>\n","type":"text/plain"},"type":"any","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","key":"company"},{"id":"aebdc222-368f-4990-beab-79cd9497f273","description":{"content":"<p>ID of the Person to retrieve</p>\n","type":"text/plain"},"type":"any","value":"d99b9115-04ff-4800-a2f4-fb6e8a42b1f7","key":"person"}]}},"response":[{"id":"8b39c3de-c171-4e0f-abf7-97840af38de5","name":"HTTP 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"/person/company/:company/:person/","host":[""],"path":["person","company",":company",":person",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Person belongs to"},{"key":"person","value":"52c40798-d783-4b38-b416-dd0023c2fc0f","description":"ID of the Person to retrieve"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 16:59:16 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"23"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"Not found.\"\n}"},{"id":"f720d27f-f54e-42f8-ba91-55460860944a","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/person/company/:company/:person/","host":[""],"path":["person","company",":company",":person",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Person belongs to"},{"key":"person","value":"d99b9115-04ff-4800-a2f4-fb6e8a42b1f7","description":"ID of the Person to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 16:58:25 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"466"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"d99b9115-04ff-4800-a2f4-fb6e8a42b1f7\",\n    \"customer\": \"c72bb66d-088b-402f-b8d3-11688b12805c\",\n    \"email_address\": \"jane@example.com\",\n    \"first_name\": \"Jane\",\n    \"last_name\": \"Doe\",\n    \"gender\": \"f\",\n    \"position\": \"CFO\",\n    \"phone_numbers\": [\n        {\n            \"country\": \"US\",\n            \"number\": \"123\",\n            \"extension\": \"45\",\n            \"carrier_type\": \"mobile\",\n            \"phone_prefix\": \"1\"\n        }\n    ],\n    \"primary\": true,\n    \"source_id\": \"\",\n    \"source\": \"kolleno_api\",\n    \"date_modified\": \"2021-01-06T16:54:11.415080Z\",\n    \"date_created\": \"2021-01-06T14:53:41.384260Z\"\n}"}],"_postman_id":"64e825e1-404b-4697-863b-ee4d89b9a583"},{"name":"Create Person","id":"067c8a79-440f-4e28-b84b-5ddefeb3068a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"customer\": \"6f969727-9c68-40b0-8611-a02996b3bfb5\", // Kolleno ID or customer.source_id if ?source_customer passed in query parameter\n    \"email_address\": \"jane@example.com\",\n    \"first_name\": \"Jane\",\n    \"last_name\": \"Doe\",\n    \"gender\": \"f\",\n    \"position\": \"CFO\",\n    \"phone_numbers\": [\n        {\n            \"carrier_type\": \"mobile\",\n            \"country\": \"US\",\n            \"number\": \"123\",\n            \"extension\": \"45\"\n        }\n    ],\n    \"primary\": false,\n    \"source_id\": \"my_company_ref\"\n}","options":{"raw":{"language":"json"}}},"url":"/person/company/:company/","description":"<p>Create a Person. It will set the field \"source\" to \"kolleno_api\" automatically.</p>\n<p>Info on parameters:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>{\n    \"customer\": \"c72bb66d-088b-402f-b8d3-11688b12805c\", // UUID\n    \"email_address\": \"jane@example.com\",\n    \"first_name\": \"Jane\", //  string (100 characters)\n    \"last_name\": \"Doe\", //  string (100 characters)\n    \"gender\": \"f\", // m, f, null\n    \"position\": \"CFO\", // string (255 characters)\n    \"phone_numbers\": [\n        {\n            \"carrier_type\": \"mobile\", // mobile, landline, voip, undefined\n            \"country\": \"US\", //  Country ISO\n            \"number\": \"123\", // string (100 characters)\n            \"extension\": \"45\" // string (100 characters)\n        }\n    ],\n    \"primary\": false, // boolean - if this is the main contact for this Customer\n    \"external_id\": \"my_company_ref\" // ID in your system so you can keep track of the Customer\n}\n\n</code></pre>","urlObject":{"path":["person","company",":company",""],"host":[""],"query":[{"disabled":true,"description":{"content":"<p>(optional) If the customer ID should be the one from source. Adds customer_source_id to response.</p>\n","type":"text/plain"},"key":"source_customer","value":"kolleno_api"}],"variable":[{"id":"5801d2a5-cb1b-44d5-ae1e-fea455db8206","description":{"content":"<p>Company the Person belongs to</p>\n","type":"text/plain"},"type":"any","value":"5a3f7069-56be-443a-978f-bd2a202617de","key":"company"}]}},"response":[{"id":"d6668d17-980d-4aed-ac13-5d0db3678d79","name":"HTTP 201","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"customer\": \"c72bb66d-088b-402f-b8d3-11688b12805c\",\n    \"email_address\": \"jane@example.com\",\n    \"first_name\": \"Jane\",\n    \"last_name\": \"Doe\",\n    \"gender\": \"f\",\n    \"position\": \"CFO\",\n    \"phone_numbers\": [\n        {\n            \"carrier_type\": \"mobile\",\n            \"country\": \"US\",\n            \"number\": \"123\",\n            \"extension\": \"1\"\n        }\n    ],\n    \"primary\": false,\n    \"external_id\": \"my_company_ref\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/person/company/:company/","host":[""],"path":["person","company",":company",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Person belongs to"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 16:54:35 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"467"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"91b53c64-b088-4447-b805-984aab7f94c1\",\n    \"email_address\": \"jane@example.com\",\n    \"first_name\": \"Jane\",\n    \"last_name\": \"Doe\",\n    \"gender\": \"f\",\n    \"position\": \"CFO\",\n    \"phone_numbers\": [\n        {\n            \"country\": \"US\",\n            \"number\": \"123\",\n            \"extension\": \"45\",\n            \"carrier_type\": \"mobile\",\n            \"phone_prefix\": \"1\"\n        }\n    ],\n    \"primary\": false,\n    \"source_id\": \"my_company_ref\",\n    \"source\": \"kolleno_api\",\n    \"date_modified\": \"2021-01-06T16:54:35.875042Z\",\n    \"date_created\": \"2021-01-06T16:54:35.875061Z\"\n}"}],"_postman_id":"067c8a79-440f-4e28-b84b-5ddefeb3068a"},{"name":"Update Person","id":"06b74b61-bc77-4a54-b452-2d8ce69cb2c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n    \"email_address\": \"jane@example.com\",\n    \"first_name\": \"Janeddddd\",\n    \"last_name\": \"Doe\",\n    \"gender\": \"f\",\n    \"position\": \"CFO\",\n    \"phone_numbers\": [\n        {\n            \"carrier_type\": \"mobile\",\n            \"country\": \"US\",\n            \"number\": \"123\",\n            \"extension\": \"45\"\n        }\n    ],\n    \"primary\": true,\n    \"external_id\": \"my_company_ref\"\n}","options":{"raw":{"language":"json"}}},"url":"/person/company/:company/:person/","description":"<p>Update details about a specific Person.</p>\n<p>Once you have created a Person, it is not possible to move it to another Customer. You will need to delete the Person then re-create it with the correct Customer.</p>\n<p>You can edit all the fields of a Person if \"source\" equals to: [\"manual\", \"kolleno_api\"]. Otherwise, you can only update the fields \"<em>primary</em>\" and \"<em>position_external</em>\".</p>\n","urlObject":{"path":["person","company",":company",":person",""],"host":[""],"query":[{"disabled":true,"description":{"content":"<p>(optional) Adds customer_source_id to response.</p>\n","type":"text/plain"},"key":"source_customer","value":"kolleno_api"},{"disabled":true,"description":{"content":"<p>(optional) It changes how the {person} in the URL is interpreted</p>\n","type":"text/plain"},"key":"source","value":"kolleno_api"}],"variable":[{"id":"5e82d440-f434-45f4-94f1-c8384722b286","description":{"content":"<p>Company the Person belongs to</p>\n","type":"text/plain"},"type":"any","value":"5a3f7069-56be-443a-978f-bd2a202617de","key":"company"},{"id":"ac389cd6-844c-4669-96b2-bc1714466ac8","description":{"content":"<p>ID of the Person to update</p>\n","type":"text/plain"},"type":"any","value":"d4907ff5-54e6-48de-9740-167085e8b6b4","key":"person"}]}},"response":[{"id":"a6456575-d6a1-4282-9121-ea85430c461d","name":"HTTP 404","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n    \"email_address\": \"jane@example.com\",\n    \"first_name\": \"Jane\",\n    \"last_name\": \"Doe\",\n    \"gender\": \"f\",\n    \"position\": \"CFO\",\n    \"phone_numbers\": [\n        {\n            \"carrier_type\": \"mobile\",\n            \"country\": \"ed21bf05-6a3e-4eb7-ab18-cf3246d5d3d2\",\n            \"number\": \"123\",\n            \"extension\": \"45\"\n        }\n    ],\n    \"primary\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/person/company/:company/:person/","host":[""],"path":["person","company",":company",":person",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Person belongs to"},{"key":"person","value":"ce98a956-38c8-478f-aa6b-47454fcfbd2b "}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 16:56:53 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"23"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"Not found.\"\n}"},{"id":"a4237db7-5877-48a8-a768-2f1e95583438","name":"HTTP 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n    \"email_address\": \"jane@example.com\",\n    \"first_name\": \"Jane\",\n    \"last_name\": \"Doe\",\n    \"gender\": \"f\",\n    \"position\": \"CFO\",\n    \"phone_numbers\": [\n        {\n            \"carrier_type\": \"mobile\",\n            \"country\": \"US\",\n            \"number\": \"123\",\n            \"extension\": \"45\"\n        }\n    ],\n    \"primary\": true,\n    \"external_id\": \"my_company_ref\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/person/company/:company/:person/","host":[""],"path":["person","company",":company",":person",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company the Person belongs to"},{"key":"person","value":"d99b9115-04ff-4800-a2f4-fb6e8a42b1f7"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 16:54:11 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"466"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"d99b9115-04ff-4800-a2f4-fb6e8a42b1f7\",\n    \"customer\": \"c72bb66d-088b-402f-b8d3-11688b12805c\",\n    \"email_address\": \"jane@example.com\",\n    \"first_name\": \"Jane\",\n    \"last_name\": \"Doe\",\n    \"gender\": \"f\",\n    \"position\": \"CFO\",\n    \"phone_numbers\": [\n        {\n            \"country\": \"US\",\n            \"number\": \"123\",\n            \"extension\": \"45\",\n            \"carrier_type\": \"mobile\",\n            \"phone_prefix\": \"1\"\n        }\n    ],\n    \"primary\": true,\n    \"source_id\": \"my_company_ref\",\n    \"source\": \"kolleno_api\",\n    \"date_modified\": \"2021-01-06T16:54:11.415080Z\",\n    \"date_created\": \"2021-01-06T14:53:41.384260Z\"\n}"}],"_postman_id":"06b74b61-bc77-4a54-b452-2d8ce69cb2c3"},{"name":"Delete Person","id":"d48b596c-6903-4d86-9bc9-0e1521f3c727","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"/person/company/:company/:person/","description":"<p>Permanently delete a specific Person. You can only delete Persons if \"source\" equals to: [\"manual\", \"kolleno_api\"]</p>\n","urlObject":{"path":["person","company",":company",":person",""],"host":[""],"query":[{"disabled":true,"description":{"content":"<p>(optional) It changes how the {person} in the URL is interpreted.</p>\n","type":"text/plain"},"key":"source","value":"kolleno_api"}],"variable":[{"id":"51b8de18-a626-41b6-aa83-a6a28a548c1f","description":{"content":"<p>Company the Person belongs to</p>\n","type":"text/plain"},"type":"any","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","key":"company"},{"id":"529f618d-e483-4f7c-8484-f603cf96b917","description":{"content":"<p>ID of the Person to delete</p>\n","type":"text/plain"},"type":"any","value":"d99b9115-04ff-4800-a2f4-fb6e8a42b1f7","key":"person"}]}},"response":[{"id":"597b9507-c4df-44e8-ad2e-a4cbd375f196","name":"HTTP 404","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/person/:customer/:person/","host":[""],"path":["person",":customer",":person",""],"variable":[{"key":"customer","value":"c72bb66d-088b-402f-b8d3-11688b12805c","description":"Customer the Person belongs to"},{"key":"person","value":"bf579934-527f-456c-a6e6-fd7e9b056527","description":"ID of the Person to delete"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 17:00:54 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"23"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"Not found.\"\n}"},{"id":"8be444b0-1d6f-4c4e-9630-b3bb730364ee","name":"HTTP 204","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/person/:customer/:person/","host":[""],"path":["person",":customer",":person",""],"variable":[{"key":"customer","value":"c72bb66d-088b-402f-b8d3-11688b12805c","description":"Customer the Person belongs to"},{"key":"person","value":"d99b9115-04ff-4800-a2f4-fb6e8a42b1f7","description":"ID of the Person to delete"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Wed, 06 Jan 2021 16:59:45 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d48b596c-6903-4d86-9bc9-0e1521f3c727"}],"id":"8f658aac-0b5d-4fc5-ad40-84ce3be34713","description":"<p>The contact Persons belong to a Customer (who belongs to a Company).</p>\n<p>Example of an object:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>{\n    \"id\": \"44c47575-ef63-4326-89df-8fc5611a8670\",\n    \"customer\": \"c72bb66d-088b-402f-b8d3-11688b12805c\",\n    \"email_address\": \"\",\n    \"first_name\": \"John\",\n    \"last_name\": \"Doe\",\n    \"gender\": \"\",\n    \"position\": \"\",\n    \"phone_numbers\": [\n        {\n            \"country\": \"US\",\n            \"number\": \"123\",\n            \"extension\": \"45\",\n            \"carrier_type\": \"mobile\",\n            \"phone_prefix\": \"1\"\n        }\n    ],\n    \"primary\": false,\n    \"source_id\": \"\",\n    \"source\": \"kolleno_api\",\n    \"date_modified\": \"2021-01-06T14:54:57.576058Z\",\n    \"date_created\": \"2021-01-06T14:54:57.576078Z\"\n}\n\n</code></pre><h2 id=\"query-parameter-behavior-matrix\">Query Parameter Behavior Matrix</h2>\n<p>The <code>/v1/person/company/{company}/</code> endpoint supports two optional query parameters that enable source-based ID resolution. <code>?source=</code> controls how <code>{person}</code> in the URL is resolved (UUID vs <code>source_id</code>), while <code>?source_customer=</code> controls how customer references are resolved and enriches the response with <code>customer_source_id</code>. Both parameters are independent and can be combined.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>HTTP Method</th>\n<th><code>?source</code></th>\n<th><code>?source_customer</code></th>\n<th>Behavior</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><strong>POST</strong></td>\n<td><em>No effect</em></td>\n<td><em>Not set</em></td>\n<td><code>customer</code> in body = UUID</td>\n</tr>\n<tr>\n<td><strong>POST</strong></td>\n<td><em>No effect</em></td>\n<td><code>workday</code></td>\n<td><code>customer</code> in body = customer's Workday <code>source_id</code>, resolved to UUID. Response includes <code>customer_source_id</code></td>\n</tr>\n<tr>\n<td><strong>GET list</strong></td>\n<td><em>No effect</em></td>\n<td><em>Not set</em></td>\n<td>Returns all persons. <code>?customer=</code> filters by UUID</td>\n</tr>\n<tr>\n<td><strong>GET list</strong></td>\n<td><em>No effect</em></td>\n<td><code>workday</code></td>\n<td>Returns all persons. <code>?customer=</code> filters by customer's Workday <code>source_id</code>. Response items include <code>customer_source_id</code></td>\n</tr>\n<tr>\n<td><strong>GET retrieve</strong></td>\n<td><em>Not set</em></td>\n<td><em>Not set</em></td>\n<td><code>{person}</code> = person UUID</td>\n</tr>\n<tr>\n<td><strong>GET retrieve</strong></td>\n<td><code>kolleno_api</code></td>\n<td><em>Not set</em></td>\n<td><code>{person}</code> = person's <code>source_id</code> where <code>source=kolleno_api</code></td>\n</tr>\n<tr>\n<td><strong>GET retrieve</strong></td>\n<td><em>Not set</em></td>\n<td><code>workday</code></td>\n<td><code>{person}</code> = person UUID. Response includes <code>customer_source_id</code></td>\n</tr>\n<tr>\n<td><strong>GET retrieve</strong></td>\n<td><code>kolleno_api</code></td>\n<td><code>workday</code></td>\n<td><code>{person}</code> = person's <code>source_id</code>. Response includes <code>customer_source_id</code></td>\n</tr>\n<tr>\n<td><strong>PATCH/PUT</strong></td>\n<td><em>Not set</em></td>\n<td><em>Not set</em></td>\n<td><code>{person}</code> = person UUID</td>\n</tr>\n<tr>\n<td><strong>PATCH/PUT</strong></td>\n<td><code>kolleno_api</code></td>\n<td><em>Not set</em></td>\n<td><code>{person}</code> = person's <code>source_id</code> where <code>source=kolleno_api</code></td>\n</tr>\n<tr>\n<td><strong>PATCH/PUT</strong></td>\n<td><em>Not set</em></td>\n<td><code>workday</code></td>\n<td><code>{person}</code> = person UUID. Response includes <code>customer_source_id</code></td>\n</tr>\n<tr>\n<td><strong>PATCH/PUT</strong></td>\n<td><code>kolleno_api</code></td>\n<td><code>workday</code></td>\n<td><code>{person}</code> = person's <code>source_id</code>. Response includes <code>customer_source_id</code></td>\n</tr>\n<tr>\n<td><strong>DELETE</strong></td>\n<td><em>Not set</em></td>\n<td><em>Not set</em></td>\n<td><code>{person}</code> = person UUID. Returns 204</td>\n</tr>\n<tr>\n<td><strong>DELETE</strong></td>\n<td><code>kolleno_api</code></td>\n<td><em>Not set</em></td>\n<td><code>{person}</code> = person's <code>source_id</code>. Returns 204</td>\n</tr>\n<tr>\n<td><strong>DELETE</strong></td>\n<td><em>Not set</em></td>\n<td><code>workday</code></td>\n<td><code>{person}</code> = person UUID. Returns 204 (no response body, so <code>customer_source_id</code> irrelevant)</td>\n</tr>\n<tr>\n<td><strong>DELETE</strong></td>\n<td><code>kolleno_api</code></td>\n<td><code>workday</code></td>\n<td><code>{person}</code> = person's <code>source_id</code>. Returns 204</td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>Summary</strong>: <code>?source</code> controls how <code>{person}</code> is resolved (UUID vs source_id). <code>?source_customer</code> controls how customer references are resolved and adds <code>customer_source_id</code> to responses. They work independently.</p>\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"12a495d9-bfff-4432-a785-21a6407f59e4"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"13f00a0c-9323-4a20-9d84-dfdc238ca561"}}],"_postman_id":"8f658aac-0b5d-4fc5-ad40-84ce3be34713"},{"name":"Person <> Invoice","item":[{"name":"Link Person <> Invoice","id":"64991bff-1356-46de-aab1-d6597a0c0acc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"person","value":"4e9b861a-1288-411b-82aa-2db9fd09f55a","description":"<p>Kolleno UUID</p>\n","type":"text","uuid":"8204436e-fbfc-403e-93eb-efd62d385e93"},{"key":"invoice","value":"970b3b19-fd02-4370-906d-4c950b5a76af","description":"<p>Kolleno UUID</p>\n","type":"text","uuid":"b0a2fd40-f340-44ab-baed-fe9892a2d4d3"}]},"url":"/person-invoice/:company/","urlObject":{"path":["person-invoice",":company",""],"host":[""],"query":[],"variable":[{"id":"e5a21820-4b2f-40d8-869a-6e26f82155a4","type":"any","value":"e8daf191-b85e-4d56-9b1f-1c4f4962102a","key":"company"}]}},"response":[{"id":"d44f6377-a929-49ee-bc04-e222dc9947b1","name":"HTTP 201","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"person","value":"4e9b861a-1288-411b-82aa-2db9fd09f55a","description":"Kolleno UUID","type":"text","uuid":"8204436e-fbfc-403e-93eb-efd62d385e93"},{"key":"invoice","value":"970b3b19-fd02-4370-906d-4c950b5a76af","description":"Kolleno UUID","type":"text","uuid":"b0a2fd40-f340-44ab-baed-fe9892a2d4d3"}]},"url":{"raw":"/person-invoice/:company/","host":[""],"path":["person-invoice",":company",""],"variable":[{"key":"company","value":"e8daf191-b85e-4d56-9b1f-1c4f4962102a"}]}},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Mon, 27 Oct 2025 09:21:04 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"282"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"HTTPServer/19.1.4"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Vary","value":"origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"113b3ca4-a0fa-4936-8e23-2b1ea9cdd7ba\",\n    \"person\": \"4e9b861a-1288-411b-82aa-2db9fd09f55a\",\n    \"invoice\": \"970b3b19-fd02-4370-906d-4c950b5a76af\",\n    \"date_created\": \"2025-10-27T09:18:58.260194Z\",\n    \"date_modified\": \"2025-10-27T09:18:58.260181Z\"\n}"}],"_postman_id":"64991bff-1356-46de-aab1-d6597a0c0acc"},{"name":"Delete Person <> Invoice relationship","id":"901ae085-aa6b-468b-9259-107207aeab86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"/person-invoice/:company/:person_invoice/","description":"<p>This is a soft delete. If you link again the Person to the Invoice after deletion, it will bring it back and simply change the \"date_modified\".</p>\n","urlObject":{"path":["person-invoice",":company",":person_invoice",""],"host":[""],"query":[],"variable":[{"id":"bf666d5b-3b6e-469c-a9fb-b7b8cfad45b7","type":"any","value":"e8daf191-b85e-4d56-9b1f-1c4f4962102a","key":"company"},{"id":"dd1aec2e-39ea-410b-b527-5e91fdffb079","type":"any","value":"113b3ca4-a0fa-4936-8e23-2b1ea9cdd7ba","key":"person_invoice"}]}},"response":[{"id":"9e18a9f8-5d88-4f1d-b79b-ef693e2a227f","name":"HTTP 204","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/person-invoice/:company/:person_invoice/","host":[""],"path":["person-invoice",":company",":person_invoice",""],"variable":[{"key":"company","value":"e8daf191-b85e-4d56-9b1f-1c4f4962102a"},{"key":"person_invoice","value":"113b3ca4-a0fa-4936-8e23-2b1ea9cdd7ba"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Mon, 27 Oct 2025 09:22:02 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"HTTPServer/19.1.4"},{"key":"Allow","value":"DELETE, OPTIONS"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Vary","value":"origin"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"901ae085-aa6b-468b-9259-107207aeab86"}],"id":"f2b30b2f-bbac-4f2e-aa6a-4ef218fb20c2","description":"<p>Mark a contact person as the related contact of an invoice. It is a many-to-many relationship.</p>\n","_postman_id":"f2b30b2f-bbac-4f2e-aa6a-4ef218fb20c2"},{"name":"Position External","item":[{"name":"List Position Externals","id":"970eaafa-4c2a-45ba-b810-77f0938c917b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/position-external/:company/","urlObject":{"path":["position-external",":company",""],"host":[""],"query":[],"variable":[{"id":"f20c7f2a-c7e5-458f-8042-194fa622540b","type":"any","value":"e8daf191-b85e-4d56-9b1f-1c4f4962102a","key":"company"}]}},"response":[{"id":"52fc0772-ebde-4dbf-99bb-90dbc4f32a79","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/position-external/:company/","host":[""],"path":["position-external",":company",""],"variable":[{"key":"company","value":"e8daf191-b85e-4d56-9b1f-1c4f4962102a"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Mon, 27 Oct 2025 09:27:03 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"223"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"HTTPServer/19.1.4"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains; preload"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Vary","value":"origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"count\": 2,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"808af9cc-62e9-4104-9e8d-fca3669ea47e\",\n            \"name\": \"Accounts payable team\",\n            \"source\": \"manual\"\n        },\n        {\n            \"id\": \"d184b725-c611-43ad-8b8b-90aa2cef97c0\",\n            \"name\": \"CFO\",\n            \"source\": \"manual\"\n        }\n    ]\n}"}],"_postman_id":"970eaafa-4c2a-45ba-b810-77f0938c917b"}],"id":"0cc20ff2-b4fa-4dba-81f7-1d834a232431","description":"<p>List all the external Positions (= roles) that you can assign to Person objects.</p>\n","_postman_id":"0cc20ff2-b4fa-4dba-81f7-1d834a232431"},{"name":"Report File","item":[{"name":"List Report Files","id":"4dd7e2b7-fd08-4d5d-8733-cc40ca595f59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"/report-file/:company/","description":"<p>List completed report files for <code>{company}</code> that the authenticated user created or that were sent to them. Only <code>status=completed</code> files that have an actual file in storage are returned. Ordered by <code>date_created</code> desc, then <code>id</code>.</p>\n","urlObject":{"path":["report-file",":company",""],"host":[""],"query":[{"disabled":true,"description":{"content":"<p>(optional) Exact match on the report type's var_name (e.g. \"aging\", \"invoices\", …).</p>\n","type":"text/plain"},"key":"var_name","value":""},{"disabled":true,"description":{"content":"<p>(optional) Only return report files created on or after this ISO 8601 datetime.</p>\n","type":"text/plain"},"key":"date_created__gte","value":"2026-01-01T00:00:00Z"},{"disabled":true,"description":{"content":"<p>(optional) Only return report files created on or before this ISO 8601 datetime.</p>\n","type":"text/plain"},"key":"date_created__lte","value":"2026-12-31T23:59:59Z"},{"disabled":true,"description":{"content":"<p>(optional) Only return report files whose creation date (UTC) matches YYYY-MM-DD.</p>\n","type":"text/plain"},"key":"date_created__date","value":"2026-05-28"}],"variable":[{"id":"bf5c60da-1695-4d19-b887-d28fe610f0bb","description":{"content":"<p>Company UUID the report files belong to. Must be your authenticated user's company.</p>\n","type":"text/plain"},"type":"any","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","key":"company"}]}},"response":[{"id":"d2008e17-bb60-457f-a3cb-f6036bce0fea","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/report-file/:company/","host":[""],"path":["report-file",":company",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"count\": 1,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"a1cfad35-f191-4b5e-95e6-4274dcc1db0b\",\n            \"var_name\": \"detailed_aging\",\n            \"report_type_name\": \"Aging Report\",\n            \"extension\": \"xlsx\",\n            \"size\": 32026,\n            \"status\": \"completed\",\n            \"date_created\": \"2026-05-28T09:14:11.025264Z\"\n        }\n    ]\n}"},{"id":"1974aed5-25e6-459a-8563-cfc8e36dfa09","name":"HTTP 403","originalRequest":{"method":"GET","header":[],"url":{"raw":"/report-file/:company/","host":[""],"path":["report-file",":company",""],"variable":[{"key":"company","value":"6805ead8-9a89-47a0-8144-83ab6975279b","description":"A company you don't have access to"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You do not have permission to perform this action.\"\n}"}],"_postman_id":"4dd7e2b7-fd08-4d5d-8733-cc40ca595f59"},{"name":"Generate Report File","id":"81771b08-68f8-443b-b309-7361f5a52afb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"var_name\": \"transactions_received_list\", // (string) required, the \"var_name\" of a Report Type from List Report Types\n    \"filters\": { // (object) the filters the Report Type accepts, see its \"filters\"\n        \"date_from\": \"2026-09-01\", // (string) date in YYYY-MM-DD format\n        \"date_to\": \"2026-09-30\" // (string) date in YYYY-MM-DD format\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/report-file/:company/","description":"<p>Request a new report file. Kolleno generates the file in the background.</p>\n<p>Send the <code>var_name</code> of a Report Type from <strong>List Report Types</strong>, and the <code>filters</code> that the Report Type accepts. You must send each filter that has <code>\"required\": true</code>. Dates are absolute, in <code>YYYY-MM-DD</code> format.</p>\n<p>Returns <strong>202</strong> with the <code>id</code> and the <code>status</code> of the new report file. Poll <strong>Retrieve Report File Status</strong> until <code>status</code> is <code>completed</code>, then download the file with <strong>Download Report File</strong>.</p>\n<p>Returns <strong>400</strong> if <code>var_name</code> is missing or is not a Report Type you can request, or if a required filter is missing. Returns <strong>403</strong> if the user the API Key belongs to does not have reporting access. Returns <strong>429</strong> if you already have 3 report files being generated for this company: wait for one to finish, then send the request again.</p>\n","urlObject":{"path":["report-file",":company",""],"host":[""],"query":[],"variable":[{"id":"bf5c60da-1695-4d19-b887-d28fe610f0bb","description":{"content":"<p>Company UUID the report files belong to. Must be your authenticated user's company.</p>\n","type":"text/plain"},"type":"any","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","key":"company"}]}},"response":[{"id":"7e5e9b12-2d13-43f5-a1c9-2d604da1ef0c","name":"HTTP 202","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"var_name\": \"transactions_received_list\",\n    \"filters\": {\n        \"date_from\": \"2026-09-01\",\n        \"date_to\": \"2026-09-30\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/report-file/:company/","host":[""],"path":["report-file",":company",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"c5b2d0f4-8e1a-4f6b-9c3d-2a7e5f1b9d40\",\n    \"status\": \"received\",\n    \"var_name\": \"transactions_received_list\"\n}"},{"id":"22223c33-e97e-4297-81e9-ef0402376add","name":"HTTP 403","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"var_name\": \"transactions_received_list\",\n    \"filters\": {\n        \"date_from\": \"2026-09-01\",\n        \"date_to\": \"2026-09-30\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/report-file/:company/","host":[""],"path":["report-file",":company",""],"variable":[{"key":"company","value":"6805ead8-9a89-47a0-8144-83ab6975279b","description":"A company you don't have reporting access to"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You do not have permission to perform this action.\"\n}"},{"id":"025318d9-982f-a23d-b008-ac5794eb0386","name":"HTTP 400","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"var_name\": \"not_a_report\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/report-file/:company/","host":[""],"path":["report-file",":company",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n    \"var_name\": [\n        \"\\\"not_a_report\\\" is not a report type you can request.\"\n    ]\n}"},{"id":"ecc23910-7b4f-72b9-3b0a-9c37ca42976e","name":"HTTP 429","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"var_name\": \"transactions_received_list\",\n    \"filters\": {\n        \"date_from\": \"2026-09-01\",\n        \"date_to\": \"2026-09-30\"\n    }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/report-file/:company/","host":[""],"path":["report-file",":company",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You already have 3 report files being generated for this company. Wait for one to finish before requesting another.\"\n}"}],"_postman_id":"81771b08-68f8-443b-b309-7361f5a52afb"},{"name":"Retrieve Report File Status","id":"d36668bc-804f-4eb1-9a6c-a44381e991f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"/report-file/:company/:report_file/status/","description":"<p>Get the progress of a report file you requested or that was sent to you, in any status. Use it after <strong>Generate Report File</strong> to know when the file is ready.</p>\n<p>The possible \"status\" are: <code>received</code>, <code>in_progress</code>, <code>completed</code> and <code>error</code>. When <code>status</code> is <code>completed</code>, download the file with <strong>Download Report File</strong>. The <code>size</code> is in bytes, and is null until the file is generated.</p>\n<p>Returns <strong>404</strong> if the report file does not exist, or was not created by or sent to the user the API Key belongs to.</p>\n","urlObject":{"path":["report-file",":company",":report_file","status",""],"host":[""],"query":[],"variable":[{"id":"540e620a-f218-41ee-9cae-4cdbcf85a10f","description":{"content":"<p>Company UUID the report file belongs to.</p>\n","type":"text/plain"},"type":"any","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","key":"company"},{"id":"fabe37fe-58be-412e-a36c-37f76ca5c1ac","description":{"content":"<p>Report File UUID (the <code>id</code> returned by the list endpoint).</p>\n","type":"text/plain"},"type":"any","value":"a1cfad35-f191-4b5e-95e6-4274dcc1db0b","key":"report_file"}]}},"response":[{"id":"b2d0e118-a94c-a41f-9852-651209689d26","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/report-file/:company/:report_file/status/","host":[""],"path":["report-file",":company",":report_file","status",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112"},{"key":"report_file","value":"c5b2d0f4-8e1a-4f6b-9c3d-2a7e5f1b9d40"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"c5b2d0f4-8e1a-4f6b-9c3d-2a7e5f1b9d40\",\n    \"var_name\": \"transactions_received_list\",\n    \"report_type_name\": \"Payments Received\",\n    \"extension\": \"xlsx\",\n    \"size\": null,\n    \"status\": \"in_progress\",\n    \"date_created\": \"2026-10-19T09:14:11.025264Z\"\n}"},{"id":"0da343e5-74f0-74fa-3920-37e56f67612b","name":"HTTP 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"/report-file/:company/:report_file/status/","host":[""],"path":["report-file",":company",":report_file","status",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112"},{"key":"report_file","value":"0b6f3a52-7d1e-4c8a-9f2b-5e4d3c2a1b09"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n    \"report_file\": [\n        \"This report file could not be found.\"\n    ]\n}"}],"_postman_id":"d36668bc-804f-4eb1-9a6c-a44381e991f1"},{"name":"Download Report File","id":"8f9f5a35-a0bc-4ee5-96ad-09384fc13484","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"/report-file/:company/:report_file/","description":"<p>Stream a completed report file as an attachment. The download filename is set on the <code>Content-Disposition</code> response header.</p>\n<p>Returns <strong>404</strong> if the report file does not exist, is not yet <code>completed</code>, has no file in storage, or was not created by / sent to the authenticated user. Returns <strong>403</strong> if <code>{company}</code> is not the caller's company.</p>\n","urlObject":{"path":["report-file",":company",":report_file",""],"host":[""],"query":[],"variable":[{"id":"540e620a-f218-41ee-9cae-4cdbcf85a10f","description":{"content":"<p>Company UUID the report file belongs to.</p>\n","type":"text/plain"},"type":"any","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","key":"company"},{"id":"fabe37fe-58be-412e-a36c-37f76ca5c1ac","description":{"content":"<p>Report File UUID (the <code>id</code> returned by the list endpoint).</p>\n","type":"text/plain"},"type":"any","value":"a1cfad35-f191-4b5e-95e6-4274dcc1db0b","key":"report_file"}]}},"response":[],"_postman_id":"8f9f5a35-a0bc-4ee5-96ad-09384fc13484"}],"id":"bbb75cca-4fbc-420c-8df4-a0f372f1e5f6","description":"<p>Generated report files (e.g. aging reports, exported tables, Copilot outputs). Listed by the report type's <code>var_name</code> and downloaded directly from the same path.</p>\n<p>To get a new report file:</p>\n<ol>\n<li><p>Get the <code>var_name</code> and the <code>filters</code> of the report you want from <strong>List Report Types</strong>.</p>\n</li>\n<li><p>Send <strong>Generate Report File</strong>. Kolleno generates the file in the background.</p>\n</li>\n<li><p>Poll <strong>Retrieve Report File Status</strong> until <code>status</code> is <code>completed</code>.</p>\n</li>\n<li><p>Download the file with <strong>Download Report File</strong>.</p>\n</li>\n</ol>\n<p>To get a report file on a schedule instead, see <strong>Report Schedule</strong>.</p>\n<p>Generating a report file requires the user the API Key belongs to to have reporting access.</p>\n<p>Example of an object:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>{\n  \"id\": \"a1cfad35-f191-4b5e-95e6-4274dcc1db0b\",\n  \"var_name\": \"aging\",\n  \"report_type_name\": \"Aging Report\",\n  \"extension\": \"xlsx\",\n  \"size\": 32026,\n  \"status\": \"completed\",\n  \"date_created\": \"2026-05-28T09:14:11.025264Z\"\n}\n</code></pre>","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"bfbd1e1a-381b-4988-99a8-733acf4887dc"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"3eddcdd6-1698-40aa-b170-758c4d621ea2"}}],"_postman_id":"bbb75cca-4fbc-420c-8df4-a0f372f1e5f6"},{"name":"Report Schedule","item":[{"name":"List Report Schedules","id":"8bee7a9a-b041-416e-82a7-b231d4878c40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/report-schedule/:company/","description":"<p>Retrieve the Report Schedules that are delivered to the user the API Key belongs to. Ordered by \"date_created\", newest first.</p>\n","urlObject":{"path":["report-schedule",":company",""],"host":[""],"query":[{"disabled":true,"description":{"content":"<p>(optional) The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles.</p>\n","type":"text/plain"},"key":"limit","value":"5"},{"disabled":true,"description":{"content":"<p>(optional) The offset indicates the starting position of the query in relation to the complete set of unpaginated items.</p>\n","type":"text/plain"},"key":"offset","value":"0"}],"variable":[{"id":"ef5ee692-27d9-47b9-8b35-eb77f418f92e","type":"any","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","key":"company"}]}},"response":[{"id":"bf5ca3e4-4b7b-4218-a7ad-c75f9be5f050","name":"HTTP 403","originalRequest":{"method":"GET","header":[],"url":{"raw":"/report-schedule/:company/","host":[""],"path":["report-schedule",":company",""],"variable":[{"key":"company","value":"6805ead8-9a89-47a0-8144-83ab6975279b","description":"A company you don't have reporting access to"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You do not have permission to perform this action.\"\n}"},{"id":"4140d5b1-9dfa-4b69-b880-b20ad2191191","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/report-schedule/:company/","host":[""],"path":["report-schedule",":company",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"count\": 1,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"3d8f1c2a-6b4e-4f7a-9c0d-1e2b3a4c5d6e\",\n            \"var_name\": \"transactions_received_list\",\n            \"report_type_name\": \"Payments Received\",\n            \"filters\": {\n                \"date_from\": {\"interval\": \"week\", \"value\": \"first_day\", \"past\": -1},\n                \"date_to\": {\"interval\": \"week\", \"value\": \"last_day\", \"past\": -1}\n            },\n            \"dynamic_filters\": {},\n            \"frequency\": \"weekly\",\n            \"day_number\": 0,\n            \"time\": \"08:00:00\",\n            \"date_created\": \"2026-10-19T09:20:41.512908Z\"\n        }\n    ]\n}"}],"_postman_id":"8bee7a9a-b041-416e-82a7-b231d4878c40"},{"name":"Retrieve Report Schedule","id":"28a74317-61c9-5951-a8da-408a8c11b005","request":{"method":"GET","header":[],"url":"/report-schedule/:company/:report_schedule/","description":"<p>Retrieve a specific Report Schedule.</p>\n<p>Returns <strong>404</strong> if the Report Schedule does not exist, was deleted, or is not delivered to the user the API Key belongs to.</p>\n","urlObject":{"path":["report-schedule",":company",":report_schedule",""],"host":[""],"query":[],"variable":[{"type":"any","key":"company"},{"type":"any","key":"report_schedule"}]}},"response":[{"id":"dcafe892-3d64-4800-9314-6c84117a4bd4","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/report-schedule/:company/:report_schedule/","host":[""],"path":["report-schedule",":company",":report_schedule",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112"},{"key":"report_schedule","value":"3d8f1c2a-6b4e-4f7a-9c0d-1e2b3a4c5d6e"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"3d8f1c2a-6b4e-4f7a-9c0d-1e2b3a4c5d6e\",\n    \"var_name\": \"transactions_received_list\",\n    \"report_type_name\": \"Payments Received\",\n    \"filters\": {\n        \"date_from\": {\"interval\": \"week\", \"value\": \"first_day\", \"past\": -1},\n        \"date_to\": {\"interval\": \"week\", \"value\": \"last_day\", \"past\": -1}\n    },\n    \"dynamic_filters\": {},\n    \"frequency\": \"weekly\",\n    \"day_number\": 0,\n    \"time\": \"08:00:00\",\n    \"date_created\": \"2026-10-19T09:20:41.512908Z\"\n}"},{"id":"3fa2828e-0185-4f4d-a524-f56e0827a90b","name":"HTTP 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"/report-schedule/:company/:report_schedule/","host":[""],"path":["report-schedule",":company",":report_schedule",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112"},{"key":"report_schedule","value":"0b6f3a52-7d1e-4c8a-9f2b-5e4d3c2a1b09"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"No ReportSchedule matches the given query.\"\n}"}],"_postman_id":"28a74317-61c9-5951-a8da-408a8c11b005"},{"name":"Create Report Schedule","id":"2407b2c0-aa5b-433a-92d4-33b0c2a36c0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"var_name\": \"transactions_received_list\", // (string) required, the \"var_name\" of a Report Type from List Report Types\n    \"frequency\": \"weekly\", // (string) one of: \"daily\", \"weekly\" (default), \"monthly\"\n    \"day_number\": 0, // (integer) required, 0 for daily, 0 (Monday) to 6 (Sunday) for weekly, 1 to 28 for monthly\n    \"time\": \"08:00:00\", // (string) optional, time of the day in the Company's timezone, \"08:00:00\" by default\n    \"filters\": { // (object) the filters the Report Type accepts, with relative dates\n        \"date_from\": {\"interval\": \"week\", \"value\": \"first_day\", \"past\": -1}, // first day of the previous week\n        \"date_to\": {\"interval\": \"week\", \"value\": \"last_day\", \"past\": -1} // last day of the previous week\n    }\n}","options":{"raw":{"language":"json"}}},"url":"/report-schedule/:company/","description":"<p>Create a Report Schedule. Kolleno then generates the report file on each scheduled day, and sends it to the user the API Key belongs to. Each report file also shows in <strong>List Report Files</strong>.</p>\n<p>Send the <code>var_name</code> of a Report Type from <strong>List Report Types</strong>, the <code>frequency</code>, the <code>day_number</code>, and the <code>filters</code> that the Report Type accepts. You must send each filter that has <code>\"required\": true</code>.</p>\n<p>The dates in <code>filters</code> are relative to the day the report file is generated:</p>\n<ul>\n<li><p><code>{\"interval\": \"day\", \"value\": -30}</code>: a number of days before (negative) or after (positive) that day.</p>\n</li>\n<li><p><code>{\"interval\": \"week\", \"value\": \"first_day\", \"past\": -1}</code>: the first or last day (<code>\"first_day\"</code> or <code>\"last_day\"</code>) of a week or a month (<code>\"week\"</code> or <code>\"month\"</code>). <code>\"past\"</code> is 0 for the current week or month, -1 for the previous one, and so on.</p>\n</li>\n</ul>\n<p>Returns <strong>400</strong> if <code>var_name</code> or <code>day_number</code> is missing, if <code>day_number</code> does not match the <code>frequency</code>, or if a filter is missing or incorrect. Returns <strong>403</strong> if the user the API Key belongs to does not have reporting access.</p>\n","urlObject":{"path":["report-schedule",":company",""],"host":[""],"query":[],"variable":[{"id":"ef5ee692-27d9-47b9-8b35-eb77f418f92e","type":"any","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","key":"company"}]}},"response":[{"id":"28920a3d-5e92-4518-9d8b-f6cd49b15979","name":"HTTP 400","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"var_name\": \"transactions_received_list\",\n    \"frequency\": \"weekly\",\n    \"day_number\": 9,\n    \"filters\": {\n        \"date_from\": {\"interval\": \"week\", \"value\": \"first_day\", \"past\": -1},\n        \"date_to\": {\"interval\": \"week\", \"value\": \"last_day\", \"past\": -1}\n    }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/report-schedule/:company/","host":[""],"path":["report-schedule",":company",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n    \"day_number\": [\n        \"Value should be between 0 and 6 when frequency is 'weekly'.\"\n    ]\n}"},{"id":"54efba15-9bd1-4dd8-9c79-dc49e88bd612","name":"HTTP 201","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"var_name\": \"transactions_received_list\",\n    \"frequency\": \"weekly\",\n    \"day_number\": 0,\n    \"time\": \"08:00:00\",\n    \"filters\": {\n        \"date_from\": {\"interval\": \"week\", \"value\": \"first_day\", \"past\": -1},\n        \"date_to\": {\"interval\": \"week\", \"value\": \"last_day\", \"past\": -1}\n    }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/report-schedule/:company/","host":[""],"path":["report-schedule",":company",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"3d8f1c2a-6b4e-4f7a-9c0d-1e2b3a4c5d6e\",\n    \"var_name\": \"transactions_received_list\",\n    \"report_type_name\": \"Payments Received\",\n    \"filters\": {\n        \"date_from\": {\"interval\": \"week\", \"value\": \"first_day\", \"past\": -1},\n        \"date_to\": {\"interval\": \"week\", \"value\": \"last_day\", \"past\": -1}\n    },\n    \"dynamic_filters\": {},\n    \"frequency\": \"weekly\",\n    \"day_number\": 0,\n    \"time\": \"08:00:00\",\n    \"date_created\": \"2026-10-19T09:20:41.512908Z\"\n}"}],"_postman_id":"2407b2c0-aa5b-433a-92d4-33b0c2a36c0c"},{"name":"Delete Report Schedule","id":"d211b57c-b6d0-9d04-a84f-35977dcf1c74","request":{"method":"DELETE","header":[],"url":"/report-schedule/:company/:report_schedule/","description":"<p>Delete a specific Report Schedule. Kolleno stops generating its report files. The report files it already generated are kept.</p>\n<p>Returns <strong>404</strong> if the Report Schedule does not exist, was already deleted, or is not delivered to the user the API Key belongs to.</p>\n","urlObject":{"path":["report-schedule",":company",":report_schedule",""],"host":[""],"query":[],"variable":[{"type":"any","key":"company"},{"type":"any","key":"report_schedule"}]}},"response":[{"id":"279693cd-7bc2-4027-96a0-114dbb8fc518","name":"HTTP 204","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/report-schedule/:company/:report_schedule/","host":[""],"path":["report-schedule",":company",":report_schedule",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112"},{"key":"report_schedule","value":"3d8f1c2a-6b4e-4f7a-9c0d-1e2b3a4c5d6e"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"45cfc870-418c-4ad9-85e7-9cb03e4d596f","name":"HTTP 404","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/report-schedule/:company/:report_schedule/","host":[""],"path":["report-schedule",":company",":report_schedule",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112"},{"key":"report_schedule","value":"0b6f3a52-7d1e-4c8a-9f2b-5e4d3c2a1b09"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"No ReportSchedule matches the given query.\"\n}"}],"_postman_id":"d211b57c-b6d0-9d04-a84f-35977dcf1c74"}],"id":"652ac670-0256-e127-cd59-14a20a1dc2ec","description":"<p>Report Schedules generate a report file every day, every week or every month. The user the API Key belongs to gets each report file by email, and also finds it in <strong>List Report Files</strong>.</p>\n<p>The \"frequency\" is one of: \"daily\", \"weekly\", \"monthly\". The \"day_number\" depends on it: 0 for daily, 0 (Monday) to 6 (Sunday) for weekly, 1 to 28 for monthly. The \"time\" is in the Company's timezone.</p>\n<p>The dates in \"filters\" are relative to the day the report file is generated, see <strong>Create Report Schedule</strong>. The \"dynamic_filters\" are optional extra filters on the rows of the report, and are empty by default.</p>\n<p>You only see and delete the Report Schedules delivered to the user the API Key belongs to. Managing Report Schedules requires reporting access.</p>\n<p>Example of an object:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>{\n    \"id\": \"3d8f1c2a-6b4e-4f7a-9c0d-1e2b3a4c5d6e\",\n    \"var_name\": \"transactions_received_list\",\n    \"report_type_name\": \"Payments Received\",\n    \"filters\": {\n        \"date_from\": {\"interval\": \"week\", \"value\": \"first_day\", \"past\": -1},\n        \"date_to\": {\"interval\": \"week\", \"value\": \"last_day\", \"past\": -1}\n    },\n    \"dynamic_filters\": {},\n    \"frequency\": \"weekly\",\n    \"day_number\": 0,\n    \"time\": \"08:00:00\",\n    \"date_created\": \"2026-10-19T09:20:41.512908Z\"\n}\n</code></pre>","_postman_id":"652ac670-0256-e127-cd59-14a20a1dc2ec"},{"name":"Report Type","item":[{"name":"List Report Types","id":"fa58bac4-5ca2-4650-bade-28bac1a88521","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/report-type/:company/","description":"<p>Retrieve the Report Types you can request through the API, with the filters each one accepts. Ordered by \"name\".</p>\n<p>Use the <code>var_name</code> to send <strong>Generate Report File</strong> or <strong>Create Report Schedule</strong>.</p>\n<p>Returns <strong>403</strong> if the user the API Key belongs to does not have reporting access.</p>\n","urlObject":{"path":["report-type",":company",""],"host":[""],"query":[{"disabled":true,"description":{"content":"<p>(optional) The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles.</p>\n","type":"text/plain"},"key":"limit","value":"5"},{"disabled":true,"description":{"content":"<p>(optional) The offset indicates the starting position of the query in relation to the complete set of unpaginated items.</p>\n","type":"text/plain"},"key":"offset","value":"0"}],"variable":[{"id":"ef5ee692-27d9-47b9-8b35-eb77f418f92e","type":"any","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","key":"company"}]}},"response":[{"id":"9a4e49a6-ce13-4cdd-8c96-cbdbd2e5615a","name":"HTTP 403","originalRequest":{"method":"GET","header":[],"url":{"raw":"/report-type/:company/","host":[""],"path":["report-type",":company",""],"variable":[{"key":"company","value":"6805ead8-9a89-47a0-8144-83ab6975279b","description":"A company you don't have reporting access to"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You do not have permission to perform this action.\"\n}"},{"id":"11553138-28b1-49e7-8bb8-559f2b8abd01","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/report-type/:company/","host":[""],"path":["report-type",":company",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n    \"count\": 2,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"var_name\": \"detailed_aging\",\n            \"name\": \"Detailed Aging\",\n            \"description\": \"Invoices displayed across the aging groups with a summary & detailed view.\",\n            \"extension\": \"xlsx\",\n            \"filters\": {\n                \"pause_chasing\": {\"label\": \"Pause chasing\", \"type\": \"boolean\", \"required\": false},\n                \"currency\": {\"label\": \"Currency\", \"type\": \"currency\", \"required\": false}\n            }\n        },\n        {\n            \"var_name\": \"transactions_received_list\",\n            \"name\": \"Payments Received\",\n            \"description\": \"Get the list of all the payments you've received between two dates.\",\n            \"extension\": \"xlsx\",\n            \"filters\": {\n                \"date_from\": {\"label\": \"From\", \"type\": \"date\", \"required\": true},\n                \"date_to\": {\"label\": \"To\", \"type\": \"date\", \"required\": true},\n                \"pause_chasing\": {\"label\": \"Pause chasing\", \"type\": \"boolean\", \"required\": false}\n            }\n        }\n    ]\n}"}],"_postman_id":"fa58bac4-5ca2-4650-bade-28bac1a88521"}],"id":"7ce974ec-61b5-851b-df22-e64c209eabec","description":"<p>Report Types are the reports you can request through the API. Use the \"var_name\" of a Report Type to send <strong>Generate Report File</strong> or <strong>Create Report Schedule</strong>.</p>\n<p>The \"filters\" are the filters the Report Type accepts, each with its \"label\", its \"type\" and whether it is \"required\". Send the filters with the same keys.</p>\n<p>Listing Report Types requires the user the API Key belongs to to have reporting access.</p>\n<p>Example of an object:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>{\n    \"var_name\": \"transactions_received_list\",\n    \"name\": \"Payments Received\",\n    \"description\": \"Get the list of all the payments you've received between two dates.\",\n    \"extension\": \"xlsx\",\n    \"filters\": {\n        \"date_from\": {\"label\": \"From\", \"type\": \"date\", \"required\": true},\n        \"date_to\": {\"label\": \"To\", \"type\": \"date\", \"required\": true},\n        \"pause_chasing\": {\"label\": \"Pause chasing\", \"type\": \"boolean\", \"required\": false}\n    }\n}\n</code></pre>","_postman_id":"7ce974ec-61b5-851b-df22-e64c209eabec"},{"name":"Tag","item":[{"name":"List Tags","id":"b6b108b9-8b0f-4699-88b4-15af0236cb25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/tag/:company/","description":"<p>Retrieve all the Tags in a given Company. Ordered by \"name\".</p>\n","urlObject":{"path":["tag",":company",""],"host":[""],"query":[{"disabled":true,"description":{"content":"<p>(optional) The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles.</p>\n","type":"text/plain"},"key":"limit","value":"5"},{"disabled":true,"description":{"content":"<p>(optional) The offset indicates the starting position of the query in relation to the complete set of unpaginated items.</p>\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"<p>(optional) Filter to get only the Tag with this exact name</p>\n","type":"text/plain"},"key":"name","value":"Disputed"},{"disabled":true,"description":{"content":"<p>(optional) Filter to get only the Tags of a specific Tag Category</p>\n","type":"text/plain"},"key":"tag_category","value":"6f2c1a7d-9c31-4e6b-8b52-1d5e9a7c4f80"}],"variable":[{"id":"74301762-6c27-40a8-ab79-913c208c9545","description":{"content":"<p>Company the Tags belong to</p>\n","type":"text/plain"},"type":"any","value":"5a3f7069-56be-443a-978f-bd2a202617de","key":"company"}]}},"response":[],"_postman_id":"b6b108b9-8b0f-4699-88b4-15af0236cb25"},{"name":"Retrieve Tag","id":"be2c2875-fdea-45ad-81ae-4ee8926c1223","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/tag/:company/:tag/","description":"<p>Retrieve a specific Tag.</p>\n","urlObject":{"path":["tag",":company",":tag",""],"host":[""],"query":[],"variable":[{"id":"b8102b50-9676-4cde-843c-2d0a0e5f53e6","description":{"content":"<p>Company the Tag belongs to</p>\n","type":"text/plain"},"type":"any","value":"5a3f7069-56be-443a-978f-bd2a202617de","key":"company"},{"id":"dc009f94-6cdc-4cfa-9c55-a29930a19cdd","description":{"content":"<p>ID of the Tag to retrieve</p>\n","type":"text/plain"},"type":"any","value":"0f0d9f34-1f0c-4a0e-9f6a-4e3f2f5c9b21","key":"tag"}]}},"response":[],"_postman_id":"be2c2875-fdea-45ad-81ae-4ee8926c1223"},{"name":"Create Tag","id":"8466d803-57e6-48fd-adf8-10beb9e0ba53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"name\": \"Disputed\", // (string) name of the tag, unique within the Company\n    \"color\": \"FF0000\", // (string) 6 hexadecimal characters, without the leading \"#\"\n    \"description\": \"The customer raised a dispute\", // (string) optional description\n    \"tag_category\": \"6f2c1a7d-9c31-4e6b-8b52-1d5e9a7c4f80\" // (string) optional UUID of the Tag Category it belongs to\n}","options":{"raw":{"language":"json"}}},"url":"/tag/:company/","description":"<p>Create a Tag. Only \"name\" is required.</p>\n<p>The \"name\" has to be unique among the Tags of the Company, and the \"tag_category\" has to belong to the same Company.</p>\n","urlObject":{"path":["tag",":company",""],"host":[""],"query":[],"variable":[{"id":"dbf90c32-b74d-4e5d-a097-c6a47dc6ba7f","description":{"content":"<p>Company the Tag belongs to</p>\n","type":"text/plain"},"type":"any","value":"5a3f7069-56be-443a-978f-bd2a202617de","key":"company"}]}},"response":[],"_postman_id":"8466d803-57e6-48fd-adf8-10beb9e0ba53"},{"name":"Update Tag","id":"f23990c4-19bc-480d-97a0-7821ca2c0ad2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n    \"name\": \"Disputed\", // (string) name of the tag, unique within the Company\n    \"color\": \"FF0000\", // (string) 6 hexadecimal characters, without the leading \"#\"\n    \"description\": \"The customer raised a dispute\", // (string) optional description\n    \"tag_category\": \"6f2c1a7d-9c31-4e6b-8b52-1d5e9a7c4f80\" // (string) optional UUID of the Tag Category it belongs to\n}","options":{"raw":{"language":"json"}}},"url":"/tag/:company/:tag/","description":"<p>Update a specific Tag. Renaming a Tag or changing its colour is reflected everywhere the Tag is assigned.</p>\n<p>Send \"tag_category\": null to take the Tag out of its category.</p>\n","urlObject":{"path":["tag",":company",":tag",""],"host":[""],"query":[],"variable":[{"id":"8d651ff6-63a0-47d6-8bb3-cbac869a308c","description":{"content":"<p>Company the Tag belongs to</p>\n","type":"text/plain"},"type":"any","value":"5a3f7069-56be-443a-978f-bd2a202617de","key":"company"},{"id":"83d323eb-7c9c-4e7f-8535-8d75e8ee8e33","description":{"content":"<p>ID of the Tag to update</p>\n","type":"text/plain"},"type":"any","value":"0f0d9f34-1f0c-4a0e-9f6a-4e3f2f5c9b21","key":"tag"}]}},"response":[],"_postman_id":"f23990c4-19bc-480d-97a0-7821ca2c0ad2"},{"name":"Delete Tag","id":"fd1a0ba3-e300-4bdf-8561-c386bbf6c22c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"/tag/:company/:tag/","description":"<p>Delete a specific Tag. The Tag is removed from everything it is assigned to, including the workflow steps that add or remove it, so the deletion cannot be undone.</p>\n","urlObject":{"path":["tag",":company",":tag",""],"host":[""],"query":[],"variable":[{"id":"bb988742-8576-4770-80d0-34ac5dd555c5","description":{"content":"<p>Company the Tag belongs to</p>\n","type":"text/plain"},"type":"any","value":"5a3f7069-56be-443a-978f-bd2a202617de","key":"company"},{"id":"c258c432-fda0-458f-8808-e1f8597ed893","description":{"content":"<p>ID of the Tag to delete</p>\n","type":"text/plain"},"type":"any","value":"0f0d9f34-1f0c-4a0e-9f6a-4e3f2f5c9b21","key":"tag"}]}},"response":[],"_postman_id":"fd1a0ba3-e300-4bdf-8561-c386bbf6c22c"}],"id":"deb40875-be12-4454-8bf0-f4dd523a1f0e","description":"<p>Tags are labels owned by Kolleno that you can assign to your Invoices. A Tag optionally belongs to a Tag Category.</p>\n<p>Example of an object:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>{\n    \"id\": \"0f0d9f34-1f0c-4a0e-9f6a-4e3f2f5c9b21\",\n    \"name\": \"Disputed\",\n    \"color\": \"FF0000\",\n    \"description\": \"The customer raised a dispute\",\n    \"tag_category\": {\n        \"id\": \"6f2c1a7d-9c31-4e6b-8b52-1d5e9a7c4f80\",\n        \"name\": \"Collections\"\n    }\n}\n\n</code></pre><p>The \"tag_category\" is returned as an object, and is null when the Tag has no category. To create or update a Tag, send the UUID of the Tag Category instead.</p>\n<p>Creating, updating and deleting Tags requires the user the API Key belongs to to have tag management access, exactly as in the user interface.</p>\n","_postman_id":"deb40875-be12-4454-8bf0-f4dd523a1f0e"},{"name":"Tag Category","item":[{"name":"List Tag Categories","id":"316275d3-24ee-454e-b7b2-8b1883705ef6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/tag/category/:company/","description":"<p>Retrieve all the Tag Categories in a given Company. Ordered by \"name\".</p>\n","urlObject":{"path":["tag","category",":company",""],"host":[""],"query":[{"disabled":true,"description":{"content":"<p>(optional) The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles.</p>\n","type":"text/plain"},"key":"limit","value":"5"},{"disabled":true,"description":{"content":"<p>(optional) The offset indicates the starting position of the query in relation to the complete set of unpaginated items.</p>\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"<p>(optional) Filter to get only the Tag Category with this exact name</p>\n","type":"text/plain"},"key":"name","value":"Collections"}],"variable":[{"id":"4e0f87d5-aac5-4f3d-b14a-e5c7d7cbdd91","description":{"content":"<p>Company the Tag Categories belong to</p>\n","type":"text/plain"},"type":"any","value":"5a3f7069-56be-443a-978f-bd2a202617de","key":"company"}]}},"response":[],"_postman_id":"316275d3-24ee-454e-b7b2-8b1883705ef6"},{"name":"Retrieve Tag Category","id":"6e5c19cb-1216-43ea-8de6-5b45663fec6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/tag/category/:company/:tag_category/","description":"<p>Retrieve a specific Tag Category.</p>\n","urlObject":{"path":["tag","category",":company",":tag_category",""],"host":[""],"query":[],"variable":[{"id":"421c79d3-4218-4507-a86b-7ac45a964c54","description":{"content":"<p>Company the Tag Category belongs to</p>\n","type":"text/plain"},"type":"any","value":"5a3f7069-56be-443a-978f-bd2a202617de","key":"company"},{"id":"3955c5f7-8768-4fe4-b85b-cfc5bcc4f32f","description":{"content":"<p>ID of the Tag Category to retrieve</p>\n","type":"text/plain"},"type":"any","value":"6f2c1a7d-9c31-4e6b-8b52-1d5e9a7c4f80","key":"tag_category"}]}},"response":[],"_postman_id":"6e5c19cb-1216-43ea-8de6-5b45663fec6e"},{"name":"Create Tag Category","id":"6db5c5a8-7f90-42de-96d1-5f21917a489e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"name\": \"Collections\" // (string) name of the tag category, unique within the Company\n}","options":{"raw":{"language":"json"}}},"url":"/tag/category/:company/","description":"<p>Create a Tag Category. The \"name\" has to be unique among the Tag Categories of the Company.</p>\n","urlObject":{"path":["tag","category",":company",""],"host":[""],"query":[],"variable":[{"id":"8e5f300a-6d2a-4aa8-b390-00fc33d54f0d","description":{"content":"<p>Company the Tag Category belongs to</p>\n","type":"text/plain"},"type":"any","value":"5a3f7069-56be-443a-978f-bd2a202617de","key":"company"}]}},"response":[],"_postman_id":"6db5c5a8-7f90-42de-96d1-5f21917a489e"},{"name":"Update Tag Category","id":"a049f8e2-a999-4ed9-a2db-86b19b5c5e3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n    \"name\": \"Collections\" // (string) name of the tag category, unique within the Company\n}","options":{"raw":{"language":"json"}}},"url":"/tag/category/:company/:tag_category/","description":"<p>Update a specific Tag Category.</p>\n","urlObject":{"path":["tag","category",":company",":tag_category",""],"host":[""],"query":[],"variable":[{"id":"995a8743-0a87-4593-a221-a1a7d95c3fdf","description":{"content":"<p>Company the Tag Category belongs to</p>\n","type":"text/plain"},"type":"any","value":"5a3f7069-56be-443a-978f-bd2a202617de","key":"company"},{"id":"4c1fcb65-d65a-43e4-9384-ec3ec6a6fe46","description":{"content":"<p>ID of the Tag Category to update</p>\n","type":"text/plain"},"type":"any","value":"6f2c1a7d-9c31-4e6b-8b52-1d5e9a7c4f80","key":"tag_category"}]}},"response":[],"_postman_id":"a049f8e2-a999-4ed9-a2db-86b19b5c5e3a"},{"name":"Delete Tag Category","id":"c75f4afd-c779-4c43-9d08-494134ab4315","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"/tag/category/:company/:tag_category/","description":"<p>Delete a specific Tag Category. Its Tags are kept, and are left without a category.</p>\n","urlObject":{"path":["tag","category",":company",":tag_category",""],"host":[""],"query":[],"variable":[{"id":"ac3ab656-c9f4-4bb6-a7af-0be8a7cb6eb5","description":{"content":"<p>Company the Tag Category belongs to</p>\n","type":"text/plain"},"type":"any","value":"5a3f7069-56be-443a-978f-bd2a202617de","key":"company"},{"id":"4d23c97d-63ad-41eb-9a1c-00fb5a9b53f8","description":{"content":"<p>ID of the Tag Category to delete</p>\n","type":"text/plain"},"type":"any","value":"6f2c1a7d-9c31-4e6b-8b52-1d5e9a7c4f80","key":"tag_category"}]}},"response":[],"_postman_id":"c75f4afd-c779-4c43-9d08-494134ab4315"}],"id":"5e2cc032-55c4-4527-8db7-27912a9969ef","description":"<p>Tag Categories group the Tags of a Company. They are optional: a Tag can exist without one.</p>\n<p>Example of an object:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>{\n    \"id\": \"6f2c1a7d-9c31-4e6b-8b52-1d5e9a7c4f80\",\n    \"name\": \"Collections\"\n}\n\n</code></pre><p>Creating, updating and deleting Tag Categories requires the user the API Key belongs to to have tag management access, exactly as in the user interface.</p>\n","_postman_id":"5e2cc032-55c4-4527-8db7-27912a9969ef"},{"name":"Template","item":[{"name":"List Templates","id":"cc096e85-936b-4275-9c04-05391c9a4df4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/template/:company/","description":"<p>Retrieve the Templates in a given Company. Ordered by \"name\".</p>\n<p>Use it to get the name of the \"template\" of an email sent (see <strong>Email Sent</strong>).</p>\n","urlObject":{"path":["template",":company",""],"host":[""],"query":[{"disabled":true,"description":{"content":"<p>(optional) The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles.</p>\n","type":"text/plain"},"key":"limit","value":"5"},{"disabled":true,"description":{"content":"<p>(optional) The offset indicates the starting position of the query in relation to the complete set of unpaginated items.</p>\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"<p>(optional) Filter to get only the Templates of a channel: email or text_message</p>\n","type":"text/plain"},"key":"channel","value":"email"}],"variable":[{"id":"ef5ee692-27d9-47b9-8b35-eb77f418f92e","type":"any","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","key":"company"}]}},"response":[{"id":"bbf79653-6af2-49a7-919a-dde1be73ce60","name":"HTTP 403","originalRequest":{"method":"GET","header":[],"url":{"raw":"/template/:company/","host":[""],"path":["template",":company",""],"variable":[{"key":"company","value":"6805ead8-9a89-47a0-8144-83ab6975279b","description":"A company you don't have access to"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You do not have permission to perform this action.\"\n}"},{"id":"af38f7cb-25ac-4d86-8982-fedf3c0ce539","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/template/:company/","host":[""],"path":["template",":company",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n    \"count\": 2,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"3f8b6d2a-9c41-4e7f-b5a3-8d1e6c2f4a97\",\n            \"name\": \"Overdue reminder\",\n            \"channel\": \"email\",\n            \"category\": \"overdue\"\n        },\n        {\n            \"id\": \"8c2e5a71-4d3b-4f96-a1e8-7b9d0c6f3e52\",\n            \"name\": \"Payment reminder SMS\",\n            \"channel\": \"text_message\",\n            \"category\": \"reminder\"\n        }\n    ]\n}"}],"_postman_id":"cc096e85-936b-4275-9c04-05391c9a4df4"}],"id":"d0d497e8-3717-19b4-bbfe-00594925e4fc","description":"<p>Templates are the emails and text messages your workflows send to your Customers. Use them to get the name of the \"template\" of an email sent (see <strong>Email Sent</strong>).</p>\n<p>The possible \"channel\" are: email, text_message</p>\n<p>The possible \"category\" are: other, reminder, overdue, escalation</p>\n<p>Deleted Templates are not returned, so the \"template\" of an older email sent can be missing from the list.</p>\n<p>Example of an object:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>{\n    \"id\": \"3f8b6d2a-9c41-4e7f-b5a3-8d1e6c2f4a97\",\n    \"name\": \"Overdue reminder\",\n    \"channel\": \"email\",\n    \"category\": \"overdue\"\n}\n</code></pre>","_postman_id":"d0d497e8-3717-19b4-bbfe-00594925e4fc"},{"name":"Timeline","item":[{"name":"List of Steps","id":"a3562aca-a5d8-4be9-96eb-c6765cab0580","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/step/:company/?limit=5&offset=0","description":"<p>Retrieve the Steps in a given Company. Ordered by \"date_event\", newest first.</p>\n<p>Steps with the same \"date_event\" are ordered by \"id\", so paging with <code>limit</code> and <code>offset</code> does not skip or repeat them.</p>\n","urlObject":{"path":["step",":company",""],"host":[""],"query":[{"description":{"content":"<p>(optional) The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles.</p>\n","type":"text/plain"},"key":"limit","value":"5"},{"description":{"content":"<p>(optional) The offset indicates the starting position of the query in relation to the complete set of unpaginated items.</p>\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"<p>(optionla) In order to filter to only get the steps from a specific Customer</p>\n","type":"text/plain"},"key":"customer","value":"b703ea7c-5463-4f82-bfeb-e5c14bed37ef"},{"disabled":true,"description":{"content":"<p>(optional) Get additional fields in the response (comma separated)</p>\n","type":"text/plain"},"key":"extra_fields","value":"contacts,content"}],"variable":[{"id":"bff39841-86ae-42ee-a1ae-a7da27a1cae9","description":{"content":"<p>Company to search for Steps</p>\n","type":"text/plain"},"type":"any","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","key":"company"}]}},"response":[{"id":"653f8ae4-c00f-4b2f-b6bf-c7a8623cdb4b","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/step/:company/?limit=5&offset=0","host":[""],"path":["step",":company",""],"query":[{"key":"limit","value":"5","description":"(optional) The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles."},{"key":"offset","value":"0","description":"(optional) The offset indicates the starting position of the query in relation to the complete set of unpaginated items.\n\n"},{"key":"customer","value":"b703ea7c-5463-4f82-bfeb-e5c14bed37ef","description":"(optionla) In order to filter to only get the steps from a specific Customer","disabled":true}],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","description":"Company to search for Steps"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 30 May 2023 13:14:44 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.8.5"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"920"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"count\": 1020,\n    \"next\": \"http://localhost:8000/v1/step/7017d236-cc07-44bc-bb86-8d0cd4335112/?limit=5&offset=5\",\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"78144b5c-4f7d-4d4f-b3c3-16f11ce334ad\",\n            \"customer\": \"fe42ffeb-99b7-4d9c-a2c7-d76b65967525\",\n            \"category\": \"transaction\",\n            \"date_event\": \"2023-04-12T15:08:53.917108Z\"\n        },\n        {\n            \"id\": \"7236d78e-4fa4-4a1d-8488-133eb6f8a550\",\n            \"customer\": \"4f81b190-b460-4291-ac96-1766a9b2cbee\",\n            \"category\": \"email_sent\",\n            \"date_event\": \"2022-11-17T14:40:51Z\"\n        },\n        {\n            \"id\": \"43ae1616-edc1-421b-b116-6b644a2d3026\",\n            \"customer\": \"f6acf12f-84c2-46aa-9713-5776091e4bec\",\n            \"category\": \"note\",\n            \"date_event\": \"2022-11-02T13:59:14Z\"\n        },\n        {\n            \"id\": \"7f96d579-ccc9-4eb3-8def-fe0c014cf7a3\",\n            \"customer\": \"c72bb66d-088b-402f-b8d3-11688b12805c\",\n            \"category\": \"transaction\",\n            \"date_event\": \"2022-07-15T00:00:00Z\"\n        },\n        {\n            \"id\": \"4ffd34e3-3659-4c4f-8710-61339e3a36ea\",\n            \"customer\": \"376450df-814e-4f79-bf1d-f08ad7257832\",\n            \"category\": \"transaction\",\n            \"date_event\": \"2022-07-13T00:00:00Z\"\n        }\n    ]\n}"}],"_postman_id":"a3562aca-a5d8-4be9-96eb-c6765cab0580"}],"id":"5ea2827c-a749-419f-bce2-8ad77f40d78e","description":"<p>Get the list of Steps (events in the Customers timelines).</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\"> {\n    \"id\": \"78144b5c-4f7d-4d4f-b3c3-16f11ce334ad\",\n    \"customer\": \"fe42ffeb-99b7-4d9c-a2c7-d76b65967525\",\n    \"category\": \"email_sent\",\n    \"date_event\": \"2023-04-12T15:08:53.917108Z\"\n}\n\n</code></pre>\n<p>The possible \"category\" are:</p>\n<p>call_inbound, call_outbound, credit_note, email_sent, email_received, invoice, note, promise_to_pay, text_message_sent, text_message_received, transaction, invoice_due</p>\n","_postman_id":"5ea2827c-a749-419f-bce2-8ad77f40d78e"},{"name":"Transaction","item":[{"name":"List Transactions","id":"2266a2ef-595e-4c3d-b2bf-c128243a4e71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/transaction/:customer/?limit=5&offset=0","description":"<p>Retrieve all the Transactions for a given Customer. Ordered by \"date_created\".</p>\n","urlObject":{"path":["transaction",":customer",""],"host":[""],"query":[{"description":{"content":"<p>(optional) The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles.</p>\n","type":"text/plain"},"key":"limit","value":"5"},{"description":{"content":"<p>(optional) The offset indicates the starting position of the query in relation to the complete set of unpaginated items.</p>\n","type":"text/plain"},"key":"offset","value":"0"}],"variable":[{"id":"21fa3cf3-8a2f-4149-a797-9e496b50bcd7","description":{"content":"<p>Customer the Transactions belong to</p>\n","type":"text/plain"},"type":"any","value":"c72bb66d-088b-402f-b8d3-11688b12805c","key":"customer"}]}},"response":[{"id":"76430b08-ff7c-4c90-a5d6-43ededb5c324","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/transaction/:customer/?limit=5&offset=0","host":[""],"path":["transaction",":customer",""],"query":[{"key":"limit","value":"5","description":"(optional) The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles."},{"key":"offset","value":"0","description":"(optional) The offset indicates the starting position of the query in relation to the complete set of unpaginated items."}],"variable":[{"key":"customer","value":"c72bb66d-088b-402f-b8d3-11688b12805c","description":"Customer the Transactions belong to"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Jan 2021 12:34:30 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"971"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"count\": 2,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"05d5a320-bbb3-4250-b81c-984079dedb7f\",\n            \"customer\": \"c72bb66d-088b-402f-b8d3-11688b12805c\",\n            \"amount\": \"250.00\",\n            \"currency\": \"USD\",\n            \"ref\": \"\",\n            \"date_paid\": \"2020-11-01\",\n            \"prepayment\": false,\n            \"overpayment\": false,\n            \"extra_data\": {},\n            \"source\": \"xero\",\n            \"date_modified\": \"2020-11-24T12:53:55.687545Z\",\n            \"date_created\": \"2020-11-24T12:53:55.687564Z\",\n            \"transaction_invoices\": [\n                {\n                    \"invoice\": \"20d513ab-94d0-497d-a1d5-4fd0c8d42282\",\n                    \"amount\": \"250.00\"\n                }\n            ]\n        },\n        {\n            \"id\": \"935b8aa7-f922-4877-9580-706c63fc9241\",\n            \"customer\": \"c72bb66d-088b-402f-b8d3-11688b12805c\",\n            \"amount\": \"579.37\",\n            \"currency\": \"USD\",\n            \"ref\": \"\",\n            \"date_paid\": \"2020-11-01\",\n            \"prepayment\": false,\n            \"overpayment\": false,\n            \"extra_data\": {},\n            \"source\": \"xero\",\n            \"date_modified\": \"2020-11-24T12:53:55.688041Z\",\n            \"date_created\": \"2020-11-24T12:53:55.688048Z\",\n            \"transaction_invoices\": [\n                {\n                    \"invoice\": \"ee13937b-c68c-4358-9052-156b03c47e37\",\n                    \"amount\": \"579.37\"\n                }\n            ]\n        }\n    ]\n}"},{"id":"8ce0c5ae-7956-484b-a677-bb74f1e9cca7","name":"HTTP 403","originalRequest":{"method":"GET","header":[],"url":{"raw":"/transaction/:customer/?limit=5&offset=0","host":[""],"path":["transaction",":customer",""],"query":[{"key":"limit","value":"5","description":"(optional) The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles."},{"key":"offset","value":"0","description":"(optional) The offset indicates the starting position of the query in relation to the complete set of unpaginated items."}],"variable":[{"key":"customer","value":"0bac0f16-003b-483c-93d2-be1aebf47545","description":"Customer the Transactions belong to"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Jan 2021 12:34:55 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"63"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You do not have permission to perform this action.\"\n}"}],"_postman_id":"2266a2ef-595e-4c3d-b2bf-c128243a4e71"},{"name":"Retrieve Transaction","id":"71cc246b-88be-498f-8384-59ea18906de9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/transaction/:customer/:transaction/","description":"<p>Retrieve a specific Transaction</p>\n","urlObject":{"path":["transaction",":customer",":transaction",""],"host":[""],"query":[],"variable":[{"id":"c3641e0f-0707-4824-b067-c467ad94b57d","description":{"content":"<p>Customer the Transaction belongs to</p>\n","type":"text/plain"},"type":"any","value":"c72bb66d-088b-402f-b8d3-11688b12805c","key":"customer"},{"id":"99e3a775-1972-4dd9-8a65-f3899ac093a4","description":{"content":"<p>ID of the Transaction to retrieve</p>\n","type":"text/plain"},"type":"any","value":"929436d2-4923-4ebd-8dfa-d73f71df023f","key":"transaction"}]}},"response":[{"id":"73bc96ba-c5c0-4498-a512-46def8c4f5de","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/transaction/:customer/:transaction/","host":[""],"path":["transaction",":customer",":transaction",""],"variable":[{"key":"customer","value":"c72bb66d-088b-402f-b8d3-11688b12805c","description":"Customer the Transaction belongs to"},{"key":"transaction","value":"929436d2-4923-4ebd-8dfa-d73f71df023f","description":"ID of the Transaction to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Jan 2021 12:47:42 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"473"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"929436d2-4923-4ebd-8dfa-d73f71df023f\",\n    \"customer\": \"c72bb66d-088b-402f-b8d3-11688b12805c\",\n    \"amount\": \"399.12\",\n    \"currency\": \"USD\",\n    \"ref\": \"1220-45\",\n    \"date_paid\": \"2021-01-10\",\n    \"prepayment\": false,\n    \"overpayment\": false,\n    \"extra_data\": {},\n    \"source\": \"kolleno_api\",\n    \"date_modified\": \"2021-01-07T12:46:08.565784Z\",\n    \"date_created\": \"2021-01-07T12:43:21.188100Z\",\n    \"transaction_invoices\": [\n        {\n            \"invoice\": \"20d513ab-94d0-497d-a1d5-4fd0c8d42282\",\n            \"amount\": \"103.28\"\n        }\n    ]\n}"},{"id":"87cc4185-aa95-4f93-95d0-b3ee87066b49","name":"HTTP 403","originalRequest":{"method":"GET","header":[],"url":{"raw":"/transaction/:customer/:transaction/","host":[""],"path":["transaction",":customer",":transaction",""],"variable":[{"key":"customer","value":"4a29d3a7-84b3-45eb-aa43-f3f18195e076","description":"Customer the Transaction belongs to"},{"key":"transaction","value":"929436d2-4923-4ebd-8dfa-d73f71df023f","description":"ID of the Transaction to retrieve"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Jan 2021 12:48:11 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"63"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You do not have permission to perform this action.\"\n}"},{"id":"4e1bb57a-8ef3-47fd-9195-c4fdc88f2629","name":"HTTP 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"/transaction/:customer/:transaction/","host":[""],"path":["transaction",":customer",":transaction",""],"variable":[{"key":"customer","value":"c72bb66d-088b-402f-b8d3-11688b12805c","description":"Customer the Transaction belongs to"},{"key":"transaction","value":"4a29d3a7-84b3-45eb-aa43-f3f18195e076","description":"ID of the Transaction to retrieve"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Jan 2021 12:47:53 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"23"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"Not found.\"\n}"}],"_postman_id":"71cc246b-88be-498f-8384-59ea18906de9"},{"name":"Create Transaction","id":"773d75b0-5768-43eb-a65f-0a50dbde4a47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"amount\": 250.00,\n    \"currency\": \"USD\",\n    \"transaction_invoices\": [{\"invoice\": \"20d513ab-94d0-497d-a1d5-4fd0c8d42282\", \"amount\": 250.00}],\n    \"ref\": \"1220-45\",\n    \"date_paid\": \"2021-01-10\",\n    \"prepayment\": false,\n    \"overpayment\": false,\n    \"extra_data\": {\"cheque_number\": \"004512\"},\n    \"amount_remaining\": \"0.00\",\n    \"status\": \"paid\"\n}","options":{"raw":{"language":"json"}}},"url":"/transaction/:customer/","description":"<p>Create a Transaction. It will set the field \"source\" to \"kolleno_api\" automatically.</p>\n<p>Info on parameters:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>{\n    \"amount\": 250.00, // string or float\n    \"currency\": \"USD\", // string ISO\n    \"transaction_invoices\": [\n        {\"invoice\": \"20d513ab-94d0-497d-a1d5-4fd0c8d42282\", \"amount\": 250.00}\n    ],  // list of \"invoices\" (UUID) and \"amount\" assigned to that invoice (string or float)\n    \"ref\": \"1220-45\", // string (255 characters), the reference for this Transaction\n    \"date_paid\": \"2021-01-10\", // string YYYY-MM-DD (can be null)\n    \"prepayment\": false,\n    \"overpayment\": false,\n    \"extra_data\": {\"cheque_number\": \"004512\"}, // JSON dictionary (key-value pairs), optional, defaults to {}\n    \"amount_remaining\": \"0.00\", // only if prepayment or overpayment, amount that can still be credited\n    \"status\": \"paid\" // \"paid\" or \"voided\"\n}\n\n</code></pre>","urlObject":{"path":["transaction",":customer",""],"host":[""],"query":[],"variable":[{"description":{"content":"<p>Customer the Transactions belong to</p>\n","type":"text/plain"},"type":"any","value":"c72bb66d-088b-402f-b8d3-11688b12805c","key":"customer"}]}},"response":[{"id":"315c59fc-0cec-49a2-b8b8-69f0875a44e5","name":"HTTP 201","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"amount\": 250.00,\n    \"currency\": \"USD\",\n    \"transaction_invoices\": [{\"invoice\": \"20d513ab-94d0-497d-a1d5-4fd0c8d42282\", \"amount\": 250.00}],\n    \"ref\": \"1220-45\",\n    \"date_paid\": \"2021-01-10\",\n    \"prepayment\": false,\n    \"overpayment\": false,\n    \"extra_data\": {\"cheque_number\": \"004512\"}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/transaction/:customer/","host":[""],"path":["transaction",":customer",""],"variable":[{"key":"customer","value":"c72bb66d-088b-402f-b8d3-11688b12805c","description":"Customer the Transactions belong to"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Jan 2021 12:42:48 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"473"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"22f2f68c-b586-4246-a50e-e8f1b712416f\",\n    \"customer\": \"c72bb66d-088b-402f-b8d3-11688b12805c\",\n    \"amount\": \"250.00\",\n    \"currency\": \"USD\",\n    \"ref\": \"1220-45\",\n    \"date_paid\": \"2021-01-10\",\n    \"prepayment\": false,\n    \"overpayment\": false,\n    \"amount_remaining\": \"0.00\", \n    \"status\": \"paid\",\n    \"extra_data\": {\"cheque_number\": \"004512\"},\n    \"source\": \"kolleno_api\",\n    \"date_modified\": \"2021-01-07T12:42:48.212485Z\",\n    \"date_created\": \"2021-01-07T12:42:48.212506Z\",\n    \"transaction_invoices\": [\n        {\n            \"invoice\": \"20d513ab-94d0-497d-a1d5-4fd0c8d42282\",\n            \"amount\": \"250.00\"\n        }\n    ]\n}"},{"id":"ec22f943-ef77-4907-b840-507684fcb97d","name":"HTTP 403","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"amount\": 399.12,\n    \"currency\": \"0d8b8bae-a6d8-4693-b12d-3e6be73d7965\",\n    \"transaction_invoices\": [{\"invoice\": \"20d513ab-94d0-497d-a1d5-4fd0c8d42282\", \"amount\": 103.28}],\n    \"ref\": \"1220-45\",\n    \"date_paid\": \"2021-01-10\",\n    \"prepayment\": false,\n    \"overpayment\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/transaction/:customer/","host":[""],"path":["transaction",":customer",""],"variable":[{"key":"customer","value":"4a29d3a7-84b3-45eb-aa43-f3f18195e076","description":"Customer the Transactions belong to"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Jan 2021 12:43:09 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"63"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You do not have permission to perform this action.\"\n}"}],"_postman_id":"773d75b0-5768-43eb-a65f-0a50dbde4a47"},{"name":"Update Transaction","id":"3937f064-cea3-4c2e-bb15-a920347c7a26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n    \"amount\": 399.12,\n    \"currency\": \"USD\",\n    \"transaction_invoices\": [{\"invoice\": \"20d513ab-94d0-497d-a1d5-4fd0c8d42282\", \"amount\": 103.28}],\n    \"ref\": \"1220-45\",\n    \"date_paid\": \"2021-01-10\",\n    \"prepayment\": false,\n    \"overpayment\": false,\n    \"extra_data\": {},\n    \"amount_remaining\": \"0.00\",\n    \"status\": \"paid\" \n}","options":{"raw":{"language":"json"}}},"url":"/transaction/:customer/:transaction/","description":"<p>Update details about a specific Transaction. You can only edit Transactions if \"source\" equals to: [\"manual\", \"kolleno_api\", \"csv\"]. On Transactions with \"source\" \"csv\", \"extra_data\" cannot be updated through the API: it comes from the CSV files, and the next import would overwrite it.</p>\n","urlObject":{"path":["transaction",":customer",":transaction",""],"host":[""],"query":[],"variable":[{"description":{"content":"<p>Customer the Transaction belongs to</p>\n","type":"text/plain"},"type":"any","value":"c72bb66d-088b-402f-b8d3-11688b12805c","key":"customer"},{"description":{"content":"<p>ID of the Transaction to update</p>\n","type":"text/plain"},"type":"any","value":"929436d2-4923-4ebd-8dfa-d73f71df023f","key":"transaction"}]}},"response":[{"id":"e637d6da-c4a6-442e-a4f5-5d8ae751c199","name":"HTTP 200","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n    \"amount\": 399.12,\n    \"currency\": \"0d8b8bae-a6d8-4693-b12d-3e6be73d7965\",\n    \"transaction_invoices\": [{\"invoice\": \"20d513ab-94d0-497d-a1d5-4fd0c8d42282\", \"amount\": 103.28}],\n    \"ref\": \"1220-45\",\n    \"date_paid\": \"2021-01-10\",\n    \"prepayment\": false,\n    \"overpayment\": false,\n    \"amount_remaining\": \"0.00\", // only if prepayment or overpayment, amount that can still be credited\n    \"status\": \"paid\" // \"paid\" or \"voided\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/transaction/:customer/:transaction/","host":[""],"path":["transaction",":customer",":transaction",""],"variable":[{"key":"customer","value":"c72bb66d-088b-402f-b8d3-11688b12805c","description":"Customer the Transaction belongs to"},{"key":"transaction","value":"929436d2-4923-4ebd-8dfa-d73f71df023f","description":"ID of the Transaction to update"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Jan 2021 12:44:55 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"473"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"id\": \"929436d2-4923-4ebd-8dfa-d73f71df023f\",\n    \"customer\": \"c72bb66d-088b-402f-b8d3-11688b12805c\",\n    \"amount\": \"399.12\",\n    \"currency\": \"USD\",\n    \"ref\": \"1220-45\",\n    \"date_paid\": \"2021-01-10\",\n    \"transaction_invoices\": [\n        {\n            \"invoice\": \"20d513ab-94d0-497d-a1d5-4fd0c8d42282\",\n            \"amount\": \"103.28\"\n        }\n    ],\n    \"prepayment\": false,\n    \"overpayment\": false,\n    \"extra_data\": {},\n    \"amount_remaining\": \"0.00\", \n    \"status\": \"paid\",\n    \"source\": \"kolleno_api\",\n    \"date_modified\": \"2021-01-07T12:44:55.483219Z\",\n    \"date_created\": \"2021-01-07T12:43:21.188100Z\"\n}"},{"id":"1d220662-0aeb-4c9b-9d34-74f7bc10c868","name":"HTTP 403","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n    \"amount\": 399.12,\n    \"currency\": \"0d8b8bae-a6d8-4693-b12d-3e6be73d7965\",\n    \"transaction_invoices\": [{\"invoice\": \"20d513ab-94d0-497d-a1d5-4fd0c8d42282\", \"amount\": 103.28}],\n    \"ref\": \"1220-45\",\n    \"date_paid\": \"2021-01-10\",\n    \"prepayment\": false,\n    \"overpayment\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/transaction/:customer/:transaction/","host":[""],"path":["transaction",":customer",":transaction",""],"variable":[{"key":"customer","value":"4a29d3a7-84b3-45eb-aa43-f3f18195e076","description":"Customer the Transaction belongs to"},{"key":"transaction","value":"929436d2-4923-4ebd-8dfa-d73f71df023f","description":"ID of the Transaction to update"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Jan 2021 12:45:57 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"63"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You do not have permission to perform this action.\"\n}"},{"id":"46e15089-ba90-4af0-9c84-a87be9bed449","name":"HTTP 404","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n    \"amount\": 399.12,\n    \"currency\": \"0d8b8bae-a6d8-4693-b12d-3e6be73d7965\",\n    \"transaction_invoices\": [{\"invoice\": \"20d513ab-94d0-497d-a1d5-4fd0c8d42282\", \"amount\": 103.28}],\n    \"ref\": \"1220-45\",\n    \"date_paid\": \"2021-01-10\",\n    \"prepayment\": false,\n    \"overpayment\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/transaction/:customer/:transaction/","host":[""],"path":["transaction",":customer",":transaction",""],"variable":[{"key":"customer","value":"c72bb66d-088b-402f-b8d3-11688b12805c","description":"Customer the Transaction belongs to"},{"key":"transaction","value":"4a29d3a7-84b3-45eb-aa43-f3f18195e076","description":"ID of the Transaction to update"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Jan 2021 12:45:36 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"23"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"Not found.\"\n}"}],"_postman_id":"3937f064-cea3-4c2e-bb15-a920347c7a26"},{"name":"Delete Transaction","id":"203c8949-253c-4e98-a897-74386b791380","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"/transaction/:customer/:transaction/","description":"<p>Permanently delete a specific Transaction. You can only delete Transactions if \"source\" equals to: [\"manual\", \"kolleno_api\", \"csv\"]</p>\n","urlObject":{"path":["transaction",":customer",":transaction",""],"host":[""],"query":[],"variable":[{"id":"afb274cd-3622-40e1-b982-64d041cbcc69","description":{"content":"<p>Customer the Transactions belong to</p>\n","type":"text/plain"},"type":"any","value":"c72bb66d-088b-402f-b8d3-11688b12805c","key":"customer"},{"id":"21e601b7-7a7b-4313-9c3f-0490c89435be","description":{"content":"<p>ID of the Transaction to delete</p>\n","type":"text/plain"},"type":"any","value":"929436d2-4923-4ebd-8dfa-d73f71df023f","key":"transaction"}]}},"response":[{"id":"c5e8e00b-bb53-436f-afbf-d01bebc60d5b","name":"HTTP 204","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/transaction/:customer/:transaction/","host":[""],"path":["transaction",":customer",":transaction",""],"variable":[{"key":"customer","value":"c72bb66d-088b-402f-b8d3-11688b12805c","description":"Customer the Transactions belong to"},{"key":"transaction","value":"929436d2-4923-4ebd-8dfa-d73f71df023f","description":"ID of the Transaction to delete"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Thu, 07 Jan 2021 12:49:06 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"0"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":""},{"id":"f94aa1be-4391-4ee3-b4c2-1fd0fb268b2c","name":"HTTP 404","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/transaction/:customer/:transaction/","host":[""],"path":["transaction",":customer",":transaction",""],"variable":[{"key":"customer","value":"c72bb66d-088b-402f-b8d3-11688b12805c","description":"Customer the Transactions belong to"},{"key":"transaction","value":"929436d2-4923-4ebd-8dfa-d73f71df023f","description":"ID of the Transaction to delete"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Jan 2021 12:49:22 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.7"},{"key":"Content-Type","value":"application/json"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Length","value":"23"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"Not found.\"\n}"}],"_postman_id":"203c8949-253c-4e98-a897-74386b791380"}],"id":"25f6f930-ccb9-4b18-8f53-4977239c28e6","description":"<p>The Transactions (equivalent to payments in other systems) belong to a Customer but have Invoices related to them.</p>\n<p>Example of an object:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>{\n    \"id\": \"05d5a320-bbb3-4250-b81c-984079dedb7f\",\n    \"customer\": \"c72bb66d-088b-402f-b8d3-11688b12805c\",\n    \"amount\": \"250.00\",\n    \"currency\": \"USD\",\n    \"ref\": \"1220-45\",\n    \"date_paid\": \"2020-11-01\",\n    \"prepayment\": false,\n    \"overpayment\": false,\n    \"amount_remaining\": \"0.00\",\n    \"status\": \"paid\",\n    \"extra_data\": {\"cheque_number\": \"004512\", \"batch_id\": \"B-2026-09\"}, // JSON dictionary (key-value pairs); for CSV imports, holds every column outside the standard ones\n    \"source\": \"kolleno_api\",\n    \"date_modified\": \"2020-11-24T12:53:55.687545Z\",\n    \"date_created\": \"2020-11-24T12:53:55.687564Z\",\n    \"transaction_invoices\": [\n        {\n            \"invoice\": \"20d513ab-94d0-497d-a1d5-4fd0c8d42282\",\n            \"amount\": \"200.00\" // amount of the Transaction that was assigned to this Invoice\n        },\n        {\n            \"invoice\": \"4a29d3a7-84b3-45eb-aa43-f3f18195e076\",\n            \"amount\": \"50.00\" // amount of the Transaction that was assigned to this Invoice\n        }\n    ]\n}\n\n</code></pre>","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"17628851-8779-468e-a549-a0d974d50534"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"7092a48d-da3a-4ef5-b646-0908e6d0d444"}}],"_postman_id":"25f6f930-ccb9-4b18-8f53-4977239c28e6"},{"name":"Workflow","item":[{"name":"List Workflows","id":"692e56c2-8e66-422b-b81c-a75331e30c79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/workflow/:company/","description":"<p>Retrieve the Workflows in a given Company. Ordered by \"name\".</p>\n<p>Use it to get the name of the \"workflow\" of an email sent (see <strong>Email Sent</strong>).</p>\n","urlObject":{"path":["workflow",":company",""],"host":[""],"query":[{"disabled":true,"description":{"content":"<p>(optional) The limit indicates the maximum number of items to return, and is equivalent to the page_size in other styles.</p>\n","type":"text/plain"},"key":"limit","value":"5"},{"disabled":true,"description":{"content":"<p>(optional) The offset indicates the starting position of the query in relation to the complete set of unpaginated items.</p>\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"<p>(optional) Filter to get only the active (true) or inactive (false) Workflows</p>\n","type":"text/plain"},"key":"is_active","value":"true"}],"variable":[{"id":"ef5ee692-27d9-47b9-8b35-eb77f418f92e","type":"any","value":"7017d236-cc07-44bc-bb86-8d0cd4335112","key":"company"}]}},"response":[{"id":"ce4d9b16-1df8-463f-bd7e-cdfcd65e5272","name":"HTTP 403","originalRequest":{"method":"GET","header":[],"url":{"raw":"/workflow/:company/","host":[""],"path":["workflow",":company",""],"variable":[{"key":"company","value":"6805ead8-9a89-47a0-8144-83ab6975279b","description":"A company you don't have access to"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"detail\": \"You do not have permission to perform this action.\"\n}"},{"id":"bcf72e73-0774-4706-8357-5c349b10674a","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/workflow/:company/","host":[""],"path":["workflow",":company",""],"variable":[{"key":"company","value":"7017d236-cc07-44bc-bb86-8d0cd4335112"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"value":"application/json","key":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n    \"count\": 2,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": \"e2a7c9d1-4f3b-4a8e-9c6d-1b5f7a3e2d48\",\n            \"name\": \"Overdue chasing\",\n            \"level\": \"invoice_level\",\n            \"is_active\": true\n        },\n        {\n            \"id\": \"b5d1f8e3-2a6c-4b97-8e40-3c9a7d1f6b25\",\n            \"name\": \"Statement every month\",\n            \"level\": \"customer_level\",\n            \"is_active\": false\n        }\n    ]\n}"}],"_postman_id":"692e56c2-8e66-422b-b81c-a75331e30c79"}],"id":"1ba1a6ce-d4ee-5681-c01d-f7d80c4b79ac","description":"<p>Workflows are the automations that contact your Customers and update their records. Use them to get the name of the \"workflow\" of an email sent (see <strong>Email Sent</strong>).</p>\n<p>The \"level\" is the type of record the Workflow runs on. The possible \"level\" are:</p>\n<p>call_level, credit_note_level, custom_record_level, customer_group_level, customer_level, email_received_level, email_sent_level, file_upload_level, invoice_level, note_level, payment_charge_level, payment_plan_level, person_level, text_message_sent_level, transaction_level</p>\n<p>Deleted Workflows are not returned, so the \"workflow\" of an older email sent can be missing from the list.</p>\n<p>Example of an object:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>{\n    \"id\": \"e2a7c9d1-4f3b-4a8e-9c6d-1b5f7a3e2d48\",\n    \"name\": \"Overdue chasing\",\n    \"level\": \"invoice_level\",\n    \"is_active\": true\n}\n</code></pre>","_postman_id":"1ba1a6ce-d4ee-5681-c01d-f7d80c4b79ac"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["var Header = require('postman-collection').Header","pm.request.headers.add(new Header(\"Authorization: API \" + pm.environment.get('client_id') + \":\" + pm.environment.get('client_secret')))"],"id":"29d0ffb5-2659-4299-82e3-92e8145e37ac"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"6eb807f6-2790-443b-916a-275471141fa6"}}],"variable":[{"key":"domain_name","value":"","type":"default"}]}