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-companies-deprecated-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: Companies (deprecated)
paths:
  /v1/companies:
    get:
      tags:
      - Companies (deprecated)
      summary: Returns companies 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: 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: 181e100d-88ea-4e60-a183-06eacc69334d
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CompanyResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CompanyResponse'
        '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: getV1Companies
      x-operation-id-source: derived
    post:
      tags:
      - Companies (deprecated)
      summary: Creates new companies, fully overwrites previous record if exists
      description: 'Note: Only consuming target system at the moment is Open Network Portal (incl. Vendor manager). Companies cannot be imported to P2P through this API.


        Please see section "Usage scenario 6: Import companies" of Basware Purchase-to-Pay API manual for details on implementing this API.'
      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/CompanyEntity'
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/CompanyEntity'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/CompanyEntity'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/CompanyEntity'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyEntity'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyEntity'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CompanyEntity'
        '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: postV1Companies
      x-operation-id-source: derived
  /v1/companies/{companyCode}:
    get:
      tags:
      - Companies (deprecated)
      summary: Returns single company record by companyCode - identifier
      description: ''
      parameters:
      - name: companyCode
        in: path
        description: The companyCode of the entity to be fetched
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CompanyEntity'
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyEntity'
            text/json:
              schema:
                $ref: '#/components/schemas/CompanyEntity'
        '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: getV1CompaniesByCompanyCode
      x-operation-id-source: derived
components:
  schemas:
    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
    CompanyEntity:
      required:
      - active
      - companyCode
      - name
      type: object
      properties:
        companyCode:
          maxLength: 32
          minLength: 1
          type: string
          description: Unique code to identify the company. Also used as an 'externalCode' for the company.
          example: '200'
        sourceSystem:
          maxLength: 32
          minLength: 1
          type:
          - string
          - 'null'
          description: Informative name of the source system, e.g. ERP instance.
          example: SAP_1
        name:
          maxLength: 100
          minLength: 1
          type: string
          description: Company name.
          example: Acme corporation
        description:
          maxLength: 250
          minLength: 0
          type:
          - string
          - 'null'
          description: Company description.
          example: ''
        lastUpdated:
          type: string
          description: Timestamp when the record was last sent to API. Set automatically.
          format: date-time
        bucompid:
          maxLength: 36
          minLength: 1
          type:
          - string
          - 'null'
          description: Basware internal ID for the company. Generated by Basware API.
          example: c61f8a6f-140f-423b-b9fd-3ae32345febb
        identifiers:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CompanyIdentifierEntity'
          description: 'Company identifiers. See "[Usage scenario 6: Import companies](https://developer.basware.com/api/p2p/manual#usage6) on Basware API developer site for explanation of available values.'
        addresses:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CompanyAddressEntity'
          description: Company addresses.
        contacts:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CompanyContactEntity'
          description: Company contacts.
        userDefaultLanguage:
          maxLength: 25
          minLength: 0
          type:
          - string
          - 'null'
          description: "The default language code for users for this company. \nUse following format: [language 2-chars in UPPERCASE]-[country 2-chars in lowercase]."
          example: en-US
        homeCurrency:
          maxLength: 3
          minLength: 3
          type:
          - string
          - 'null'
          description: Company home currency.
          example: EUR
        active:
          type: boolean
          description: Determines is company active or inactive. It is also used for soft delete.
          example: true
        publishToBusinessDirectory:
          type:
          - boolean
          - 'null'
          description: When 'true, the company data entity will be published to Business Directory in Basware Portal.
          example: true
      additionalProperties: false
    CompanyResponse:
      required:
      - companies
      type: object
      properties:
        companies:
          type: array
          items:
            $ref: '#/components/schemas/CompanyEntity'
      additionalProperties: false
    CompanyAddressEntity:
      required:
      - addressType
      - externalCode
      - name
      type: object
      properties:
        externalCode:
          maxLength: 36
          minLength: 1
          type: string
          description: External code for company address.
          example: d6437eef-0d71-4cb0-8a6e-7f114831479d
        name:
          maxLength: 200
          minLength: 1
          type: string
          description: Specifies the address' name for the company.
          example: Remittance address
        description:
          maxLength: 200
          minLength: 0
          type:
          - string
          - 'null'
          example: This is used as Remit To address
        addressType:
          enum:
          - AdditionalAddress
          - VisitingAddress
          - RemittanceAddress
          - DeliveryAddress
          - PostalAddress
          - RegistrationAddress
          - InvoicingAddress
          type: string
          description: 'Specifies type of the address. Types supported by P2P: DeliveryAddress, InvoicingAddress, PostalAddress.'
          example: DeliveryAddress
        addressLine1:
          maxLength: 200
          minLength: 0
          type:
          - string
          - 'null'
          description: Company address as free text, line 1.
          example: 1800 Main Street
        addressLine2:
          maxLength: 200
          minLength: 0
          type:
          - string
          - 'null'
          description: Company address as free text, line 2.
        addressLine3:
          maxLength: 200
          minLength: 0
          type:
          - string
          - 'null'
          description: Company address as free text, line 3.
        cityName:
          maxLength: 50
          minLength: 0
          type:
          - string
          - 'null'
          description: City name.
          example: Dallas
        postalZone:
          maxLength: 50
          minLength: 0
          type:
          - string
          - 'null'
          description: Postal zone.
          example: '75201'
        poBox:
          maxLength: 50
          minLength: 0
          type:
          - string
          - 'null'
          description: PO box.
          example: '724'
        streetName:
          maxLength: 50
          minLength: 0
          type:
          - string
          - 'null'
          description: Street name.
          example: Burlington Avenue
        locality:
          maxLength: 50
          minLength: 0
          type:
          - string
          - 'null'
          description: Attribute to postalAddress. This field is required in UK if a similar road name exists within a post town area.
          example: Burlington
        countrySubEntity:
          maxLength: 50
          minLength: 0
          type:
          - string
          - 'null'
          description: Country sub entity.
          example: TX
        countrySubEntityDescription:
          maxLength: 50
          minLength: 0
          type:
          - string
          - 'null'
          description: Country sub entity description.
          example: Texas
        countryId:
          maxLength: 2
          minLength: 2
          type:
          - string
          - 'null'
          description: Defines the country ID for the company.
          example: US
        default:
          type:
          - boolean
          - 'null'
          description: Is this the default address (true / false).
      additionalProperties: false
    CompanyContactEntity:
      required:
      - name
      - role
      type: object
      properties:
        name:
          maxLength: 200
          minLength: 1
          type: string
          description: Name of the contact. Used as a key in list of contacts.
          example: DeliveryContact1
        description:
          maxLength: 200
          minLength: 0
          type:
          - string
          - 'null'
          example: Use this as a primary contact
        telephone:
          maxLength: 50
          minLength: 0
          type:
          - string
          - 'null'
          description: Specifies the contact's telephone number.
          example: 555-3342-454
        telefax:
          maxLength: 50
          minLength: 0
          type:
          - string
          - 'null'
          description: Specifies the contact's fax number.
          example: 555-3342-45412
        email:
          maxLength: 200
          minLength: 0
          type:
          - string
          - 'null'
          description: Specifies the contact's email address.
          example: mrsmith@business.org
        website:
          maxLength: 200
          minLength: 0
          type:
          - string
          - 'null'
          description: Specifies the contact's web site address.
          example: www.mrSmith.com
        role:
          enum:
          - AdditionalContact
          - PrimaryContact
          - SecondaryContact
          type: string
          description: Role of contact.
      additionalProperties: false
    CompanyIdentifierEntity:
      required:
      - id
      - schemeId
      type: object
      properties:
        id:
          maxLength: 36
          minLength: 1
          type: string
          description: Company identifier value.
          example: GB190101452
        schemeId:
          maxLength: 36
          minLength: 1
          type: string
          description: 'Company identifier type. Defines type of ‘Id’ -field. Available values:

            DUNS, EMAIL-RFC2822, GLN, IBAN, ISO6523-ACTORID-UPIS, UNKNOWN, EU:VAT, AT:ORGNR, AU:ABN, AU:ACN, AU:TFN, BE:KBO, CA:BN, CA:GST, CA:VAT, CH:ORGNR, CH:VAT, CN:BRN, CZ:ORGNR, DE:ORGNR, DK:CVR, EE:ORGNR, ES:CIF, ES:NIF, FI:Y-TUNNUS, FR:SIRENE, FR:SIRET, GB:UTR, IE:ORGNR, IN:GSTIN, IT:FISCALE, IT:IPA, LI:VAT, MX:VAT, MY:GST, NL:KVK, NO:ORGNR, NO:VAT, PL:KRS, PL:REGON, PT:NIF, SE:ORGNR, SK:ORGNR, GB:ORGNR, UstidNr, US:TIN'
          example: EU:VAT
      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