{ "opencollection": "1.0.0", "info": { "name": "Basware OAUTH2 authentication APIs AccountingDocuments Contracts API", "version": "1.0.0" }, "items": [ { "info": { "name": "Contracts", "type": "folder" }, "items": [ { "info": { "name": "Returns contract entities", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/contracts", "headers": [ { "name": "x-amz-meta-continuationtoken", "value": "20577767-3fd9-4dda-9667-a7d7ee00ac95" } ], "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "A limit for the number of items to be returned for one request. Limit can range between 1 and 500 items." }, { "name": "companyCode", "value": "", "type": "query", "description": "Company filter. Returns items for specific company." }, { "name": "lastUpdated", "value": "", "type": "query", "description": "Date Filter. Returns items that have been updated after specified date." } ] }, "docs": "Returns contract entities" }, { "info": { "name": "Creates new contract entity, overwrites previous if exists.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/contracts", "headers": [ { "name": "Content-Type", "value": "application/json" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Notes: \r\n1. The supplier and company code used need to exist in P2P. \r\n2. P2P needs to know the exchange rate from contract currency to company currency (if there are different)." }, { "info": { "name": "Deletes data from Basware API. For manual one-time operations.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/contracts", "body": { "type": "json", "data": "{}" } }, "docs": "For manual one-time operations only, such as a manual clean-up to remove test data generated during API integration development. Only removes records from API layer. \r\nDeletion in target systems needs to be done separately using the data deletion mechanisms available in each of the target system in addition to deleting the data in Basware API." }, { "info": { "name": "Returns single contract entity by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/contracts/:externalCode", "params": [ { "name": "externalCode", "value": "", "type": "path", "description": "The ExternalCode of the contract to be fetched" } ] }, "docs": "Returns single contract entity by ID" }, { "info": { "name": "Updates contract entity. To do a partial update consumer needs to provide changed properties.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/contracts/:externalCode", "params": [ { "name": "externalCode", "value": "", "type": "path", "description": "The ExternalCode of the contract to be updated" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Note: Contract currency can no longer be changed if spend has been collected for the contract." } ] } ], "bundled": true }