openapi: 3.2.0 info: title: Basware APIs for Purchase-to-Pay and Master Data import… description: The Basware APIs documented here are for Purchase-to-Pay use cases and for importing Master Data to Basware services. version: v1 servers: - url: '' security: - Bearer: [] - oauth2authentication: [] tags: - name: Payment Terms paths: /v1/paymentTerms: get: tags: - Payment Terms summary: Returns payment terms posted to Basware API description: '' parameters: - name: pageSize in: query description: A limit for the number of items to be returned for one request. Limit can range between 1 and 500 items. schema: type: integer format: int32 default: 500 - name: companyCode in: query description: Company filter. Returns items for specific company. schema: type: string default: '' - name: lastUpdated in: query description: Date Filter. Returns items that have been updated after specified date. schema: type: string format: date-time - name: x-amz-meta-continuationtoken in: header description: Used to get next page of results when item count indicated by 'pageSize' is exceeded. A token is returned in header (not body) parameter 'X-amz-meta-continuationToken' of the response whenever there are more records to fetch. Post the received value here in a new HEADER parameter on the next GET request to receive the next page of results. When getting the next page of results, you must include the same query parameters that were used when getting the first page. schema: type: string example: 9797a921-ca15-4b40-84e0-11fe94125b47 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PaymentTermResponse' application/json: schema: $ref: '#/components/schemas/PaymentTermResponse' text/json: schema: $ref: '#/components/schemas/PaymentTermResponse' '401': description: Unauthorized '404': description: Not found. Request was successful and no records were found. '500': description: Unexpected error content: text/plain: schema: $ref: '#/components/schemas/ResponseEntityList' application/json: schema: $ref: '#/components/schemas/ResponseEntityList' text/json: schema: $ref: '#/components/schemas/ResponseEntityList' operationId: getV1PaymentTerms x-operation-id-source: derived post: tags: - Payment Terms summary: Creates new paymentTerm entity, fully overwrites previous record if exists description: 'Note: Please post payment term(s) before posting vendor(s) using the payment term(s). Payment term(s) should be in P2P before posting the vendor(s).' parameters: - name: Content-Type in: header description: Specifies the media type of the resource. Value application/json is supported. schema: type: string example: application/json requestBody: content: application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/PaymentTermEntity' application/json: schema: type: array items: $ref: '#/components/schemas/PaymentTermEntity' text/json: schema: type: array items: $ref: '#/components/schemas/PaymentTermEntity' application/*+json: schema: type: array items: $ref: '#/components/schemas/PaymentTermEntity' responses: '200': description: Success content: text/plain: schema: type: array items: $ref: '#/components/schemas/PaymentTermEntity' application/json: schema: type: array items: $ref: '#/components/schemas/PaymentTermEntity' text/json: schema: type: array items: $ref: '#/components/schemas/PaymentTermEntity' '400': description: Bad request content: text/plain: schema: $ref: '#/components/schemas/ResponseEntityList' application/json: schema: $ref: '#/components/schemas/ResponseEntityList' text/json: schema: $ref: '#/components/schemas/ResponseEntityList' '401': description: Unauthorized '409': description: Conflict content: text/plain: schema: $ref: '#/components/schemas/ResponseEntityList' application/json: schema: $ref: '#/components/schemas/ResponseEntityList' text/json: schema: $ref: '#/components/schemas/ResponseEntityList' '500': description: Unexpected error content: text/plain: schema: $ref: '#/components/schemas/ResponseEntityList' application/json: schema: $ref: '#/components/schemas/ResponseEntityList' text/json: schema: $ref: '#/components/schemas/ResponseEntityList' operationId: postV1PaymentTerms x-operation-id-source: derived delete: tags: - Payment Terms summary: Deletes data from Basware API. For manual one-time operations description: '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. Deletion 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.' requestBody: description: "Contains the body of the request.\n Either externalCode or lastUpdated -field is required. If both values are provided, externalCode will have the priority." content: application/json-patch+json: schema: $ref: '#/components/schemas/DeleteRequest' application/json: schema: $ref: '#/components/schemas/DeleteRequest' text/json: schema: $ref: '#/components/schemas/DeleteRequest' application/*+json: schema: $ref: '#/components/schemas/DeleteRequest' responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/DeleteResponse' application/json: schema: $ref: '#/components/schemas/DeleteResponse' text/json: schema: $ref: '#/components/schemas/DeleteResponse' '202': description: RequestAccepted content: text/plain: schema: $ref: '#/components/schemas/DeleteResponse' application/json: schema: $ref: '#/components/schemas/DeleteResponse' text/json: schema: $ref: '#/components/schemas/DeleteResponse' '400': description: BadRequest content: text/plain: schema: $ref: '#/components/schemas/ResponseEntityList' application/json: schema: $ref: '#/components/schemas/ResponseEntityList' text/json: schema: $ref: '#/components/schemas/ResponseEntityList' '401': description: Unauthorized '500': description: Unexpected error content: text/plain: schema: $ref: '#/components/schemas/ResponseEntityList' application/json: schema: $ref: '#/components/schemas/ResponseEntityList' text/json: schema: $ref: '#/components/schemas/ResponseEntityList' operationId: deleteV1PaymentTerms x-operation-id-source: derived /v1/paymentTerms/{externalCode}: get: tags: - Payment Terms summary: Returns single payment term by externalCode -identifier description: '' parameters: - name: externalCode in: path description: The ExternalCode of the entity to be fetched required: true schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PaymentTermEntity' application/json: schema: $ref: '#/components/schemas/PaymentTermEntity' text/json: schema: $ref: '#/components/schemas/PaymentTermEntity' '401': description: Unauthorized '404': description: Not found. Request was successful and no records were found. '500': description: Unexpected error content: text/plain: schema: $ref: '#/components/schemas/ResponseEntityList' application/json: schema: $ref: '#/components/schemas/ResponseEntityList' text/json: schema: $ref: '#/components/schemas/ResponseEntityList' operationId: getV1PaymentTermsByExternalCode x-operation-id-source: derived patch: tags: - Payment Terms summary: Updates on specified payment term. parameters: - name: externalCode in: path description: The ExternalCode of the payment term to be updated. To do a partial update consumer needs to provide changed properties. required: true schema: type: string requestBody: description: Entity to be updated content: application/json-patch+json: schema: $ref: '#/components/schemas/PaymentTermEntity' application/json: schema: $ref: '#/components/schemas/PaymentTermEntity' text/json: schema: $ref: '#/components/schemas/PaymentTermEntity' application/*+json: schema: $ref: '#/components/schemas/PaymentTermEntity' responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/PaymentTermEntity' application/json: schema: $ref: '#/components/schemas/PaymentTermEntity' text/json: schema: $ref: '#/components/schemas/PaymentTermEntity' '400': description: Bad request content: text/plain: schema: $ref: '#/components/schemas/ResponseEntityList' application/json: schema: $ref: '#/components/schemas/ResponseEntityList' text/json: schema: $ref: '#/components/schemas/ResponseEntityList' '401': description: Unauthorized '404': description: Not found. Record to update not found. '500': description: Unexpected error content: text/plain: schema: $ref: '#/components/schemas/ResponseEntityList' application/json: schema: $ref: '#/components/schemas/ResponseEntityList' text/json: schema: $ref: '#/components/schemas/ResponseEntityList' operationId: patchV1PaymentTermsByExternalCode x-operation-id-source: derived components: schemas: LanguageTranslationEntity: required: - language - translation type: object properties: translation: maxLength: 2000 minLength: 2 type: string description: Translated text example: Office supplies language: maxLength: 10 minLength: 2 type: string description: Language code example: en-US additionalProperties: false PaymentTermEntity: required: - companies - externalCode - paymentTermCode - paymentTermNames - validFrom - validTo type: object properties: paymentTermCode: maxLength: 25 minLength: 1 type: string description: Specifies code for the payment term. example: NT60 paymentTermNames: type: array items: $ref: '#/components/schemas/LanguageTranslationEntity' description: Defines name(s) for the payment term. Please always include 'en-US' language tag for Basware global support, as well as any local-language tag being used. If both translations are not available, please use the same string with both language tags. sortOrder: maximum: 2147483647 minimum: 0 type: - integer - 'null' description: Specifies position of a payment term in selection list. format: int32 example: 8 moveDueDatesTo: pattern: 0|1|2 type: - string - 'null' description: "Specifies whether to move due date and cash date to next/previous working day (in case due date occurs during weekend). \n0 = Do not move due date.\n1 = Move to next working day.\n2 = Move to previous working day." example: '0' dueDateCalc: pattern: 0|1 type: - integer - 'null' description: "Specifies due date calculation method. \n1 = Due date is calculated automatically according to rules specified in this payment term. \n0 = Due date is entered manually (no automatic calculation)." format: int32 example: 1 dueDateDays: maximum: 2147483647 minimum: 0 type: - integer - 'null' description: Used in due date calculation. Specifies number of days to be added to the base date. format: int32 example: 60 dueDateDays2: maximum: 2147483647 minimum: 0 type: - integer - 'null' description: Used in due date calculation. Specifies the amount of days to be added after month-end -moves. format: int32 example: 0 dueDateEom: maximum: 2147483647 minimum: 0 type: - integer - 'null' description: "Accepts integer values from 0 to 12 only.\nUsed in due date calculation. Specifies number of month-ends to be added to due date. Month-ends are added after adding dueDateDays to base calculation date.\n0 = Date not moved to end of month.\n1 = Date is moved to end of month\n2 = Date is moved to end of next month \n3 = Date is moved in following way: Add 2 full months, then move date to end of resulting month. \nn = Date is moved in following way: Add (n-1) full months, then move date to end of resulting month." format: int32 example: 0 cashDueDateCalc: pattern: 0|1|2 type: - integer - 'null' description: 'Specifies cash date calculation method. 0 = Cash date is entered manually (no calculation) 1 = Calculate cash date (accorging to rules specified on this payment term) 2 = Calculate dynamic cash date and cash discount (specified in paymentTermDiscountRules -block)' format: int32 example: 2 cashDueDateDays: maximum: 2147483647 minimum: 0 type: - integer - 'null' description: Used in cash date calculation. Specifies number of days to be added to the base date. format: int32 example: 21 cashDueDateDays2: maximum: 2147483647 minimum: 0 type: - integer - 'null' description: Used in cash date calculation. Specifies the amount of days to be added after month-end -moves. format: int32 example: 0 cashDueDateEom: maximum: 2147483647 minimum: 0 type: - integer - 'null' description: "Accepts integer values from 0 to 12 only.\nUsed in cash date calculation. Specifies number of month-ends to be added to cash date. Month-ends are added after adding dueDateDays to base calculation date.\n0 = Date not moved to end of month.\n1 = Date is moved to end of month\n2 = Date is moved to end of next month \n3 = Date is moved in following way: Add 2 full months, then move date to end of resulting month. \nn = Date is moved in following way: Add (n-1) full months, then move date to end of resulting month." format: int32 example: 0 cashDiscount: maximum: 1000000000 minimum: 0 type: - number - 'null' description: Defines the discount percentage. This amount of discount is received if invoice is paid by cash date. format: double example: 1 validFrom: type: string description: Defines the date when the payment term's validity period starts. format: date-time example: '2015-01-01' validTo: type: string description: Defines the date when the payment term's validity period ends. format: date-time example: '2016-01-02' companies: type: array items: $ref: '#/components/schemas/PaymentTermCompanyEntity' description: List of company units to associate paymentterm to P2P organization hierarchy paymentTermDiscountRules: type: - array - 'null' items: $ref: '#/components/schemas/PaymentTermDiscountRule' description: "PaymentTermDiscountRules can be used to specify multiple cash discount dates. Data is imported to \"Calculate cynamic cash date and cash discount\" -section in P2P. \nTo enable cash discount calculation using these rules, 'cashDueDateCalc' must be set to 2. When enabled, overrides the standard cash date calculation -fields cashDiscount, cashDueDateDays and cashDueDateDays2.\nPaymentTermDiscountRules -block is used and mandatory only when 'cashDueDateCalc' is set to 2." externalCode: maxLength: 36 minLength: 1 type: string description: External identifier that is used as a key in API. example: 4847-31231212-212121-1212 lastUpdated: type: string description: Timestamp when the record was last sent to API. Set automatically. format: date-time additionalProperties: false ErrorEntity: type: object properties: externalCode: type: - string - 'null' description: External code of record on which error occurred (when available). example: 4847-31231212-212121-1212 type: enum: - BUSINESS - VALIDATION - TECHNICAL - SECURITY type: string description: Error type. example: '' code: enum: - EXTERNAL_CODE_MISMATCH - SCHEMA_VALIDATION_ERROR - CONFLICT_IN_POST - DATA_ORIGIN_VALIDATION_ERROR - ACCESS_TOKEN_VALIDATION_ERROR - CREDENTIAL_VALIDATION_ERROR - PARAMETER_VALIDATION_ERROR - UNEXPECTED_ERROR - METHOD_NOT_ALLOWED - ENTITY_NOT_FOUND - DATA_VALIDATION_FAILED - SNS_PUBLISH_ERROR - SQS_PUBLISH_ERROR type: string description: Error code. example: '' message: type: - string - 'null' description: Specific error message. example: '' info: type: - string - 'null' description: Information about type of the error. example: '' additionalProperties: false PaymentTermResponse: required: - paymentTerms type: object properties: paymentTerms: type: array items: $ref: '#/components/schemas/PaymentTermEntity' additionalProperties: false DeleteRequest: type: object properties: lastUpdated: type: - string - 'null' description: 'To delete records updated after specific time, use lastUpdated -field. This will delete all items that have been updated after the specified date. In response, user will get the taskStatus api link where the task status can be checked. Note: ''0001-01-01'' can be used to delete all records.' format: date-time externalCode: maxLength: 36 minLength: 0 type: - string - 'null' description: Single item can be deleted using externalCode and final status is returned immediately. additionalProperties: false PaymentTermCompanyEntity: required: - active - companyCode - inherit type: object properties: companyCode: maxLength: 32 minLength: 1 type: string description: The payment term for different suppliers is attached to this company code. example: BW01 inherit: type: boolean description: The value defines whether the payment is inherited to lower organization units in the organization structure. active: type: boolean description: This flag will enable the data to be visible on UI, provided if the value is true, not visible in case of value is false. It will be also used for soft delete. example: true additionalProperties: false DeleteResponse: type: object properties: statusApiLink: type: - string - 'null' taskName: type: - string - 'null' taskStatus: type: - string - 'null' additionalProperties: false PaymentTermDiscountRule: required: - active - externalCode type: object properties: externalCode: maxLength: 36 minLength: 1 type: string description: External code is a unique code for the payment term's discount rules. example: c9921a52-6d8b-1017-cb8c-923d discountDays: maximum: 2147483647 minimum: 0 type: - integer - 'null' description: Defines number of days used in dynamic cash discount. The number of days must be unique for each discount percentage. format: int32 example: 21 discountPercent: maximum: 1000000000 minimum: 0 type: - number - 'null' description: Defines the discount percentage that the supplier offers for the buyer for early cash payments format: double example: 1 active: type: boolean description: This flag will enable the data to be visible on UI, provided if the value is true, not visible in case of value is false. It will be also used for soft delete. example: false additionalProperties: false ResponseEntityList: type: object properties: requestId: type: - string - 'null' description: ID of the request on which error occurred (generated by Basware API). example: fbc082a2-65a4-469c-b230-d84a252f18fc hasErrors: type: boolean description: Specifies whether the request has errors. errors: type: - array - 'null' items: $ref: '#/components/schemas/ErrorEntity' additionalProperties: false description: Errors returned here are returned synchronously from Basware API middle layer. Additional errors coming from target system(s) may be returned through errorFeedbacks API. securitySchemes: Bearer: type: http description: Please insert basic authentication credentials into fields scheme: basic oauth2authentication: type: oauth2 description: Oauth2 client credentials flow. flows: clientCredentials: tokenUrl: https://api.basware.com/v1/tokens scopes: accountingDocuments.read: GET accountingDocuments accountingDocuments.write: POST/PATCH accountingDocuments accountingDocuments.delete: DELETE accountingDocuments accounts.read: GET accounts accounts.write: POST/PATCH accounts accounts.delete: DELETE accounts advancedPermissions.read: GET advancedPermissions advancedPermissions.write: POST/PATCH advancedPermissions advancedPermissions.delete: DELETE advancedPermissions advancedValidations.read: GET advancedValidations advancedValidations.write: POST/PATCH advancedValidations advancedValidations.delete: DELETE advancedValidations applicationGroups.read: GET applicationGroups applicationGroups.write: POST/PATCH applicationGroups companies.read: GET companies companies.write: POST/PATCH companies contracts.delete: DELETE contracts contracts.read: GET contracts contracts.write: POST/PATCH contracts costCenters.read: GET costCenters costCenters.write: POST/PATCH costCenters costCenters.delete: DELETE costCenters errorFeedbacks.read: GET errorFeedbacks errorFeedbacks.write: POST/PATCH errorFeedbacks errorFeedbacks.delete: DELETE errorFeedbacks exchangeRates.read: GET exchangeRates exchangeRates.write: POST/PATCH exchangeRates exchangeRates.delete: DELETE exchangeRates exportedContracts.read: GET exportedContracts exportedContracts.write: POST/PATCH exportedContracts exportedContracts.delete: DELETE exportedContracts exportedContractSpends.read: GET exportedContractSpends exportedContractSpends.write: POST/PATCH exportedContractSpends exportedContractSpends.delete: DELETE exportedContractSpends exportedPurchaseOrders.read: GET exportedPurchaseOrders exportedPurchaseOrders.write: POST/PATCH exportedPurchaseOrders exportedPurchaseOrders.delete: DELETE exportedPurchaseOrders exportedPurchaseRequisitions.read: GET exportedPurchaseRequisitions exportedPurchaseRequisitions.write: POST/PATCH exportedPurchaseRequisitions exportedPurchaseRequisitions.delete: DELETE exportedPurchaseRequisitions lists.read: GET lists lists.write: POST/PATCH lists lists.delete: DELETE lists matchingOrders.read: GET matchingOrders matchingOrders.write: POST/PATCH matchingOrders matchingOrders.delete: DELETE matchingOrders matchingOrderLines.read: GET matchingOrderLines matchingOrderLines.write: POST/PATCH matchingOrderLines matchingOrderLines.delete: DELETE matchingOrderLines paymentTerms.read: GET paymentTerms paymentTerms.write: POST/PATCH paymentTerms paymentTerms.delete: DELETE paymentTerms projects.read: GET projects projects.write: POST/PATCH projects projects.delete: DELETE projects purchaseOrders.read: GET purchaseOrders purchaseOrders.write: POST/PATCH purchaseOrders purchaseOrders.delete: DELETE purchaseOrders purchaseRequisitions.read: GET purchaseRequisitions purchaseRequisitions.write: POST/PATCH purchaseRequisitions purchaseRequisitions.delete: DELETE purchaseRequisitions purchaseGoodsReceipts.read: GET purchaseGoodsReceipts purchaseGoodsReceipts.write: POST/PATCH purchaseGoodsReceipts purchaseGoodsReceipts.delete: DELETE purchaseGoodsReceipts requestStatus.read: GET requestStatus requestStatus.write: POST/PATCH requestStatus subscriptions.read: GET subscriptions subscriptions.write: POST/PATCH subscriptions subscriptions.delete: DELETE subscriptions tasks.read: GET tasks taskStatus.read: GET taskStatus taxCodes.read: GET taxCodes taxCodes.write: POST/PATCH taxCodes taxCodes.delete: DELETE taxCodes users.read: GET users users.write: POST/PATCH users users.delete: DELETE users vendors.read: GET vendors vendors.write: POST/PATCH vendors vendors.delete: DELETE vendors