openapi: 3.0.2 info: title: Basware OAUTH2 authentication APIs AccountingDocuments ExchangeRates API description: "**Using OAUTH2.0 authentication:**\n\nGet API access token from api.basware.com/tokens\n1. Using client id and client secret, which you can obtain from Basware. \n2. Specify which APIs can be accessed by using the token e.g. Read only access to vendors API only (these are called scopes). Available scopes are listed at . \n3. Each token has an expiration time, until which it can be used to call APIs.\n\nWhen using OAUTH2 authentication, you need to pass the OAUTH2 authentication token when calling Basware API endpoints. Available Basware API operations are documented at . \n\nSee the Basware API developer site at for more details on API authentication." version: 1.0.0 x-logo: url: https://fastapi.tiangolo.com/img/logo-margin/logo-teal.png tags: - name: ExchangeRates paths: /v1/exchangeRates: get: tags: - ExchangeRates summary: Returns exchange rates 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: f408eee3-70fb-4213-91af-7715d9319746 responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ExchangeRateResponse' application/json: schema: $ref: '#/components/schemas/ExchangeRateResponse' text/json: schema: $ref: '#/components/schemas/ExchangeRateResponse' '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' post: tags: - ExchangeRates summary: Creates new exchange rate(s), fully overwrites previous record if exists. description: "Notes:\r\n1) Please provide exchange rates to 1) the currency used by entire organization as well as 2) to currencies used by individual companies. \r\n2) Exchange rates are inherited in P2P from top level organizations down if company-specific rates are not provided. \r\n3) Multiplying 'from' currency amount by rate needs to give amount in 'to' -currency." 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/ExchangeRateEntity' application/json: schema: type: array items: $ref: '#/components/schemas/ExchangeRateEntity' text/json: schema: type: array items: $ref: '#/components/schemas/ExchangeRateEntity' application/*+json: schema: type: array items: $ref: '#/components/schemas/ExchangeRateEntity' responses: '200': description: Success content: text/plain: schema: type: array items: $ref: '#/components/schemas/ExchangeRateEntity' application/json: schema: type: array items: $ref: '#/components/schemas/ExchangeRateEntity' text/json: schema: type: array items: $ref: '#/components/schemas/ExchangeRateEntity' '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' delete: tags: - ExchangeRates 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. \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." requestBody: description: "Contains the body of the request.\r\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' /v1/exchangeRates/{externalCode}: get: tags: - ExchangeRates summary: Returns single exchange rate -record 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/ExchangeRateEntity' application/json: schema: $ref: '#/components/schemas/ExchangeRateEntity' text/json: schema: $ref: '#/components/schemas/ExchangeRateEntity' '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' patch: tags: - ExchangeRates summary: Updates fields on specified exchange rate. Preserves existing values in non-updated fields. description: 'Note: Basware API considers ''null'' value in field(s) equivalent to the field(s) not being sent. For this reason patch method does not support setting field values to ''null''.' parameters: - name: externalCode in: path description: The ExternalCode of the exchangeRate to be updated required: true schema: type: string requestBody: description: Entity to be updated content: application/json-patch+json: schema: $ref: '#/components/schemas/ExchangeRateEntity' application/json: schema: $ref: '#/components/schemas/ExchangeRateEntity' text/json: schema: $ref: '#/components/schemas/ExchangeRateEntity' application/*+json: schema: $ref: '#/components/schemas/ExchangeRateEntity' responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ExchangeRateEntity' application/json: schema: $ref: '#/components/schemas/ExchangeRateEntity' text/json: schema: $ref: '#/components/schemas/ExchangeRateEntity' '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' components: schemas: DeleteRequest: type: object properties: lastUpdated: type: string 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 nullable: true externalCode: maxLength: 36 minLength: 0 type: string description: Single item can be deleted using externalCode and final status is returned immediately. nullable: true additionalProperties: false DeleteResponse: type: object properties: statusApiLink: type: string nullable: true taskName: type: string nullable: true taskStatus: type: string nullable: true additionalProperties: false ExchangeRateResponse: required: - exchangeRates type: object properties: exchangeRates: type: array items: $ref: '#/components/schemas/ExchangeRateEntity' additionalProperties: false ExchangeRateEntity: required: - companies - currencyCodeFrom - currencyCodeTo - externalCode - rate - validFrom type: object properties: rate: maximum: 1000000000 minimum: 0 type: number description: Defines the selected currency's exchange rate. Multiplying amount in 'from' -currency by rate provides the amount in 'to' -currency. format: double example: 0.564858 currencyCodeTo: maxLength: 3 minLength: 2 type: string description: The currency code defines the base currency. example: EUR currencyCodeFrom: maxLength: 3 minLength: 2 type: string description: The currency code defines the quote currency. example: AUD validFrom: type: string description: Defines the date when the exchange rate becomes valid format: date-time example: '2020-04-08' companies: type: array items: $ref: '#/components/schemas/ExchangeRateCompanyEntity' description: List of company units to associate exchangerate to P2P organization hierarchy 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 description: External code of record on which error occurred (when available). nullable: true 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 description: Specific error message. nullable: true example: '' info: type: string description: Information about type of the error. nullable: true example: '' additionalProperties: false ResponseEntityList: type: object properties: requestId: type: string description: ID of the request on which error occurred (generated by Basware API). nullable: true example: fbc082a2-65a4-469c-b230-d84a252f18fc hasErrors: type: boolean description: Specifies whether the request has errors. errors: type: array items: $ref: '#/components/schemas/ErrorEntity' nullable: true 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. ExchangeRateCompanyEntity: required: - active - companyCode type: object properties: companyCode: maxLength: 32 minLength: 1 type: string description: Defines the organization that the exchange rate is mapped to example: BW00 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 securitySchemes: HTTPBasic: type: http scheme: basic