The COMMITLY API uses OAuth 2.0 for authentication.
\nhttps://app.commitly.com/api
\nA client application needs to be identified by Client ID and Client Secret. You can retrieve the required Client ID and Client Secret by activating the COMMITLY API within your COMMITLY Account. Note: API Credentials can be created for Business Edition upwards.
\nGo to your COMMITLY Account. In the main navigation select ADD-ONS > COMMITLY Direct API and click on connect. This will generate the client ID and client secret.
\n![](\"https://lh6.googleusercontent.com/timbhKOuzsSDbOTgpdjnJrlnNhoB0ZIOis8YXB1Mnr6FPTHTLrpEHeUzl5EYZmRSQnDgXwHKypk1fPY6MN3mAmAIHUI4GLS4HN43u4ifB6YIUK9StGxHJ95Q_INB5VsWuQmifJDT\")
\n\nThe client’s app authenticates with COMMITLY backend using its Client ID and Client Secret (/auth/token/ endpoint). Send client credentials in body.
\nCOMMITLY backend validates the Client ID and Client Secret.
\nCOMMITLY backend responds with an Access Token.
\nThe client’s application can use the Access Token to call an API on behalf of itself.
\nThe API responds with the requested data.
\nThe Access Token is used to authenticate against the API resources. It needs to be included in every request header with the prefix bearer.
\nhttps://app.commitly.com/api/auth/token/
\nIn our test setup, we have setup Authorization on COMMITLY (API) level.
\nSelect OAuth 2.0 as Type
\nAdd auth data to: Request Headers
\nEnable auto-refresh Token
\nTo configure the New Token
\nSet Access Token URL to /auth/token/
\nInsert Client ID and Client Secret
\nClient Authentication: Send client credentials in body
\nImportant: for security reason (and out of convenience) define variables in an Environment. Select the variable type SECRET for Client ID and Client Secret.
\non Entity Level, select Authorization Type to Inherit auth from parent
\nTo start making calls, initiate Authorization first on parent level by clicking on Get New Access Token
\nSuccessful authentication will be displayed. Click on Proceed.
\nCOMMITLY backend sent in this case an access token. Click on Use Token.
\nAfter that, you can now make API calls.
\nIf you want to call different companies and/or groups, simply setup an Environment for every company / group with the provided client credentials.
\nPagination is the process of dividing the resulting set of data into discrete blocks of information (pages). It decreases both the server payload and the network traffic and increases the speed of page loading.
\nThe number of returned records in GET requests is restricted to avoid server and network overloading. COMMITLY API responses limits the number of records to 100.
200 - OK
\n400 - Bad request
\n401 - Not authenticated or invalid access_token
\n403 - Incorrect authorization role or you are not allowed to call this service for other reasons
\n404 - Not found
\n500 - An unexpected error occurred
\nGet a list of the categories of your company in COMMITLY
\nImportant fields
\n\"is_obsolete\": false
\ndefines whether a categories is active or archived. In this case (false) it is active
\n\"is_category\": true
\ndefines whether a category is a category where budgets (and transactions) can be mapped to. In this case (true) is a category, you can create a budget for
\n\"is_default\": false
\nmarks system and unmappable categories; do not use this for creating budgets
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"Get the created Plans (by name) of your company
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"Get a list of bank connected to all companies within the group. Includes online and offline accounts.
\n","_postman_id":"8a2edfa8-c5de-4881-9d95-7db45b8b7b3b","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"Get a list of bank connected to all companies within the group. Includes online and offline accounts.
\n","_postman_id":"dd043ce7-7ec4-4d7c-883d-849677e8e803","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"Get invoices list and data. Only the authorized user can get this data, i.e. his access_token must be used. This service returns the list of invoices.
\nTo get some specific invoice, you must pass request header with the reference id directly in URL. To get a list of all invoices you must pass the request without the reference.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"String. Search parameter returns result of search by invoice reference ID, invoice name and invoice description
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"Boolean (false, true)
\n","type":"text/plain"},"key":"paid","value":""},{"disabled":true,"description":{"content":"String. Invoice type: Payable, Receivable
\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"String. Invoice status: OVERDUE = 'OD';\nEXPECTED = 'PL';\nORDER/LEAD = 'OR';\nPAID = 'PD';\nPARTIALLY_PAID = 'PP';\nON_HOLD = 'HD';\nPROMISED = 'PR';\nIN_DISPUTE = 'DP';\nCANCELLED = 'CA';
\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"Date (YYYY-MM-DD)
\n","type":"text/plain"},"key":"min_due_date ","value":""},{"disabled":true,"description":{"content":"Date (YYYY-MM-DD)
\n","type":"text/plain"},"key":"max_due_date","value":""},{"disabled":true,"description":{"content":"Decimal
\n","type":"text/plain"},"key":"min_amount","value":""},{"disabled":true,"description":{"content":"Decimal
\n","type":"text/plain"},"key":"max_amount","value":""},{"disabled":true,"description":{"content":"Parameter (due_date)
\n","type":"text/plain"},"key":"ordering","value":""},{"disabled":true,"description":{"content":"Serial (1, 2, 3, ...)
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"Decimal (20, 50, 100)
\n","type":"text/plain"},"key":"page_size","value":""},{"disabled":true,"description":{"content":"Boolean (false, true)
\n","type":"text/plain"},"key":"is_payment","value":""}],"variable":[]}},"response":[{"id":"ae038127-89c2-41bd-b299-b3aea5510e56","name":"Get all invoices of a specific company","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://app.commitly.com/api/invoices/","host":["https://app.commitly.com/api"],"path":["invoices",""],"query":[{"key":"search","value":"","description":"String. Search parameter returns result of search by invoice reference ID, invoice name and invoice description ","disabled":true},{"key":"paid","value":"","description":"Boolean (false, true) ","disabled":true},{"key":"type","value":"","description":"String. Invoice type: Payable, Receivable ","disabled":true},{"key":"status","value":"","description":"String. Invoice status: CA (cancelled), PD (paid), PL (planned), OD (overdue), PP (partial paid), HD (on hold), PR (promised), DP (in dispute) ","disabled":true},{"key":"min_due_date ","value":"","description":"Date (YYYY-MM-DD)","disabled":true},{"key":"max_due_date","value":"","description":"Date (YYYY-MM-DD)","disabled":true},{"key":"min_amount","value":"","description":"Decimal ","disabled":true},{"key":"max_amount","value":"","description":"Decimal","disabled":true},{"key":"ordering","value":"","description":"Parameter (due_date)","disabled":true},{"key":"page","value":null,"description":"Serial (1, 2, 3, ...)","disabled":true},{"key":"page_size","value":null,"description":"Decimal (20, 50, 100)","disabled":true},{"key":"is_payment","value":null,"description":"Boolean (false, true)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Sat, 16 Apr 2022 10:13:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1016"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Accept-Language, Origin"},{"key":"Allow","value":"GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"sum\": 8650,\n \"next\": null,\n \"previous\": null,\n \"results\": {\n \"amount_due\": 7650,\n \"total\": 8650,\n \"invoices\": [\n {\n \"id\": 30221,\n \"transaction\": null,\n \"transactions\": [],\n \"paid_amount\": 1000,\n \"amount_due\": 200,\n \"date_created\": \"2022-04-16T09:36:37.718400Z\",\n \"date_updated\": \"2022-04-16T10:12:17.687693Z\",\n \"name\": \"First invoice\",\n \"notes\": \"\",\n \"amount\": 1200,\n \"type\": \"RE\",\n \"reference\": \"1\",\n \"date\": \"2022-04-16\",\n \"due_date\": \"2022-04-30\",\n \"source\": \"Manually Added\",\n \"source_id\": \"d28e08d1-a088-3429-8c8d-1a15a8dd304e\",\n \"status\": \"PP\",\n \"is_archived\": false,\n \"category\": 88314,\n \"comment_count\": 0\n },\n {\n \"id\": 30223,\n \"transaction\": null,\n \"transactions\": [],\n \"paid_amount\": 0,\n \"amount_due\": 7450,\n \"date_created\": \"2022-04-16T09:53:03.919398Z\",\n \"date_updated\": \"2022-04-16T09:53:03.919422Z\",\n \"name\": \"Bond\",\n \"notes\": \"special equipement\",\n \"amount\": 7450,\n \"type\": \"RE\",\n \"reference\": \"AR-007\",\n \"date\": \"2022-04-16\",\n \"due_date\": \"2022-04-28\",\n \"source\": \"direct_api\",\n \"source_id\": \"17acf4f8-c07b-3c06-a07a-56bb50cb2cf3\",\n \"status\": \"PL\",\n \"is_archived\": false,\n \"category\": 88314,\n \"comment_count\": 0\n }\n ]\n }\n}"},{"id":"5c2206f2-285e-4fa4-9db1-e3d52feeeace","name":"Get all unpaid company invoices, sorted by due date","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://app.commitly.com/api/invoices/?paid=false&ordering=due_date&page=1&page_size=20&is_payment=true","host":["https://app.commitly.com/api"],"path":["invoices",""],"query":[{"key":"search","value":"","description":"String. Search parameter returns result of search by invoice reference ID, invoice name and invoice description ","disabled":true},{"key":"paid","value":"false","description":"Boolean (false, true) "},{"key":"type","value":"","description":"String. Invoice type: Payable, Receivable ","disabled":true},{"key":"status","value":"","description":"String. Invoice status: CA (cancelled), PD (paid), PL (planned), OD (overdue), PP (partial paid), HD (on hold), PR (promised), DP (in dispute) ","disabled":true},{"key":"min_due_date ","value":"","description":"Date (YYYY-MM-DD)","disabled":true},{"key":"max_due_date","value":"","description":"Date (YYYY-MM-DD)","disabled":true},{"key":"min_amount","value":"","description":"Decimal ","disabled":true},{"key":"max_amount","value":"","description":"Decimal","disabled":true},{"key":"ordering","value":"due_date","description":"Parameter (due_date)"},{"key":"page","value":"1","description":"Serial (1, 2, 3, ...)"},{"key":"page_size","value":"20","description":"Decimal (20, 50, 100)"},{"key":"is_payment","value":"true","description":"Boolean (false, true)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"sum\": 8650,\n \"next\": null,\n \"previous\": null,\n \"results\": {\n \"amount_due\": 7650,\n \"total\": 8650,\n \"invoices\": [\n {\n \"id\": 30221,\n \"transaction\": null,\n \"transactions\": [],\n \"paid_amount\": 1000,\n \"amount_due\": 200,\n \"date_created\": \"2022-04-16T09:36:37.718400Z\",\n \"date_updated\": \"2022-04-16T10:12:17.687693Z\",\n \"name\": \"First invoice\",\n \"notes\": \"\",\n \"amount\": 1200,\n \"type\": \"RE\",\n \"reference\": \"1\",\n \"date\": \"2022-04-16\",\n \"due_date\": \"2022-04-30\",\n \"source\": \"Manually Added\",\n \"source_id\": \"d28e08d1-a088-3429-8c8d-1a15a8dd304e\",\n \"status\": \"PP\",\n \"is_archived\": false,\n \"category\": 88314,\n \"comment_count\": 0\n },\n {\n \"id\": 30223,\n \"transaction\": null,\n \"transactions\": [],\n \"paid_amount\": 0,\n \"amount_due\": 7450,\n \"date_created\": \"2022-04-16T09:53:03.919398Z\",\n \"date_updated\": \"2022-04-16T09:53:03.919422Z\",\n \"name\": \"Bond\",\n \"notes\": \"special equipement\",\n \"amount\": 7450,\n \"type\": \"RE\",\n \"reference\": \"AR-007\",\n \"date\": \"2022-04-16\",\n \"due_date\": \"2022-04-28\",\n \"source\": \"direct_api\",\n \"source_id\": \"17acf4f8-c07b-3c06-a07a-56bb50cb2cf3\",\n \"status\": \"PL\",\n \"is_archived\": false,\n \"category\": 88314,\n \"comment_count\": 0\n }\n ]\n }\n}"}],"_postman_id":"69313015-235e-48e7-8644-a7a22e3f2459"},{"name":"Create company invoices","id":"2d74a70f-4e95-4645-a7b2-ed83eeadace7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reference\": \"Create an invoice within COMMITLY. To create an invoice, you must pass authorization and the required fields in your POST request. Only the authorized user can get this data, i.e. his access_token must be used.
\nRequired fields:
\n\"reference\" // Invoice Number
\n\"name\"
\n\"amount\" // Invoice amount
\n\"due_date\" // Specify \"due_date\" as YYYY-MM-DD, e.g. 2021-11-10
\nOptional fields:
\n\"date\" // Invoice date, specify \"date\" as YYYY-MM-DD, e.g. 2021-11-10
\n\"notes\" // description of invoice
\n\"tags\" // use tags field to pass additional information for mapping rules, e.g. category
\n\"paid_amount\" // already paid amount of invoice, will be deducted from \"amount\"
\n\"category\" // Category Id as can be retried by GET categories call
\n\"expected_date\" // specify the expected payment date if other than the due date.
Note: if no expected date is provided, system will set expected date to either due date or current date, if due date lies in the past
Update an invoice within COMMITLY. To update an invoice, you must pass authorization and the reference of the invoice in your PATCH request, where reference is the original reference (source ID) you passed with the POST request. Only the authorized user can get this data, i.e. his access_token must be used.
\nCOMMITLY expects a list of invoices to update.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"Delete an invoice within COMMITLY. To delete an invoice, you must pass authorization and pass the following request with the reference id directly in URL.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"Invoices or Open Items represent entities in COMMITLY that will be considered in the Accounts Receivables / Accounts Payables (AR/AP) section of planning.
\n","_postman_id":"6059464b-b819-4617-8c1c-adb5a6fdc63b","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"Create budgets in a selected plan
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"Create budgets in a selected plan
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"ATTENTION:
\nPlease note that FE validations are not applicable to direct API, so you can edit/delete budgets, which are not available via UI (e.g., delete budget from committed plan, delete budget from past periods, delete budget from the middle of recurring budget, etc.)
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"Create and update budgets in a selected plan.
\n","_postman_id":"8a7068e0-4cb7-44e2-8de6-fc707997339b","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"ATTENTION:
\nPlease note that FE validations are not applicable to direct API, so you can edit/delete budgets, which are not available via UI (e.g., delete budget from committed plan, delete budget from past periods, delete budget from the middle of recurring budget, etc.)
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"Create and update budgets in a selected scenario.
\n","_postman_id":"a7b8d8b0-a2a6-49fa-a75c-34432f3cabc1","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"ATTENTION:
\nPlease note that FE validations are not applicable to direct API, so you can edit/delete budgets, which are not available via UI (e.g., delete budget from committed plan, delete budget from past periods, delete budget from the middle of recurring budget, etc.)
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"Create budgets directly in forecast. As forecast is the essential part in COMMITLY use with caution and care.
\n","_postman_id":"60ae2063-b5ee-4b93-97e7-0c88f2a8a82c","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"The following API calls allow to GET, POST or PATCH (Update) the corresponding entities on company level only.
\n","_postman_id":"2bb40421-a7aa-4b83-aa64-b2b7bd244535","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"Get a list of bank connected to all companies within the group. Includes online and offline accounts.
\n","_postman_id":"7e52a0d7-b7a0-4b99-a68d-2038fe6cb078","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"Get a list of bank accounts connected to all companies within the group.
\n","_postman_id":"a3685a03-1ba4-4e8d-915b-3b7ae77afdfc","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"This request returns invoices list and data for the specified company. Only the authorized user can get this data, i.e. his access_token must be used.
\n","urlObject":{"path":["companies","{{company_id}}","invoices",""],"host":["https://app.commitly.com/api"],"query":[{"disabled":true,"description":{"content":"String. Search parameter returns result of search by invoice reference ID, invoice name and invoice description
\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"Boolean (false, true)
\n","type":"text/plain"},"key":"paid","value":""},{"disabled":true,"description":{"content":"String. Invoice type: Payable, Receivable
\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"String. Invoice status: CA (cancelled), PD (paid), PL (planned), OD (overdue), PP (partial paid), HD (on hold), PR (promised), DP (in dispute)
\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"Date (YYYY-MM-DD)
\n","type":"text/plain"},"key":"min_due_date ","value":""},{"disabled":true,"description":{"content":"Date (YYYY-MM-DD)
\n","type":"text/plain"},"key":"max_due_date","value":""},{"disabled":true,"description":{"content":"Decimal
\n","type":"text/plain"},"key":"min_amount","value":""},{"disabled":true,"description":{"content":"Decimal
\n","type":"text/plain"},"key":"max_amount","value":""},{"disabled":true,"description":{"content":"Parameter (due_date)
\n","type":"text/plain"},"key":"ordering","value":""},{"disabled":true,"description":{"content":"Serial (1, 2, 3, ...)
\n","type":"text/plain"},"key":"page","value":null},{"disabled":true,"description":{"content":"Decimal (20, 50, 100)
\n","type":"text/plain"},"key":"page_size","value":null},{"disabled":true,"description":{"content":"Boolean (false, true)
\n","type":"text/plain"},"key":"is_payment","value":null}],"variable":[]}},"response":[{"id":"96393775-15ed-4e8c-975c-286718bc50cb","name":"Get company invoices (professional edition)","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://app.commitly.com/api/companies/{{company_id}}/invoices/?paid=false&ordering=due_date&page=1&page_size=20&is_payment=true","host":["https://app.commitly.com/api"],"path":["companies","{{company_id}}","invoices",""],"query":[{"key":"search","value":"","description":"String. Search parameter returns result of search by invoice reference ID, invoice name and invoice description ","disabled":true},{"key":"paid","value":"false","description":"Boolean (false, true) "},{"key":"type","value":"","description":"String. Invoice type: Payable, Receivable ","disabled":true},{"key":"status","value":"","description":"String. Invoice status: CA (cancelled), PD (paid), PL (planned), OD (overdue), PP (partial paid), HD (on hold), PR (promised), DP (in dispute) ","disabled":true},{"key":"min_due_date ","value":"","description":"Date (YYYY-MM-DD)","disabled":true},{"key":"max_due_date","value":"","description":"Date (YYYY-MM-DD)","disabled":true},{"key":"min_amount","value":"","description":"Decimal ","disabled":true},{"key":"max_amount","value":"","description":"Decimal","disabled":true},{"key":"ordering","value":"due_date","description":"Parameter (due_date)"},{"key":"page","value":"1","description":"Serial (1, 2, 3, ...)"},{"key":"page_size","value":"20","description":"Decimal (20, 50, 100)"},{"key":"is_payment","value":"true","description":"Boolean (false, true)"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 30223,\n \"transaction\": null,\n \"transactions\": [],\n \"paid_amount\": 0,\n \"amount_due\": 7450,\n \"date_created\": \"2022-04-16T09:53:03.919398Z\",\n \"date_updated\": \"2022-04-16T09:53:03.919422Z\",\n \"name\": \"Bond\",\n \"notes\": \"special equipement\",\n \"amount\": 7450,\n \"type\": \"RE\",\n \"reference\": \"AR-007\",\n \"date\": \"2022-04-16\",\n \"due_date\": \"2022-04-28\",\n \"source\": \"direct_api\",\n \"source_id\": \"17acf4f8-c07b-3c06-a07a-56bb50cb2cf3\",\n \"status\": \"PL\",\n \"is_archived\": false,\n \"category\": 88314\n}"},{"id":"f6abaf58-8bd3-43cf-8042-b250fd1ea765","name":"Get all invoices of a specific company (professional edition)","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://app.commitly.com/api/companies/{{company_id}}/invoices/","host":["https://app.commitly.com/api"],"path":["companies","{{company_id}}","invoices",""],"query":[{"key":"search","value":"","description":"String. Search parameter returns result of search by invoice reference ID, invoice name and invoice description ","disabled":true},{"key":"paid","value":"","description":"Boolean (false, true) ","disabled":true},{"key":"type","value":"","description":"String. Invoice type: Payable, Receivable ","disabled":true},{"key":"status","value":"","description":"String. Invoice status: CA (cancelled), PD (paid), PL (planned), OD (overdue), PP (partial paid), HD (on hold), PR (promised), DP (in dispute) ","disabled":true},{"key":"min_due_date ","value":"","description":"Date (YYYY-MM-DD)","disabled":true},{"key":"max_due_date","value":"","description":"Date (YYYY-MM-DD)","disabled":true},{"key":"min_amount","value":"","description":"Decimal ","disabled":true},{"key":"max_amount","value":"","description":"Decimal","disabled":true},{"key":"ordering","value":"","description":"Parameter (due_date)","disabled":true},{"key":"page","value":null,"description":"Serial (1, 2, 3, ...)","disabled":true},{"key":"page_size","value":null,"description":"Decimal (20, 50, 100)","disabled":true},{"key":"is_payment","value":null,"description":"Boolean (false, true)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Sat, 16 Apr 2022 10:13:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1016"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Accept-Language, Origin"},{"key":"Allow","value":"GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"sum\": 8650,\n \"next\": null,\n \"previous\": null,\n \"results\": {\n \"amount_due\": 7650,\n \"total\": 8650,\n \"invoices\": [\n {\n \"id\": 30221,\n \"transaction\": null,\n \"transactions\": [],\n \"paid_amount\": 1000,\n \"amount_due\": 200,\n \"date_created\": \"2022-04-16T09:36:37.718400Z\",\n \"date_updated\": \"2022-04-16T10:12:17.687693Z\",\n \"name\": \"First invoice\",\n \"notes\": \"\",\n \"amount\": 1200,\n \"type\": \"RE\",\n \"reference\": \"1\",\n \"date\": \"2022-04-16\",\n \"due_date\": \"2022-04-30\",\n \"source\": \"Manually Added\",\n \"source_id\": \"d28e08d1-a088-3429-8c8d-1a15a8dd304e\",\n \"status\": \"PP\",\n \"is_archived\": false,\n \"category\": 88314,\n \"comment_count\": 0\n },\n {\n \"id\": 30223,\n \"transaction\": null,\n \"transactions\": [],\n \"paid_amount\": 0,\n \"amount_due\": 7450,\n \"date_created\": \"2022-04-16T09:53:03.919398Z\",\n \"date_updated\": \"2022-04-16T09:53:03.919422Z\",\n \"name\": \"Bond\",\n \"notes\": \"special equipement\",\n \"amount\": 7450,\n \"type\": \"RE\",\n \"reference\": \"AR-007\",\n \"date\": \"2022-04-16\",\n \"due_date\": \"2022-04-28\",\n \"source\": \"direct_api\",\n \"source_id\": \"17acf4f8-c07b-3c06-a07a-56bb50cb2cf3\",\n \"status\": \"PL\",\n \"is_archived\": false,\n \"category\": 88314,\n \"comment_count\": 0\n }\n ]\n }\n}"}],"_postman_id":"7871c686-b72e-4977-aff8-f882b4da0a24"},{"name":"Create company invoices (professional edition)","id":"be056660-28b4-4ff4-a0cc-44446c1998aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":"Create an invoice within COMMITLY. To create an invoice, you must pass authorization and the following required fields in your POST request. Only the authorized user can get this data, i.e. his access_token must be used.
\nUpdate an invoice within COMMITLY. To update an invoice, you must pass authorization and the reference of the invoice with the prefix ref- in your PATCH request, where reference is the original reference (source ID) you passed with the POST request. Only the authorized user can get this data, i.e. his access_token must be used.
\n","urlObject":{"path":["companies","{{company_id}}","invoices",""],"host":["https://app.commitly.com/api"],"query":[],"variable":[]}},"response":[{"id":"d5cb2fd5-3f52-44c7-b08b-36f5cb2306a5","name":"Update company invoice (professional edition)","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"reference\": \"AR-007\",\r\n \"name\": \"Bond\",\r\n \"notes\": \"special equipement\",\r\n \"type\": \"Delete an invoice within COMMITLY. To delete an invoice, you must pass authorization and pass the following request with the reference id directly in URL. In provided example ref-55555 - is invoice ID.
\n","urlObject":{"path":["companies","{{company_id}}","invoices",""],"host":["https://app.commitly.com/api"],"query":[{"disabled":true,"description":{"content":"A unique integer value identifying the invoice
\n","type":"text/plain"},"key":"reference","value":"reference"}],"variable":[]}},"response":[{"id":"3580671e-942d-4d91-beb9-f1ddb25b32ea","name":"Delete company invoices (professional edition)","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://app.commitly.com/api/companies/{{company_id}}/invoices/?reference=AR-007","host":["https://app.commitly.com/api"],"path":["companies","{{company_id}}","invoices",""],"query":[{"key":"reference","value":"AR-007"}]}},"code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"c5a21a0b-77cd-4eb8-a130-705ce889ff04"}],"id":"5f23a64f-3645-4ac5-ab5f-db5f1802370f","_postman_id":"5f23a64f-3645-4ac5-ab5f-db5f1802370f","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"For users with a Professional Edition subscription, it is possible to work with the Commitly API at the tenant level. Contact support@commitly.com for information on how to obtain your client ID and client secret.
\n","_postman_id":"9ec146e6-a19c-4dcd-9b43-2aa3ef48a192","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":"