find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/basware-errorfeedbacks-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

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: ErrorFeedbacks
paths:
  /v1/errorFeedbacks:
    get:
      tags:
      - ErrorFeedbacks
      summary: Returns error messages from receiving end-system(s), based on error time stamp
      description: 'The ''errorFeedbacks'' API has been replaced by ''requestStatus'' API and is likely to be deprecated at a later time. There will be a 12 months notice period before eventual deprecation. Currently both APIs are functioning side by side and are returning same errors.


        If errors occur after Basware API has validated the data schema, these will be returned from target systems asynchronously in this interface. Please see section "Usage scenario 5: Error handling and monitoring" in Basware Purchase-to-Pay API manual for details on implementing error handling with Basware API.'
      parameters:
      - name: targetSystem
        in: query
        description: Basware application module which has posted error ("P2P", "Vendor Manager", "Purchase Manager", etc.)
        schema:
          type: string
      - name: entityType
        in: query
        description: The EntityType of the entities to be fetched.
        schema:
          enum:
          - Account
          - Contract
          - CostCenter
          - TaxCode
          - ExchangeRate
          - PaymentTerm
          - User
          - Project
          - MatchingOrder
          - MatchingOrderLine
          - GenericList
          - AdvancedPermission
          - TransferResponse
          - PaymentResponse
          - PrebookResponse
          - Vendor
          - AdvancedValidation
          - PurchaseRequisition
          - PurchaseOrder
          - PurchaseGoodsReceipt
          - Organization
          - EnrichmentTransferResponse
          - UserGroup
          - UserGroupAssociatedUser
          - UserGroupPermission
          type: string
      - 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: 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: ac70cf44-8179-4f90-b2b4-97d6b4b896ef
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ErrorFeedbackResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFeedbackResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ErrorFeedbackResponse'
        '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: getV1ErrorFeedbacks
      x-operation-id-source: derived
    delete:
      tags:
      - ErrorFeedbacks
      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.'
      parameters:
      - name: entityType
        in: query
        description: Name of entity for which records to be deleted from errorFeedback table.
        schema:
          enum:
          - Account
          - Contract
          - CostCenter
          - TaxCode
          - ExchangeRate
          - PaymentTerm
          - User
          - Project
          - MatchingOrder
          - MatchingOrderLine
          - GenericList
          - AdvancedPermission
          - TransferResponse
          - PaymentResponse
          - PrebookResponse
          - Vendor
          - AdvancedValidation
          - PurchaseRequisition
          - PurchaseOrder
          - PurchaseGoodsReceipt
          - Organization
          - EnrichmentTransferResponse
          - UserGroup
          - UserGroupAssociatedUser
          - UserGroupPermission
          type: string
      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: deleteV1ErrorFeedbacks
      x-operation-id-source: derived
  /v1/errorFeedbacks/{requestId}:
    get:
      tags:
      - ErrorFeedbacks
      summary: Returns error messages from receiving end-system(s), based on webservice…
      description: 'The ''errorFeedbacks'' API has been replaced by ''requestStatus'' API and is likely to be deprecated at a later time. There will be a 12 months notice period before eventual deprecation. Currently both APIs are functioning side by side and are returning same errors.


        If errors occur after Basware API has validated the data schema, these will be returned from target systems asynchronously in this interface. Please see section "Usage scenario 5: Error handling and monitoring" in Basware Purchase-to-Pay API manual for details on implementing error handling with Basware API.'
      parameters:
      - name: requestId
        in: path
        description: The RequestId of the entity to be fetched
        required: true
        schema:
          type: string
      - 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
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ErrorFeedbackResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFeedbackResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ErrorFeedbackResponse'
        '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: getV1ErrorFeedbacksByRequestId
      x-operation-id-source: derived
  /v1/errorFeedbacks/{entityType}/{errorEntityExternalCode}:
    get:
      tags:
      - ErrorFeedbacks
      summary: Returns error messages from receiving end-system(s), based on interface and…
      description: 'The ''errorFeedbacks'' API has been replaced by ''requestStatus'' API and is likely to be deprecated at a later time. There will be a 12 months notice period before eventual deprecation. Currently both APIs are functioning side by side and are returning same errors.


        If errors occur after Basware API has validated the data schema, these will be returned from target systems asynchronously in this interface. Please see section "Usage scenario 5: Error handling and monitoring" in Basware Purchase-to-Pay API manual for details on implementing error handling with Basware API.'
      parameters:
      - name: entityType
        in: path
        description: The entityType of the entities to be fetched
        required: true
        schema:
          enum:
          - Account
          - Contract
          - CostCenter
          - TaxCode
          - ExchangeRate
          - PaymentTerm
          - User
          - Project
          - MatchingOrder
          - MatchingOrderLine
          - GenericList
          - AdvancedPermission
          - TransferResponse
          - PaymentResponse
          - PrebookResponse
          - Vendor
          - AdvancedValidation
          - PurchaseRequisition
          - PurchaseOrder
          - PurchaseGoodsReceipt
          - Organization
          - EnrichmentTransferResponse
          - UserGroup
          - UserGroupAssociatedUser
          - UserGroupPermission
          type: string
      - name: errorEntityExternalCode
        in: path
        description: The ExternalCode of the entities to be fetched
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ErrorFeedbackResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFeedbackResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ErrorFeedbackResponse'
        '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: getV1ErrorFeedbacksByEntityTypeByErrorEntityExternalCode
      x-operation-id-source: derived
components:
  schemas:
    ErrorFeedbackEntity:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: Basware internal ID for the error.
          example: ba118ccb-1fd3-4d63-936a-f01e40babba7
        requestId:
          type:
          - string
          - 'null'
          description: RequestId of the message posted by Customer to Basware API, on which this error occurred. The requestId generated by Basware API and returned on response header when sending a message to the API.
          example: 40d1f86c-8446-45dd-a62f-8b23ef77d304
        externalCode:
          type:
          - string
          - 'null'
          description: ExternalCode of the record on which the error occurred.
          example: 4847-31231212-212121-1970
        errorEntity:
          type:
          - string
          - 'null'
          description: JSON object containing the data posted for the record containing the error.
          example: '{\"CostCenterCode\":\"35680\",\"CostCenterNames\":[{\"Translation\":\"Helsinki Harbour\",\"Language\":\"en-US\"}],\"ExternalCode\":\"4847-31231212-212121-1970\",\"Companies\":[{\"CompanyCode\":\"208\",\"Active\":true},{\"CompanyCode\":\"01\",\"Active\":false}],\"LastUpdated\":\"10/08/2020 09:52:49\"}'
        entityType:
          enum:
          - Account
          - Contract
          - CostCenter
          - TaxCode
          - ExchangeRate
          - PaymentTerm
          - User
          - Project
          - MatchingOrder
          - MatchingOrderLine
          - GenericList
          - AdvancedPermission
          - TransferResponse
          - PaymentResponse
          - PrebookResponse
          - Vendor
          - AdvancedValidation
          - PurchaseRequisition
          - PurchaseOrder
          - PurchaseGoodsReceipt
          - Organization
          - EnrichmentTransferResponse
          - UserGroup
          - UserGroupAssociatedUser
          - UserGroupPermission
          type: string
          description: Entity (interface) type of the record on which the error occurred.
          example: CostCenter
        errorStamp:
          type: string
          description: Timestamp when the error occurred.
          format: date-time
        errors:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of errors which occurred on the record.
        targetSystem:
          type:
          - string
          - 'null'
          description: 'Target system from which the error originated. Examples: P2P, Vendor Manager, Purchase Manager.'
          example: P2P
      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
    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
    DeleteResponse:
      type: object
      properties:
        statusApiLink:
          type:
          - string
          - 'null'
        taskName:
          type:
          - string
          - 'null'
        taskStatus:
          type:
          - string
          - 'null'
      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.
    ErrorFeedbackResponse:
      required:
      - errorList
      type: object
      properties:
        errorList:
          type: array
          items:
            $ref: '#/components/schemas/ErrorFeedbackEntity'
      additionalProperties: false
  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