Basware Vendors API

The Vendors API from Basware — 2 operation(s) for vendors.

Operations 5

GET /v1/vendors Returns vendors posted to Basware API.
POST /v1/vendors Creates new vendor(s), overwrites previous record if exists.
DELETE /v1/vendors Deletes data from Basware API. For manual one-time operations.
GET /v1/vendors/{externalCode} Returns single vendor by externalCode -identifier.
PATCH /v1/vendors/{externalCode} Updates fields on specified vendor. Preserves existing values in fields, which were not updated.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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-vendors-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.

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

OpenAPI Specification

basware-vendors-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Basware OAUTH2 authentication APIs AccountingDocuments Vendors 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 <https://developer.basware.com/api/p2p/manual#AccessRights>. \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 <https://api.basware.com/swagger>. \n\nSee the Basware API developer site at <https://developer.basware.com/api/p2p/manual#Authentication> for more details on API authentication."
  version: 1.0.0
  x-logo:
    url: https://fastapi.tiangolo.com/img/logo-margin/logo-teal.png
servers:
- url: https://api.basware.com
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Vendors
paths:
  /v1/vendors:
    get:
      tags:
      - Vendors
      summary: Returns vendors 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: 100
      - 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: 3fb86dcb-654a-4bc3-866b-b82f9435f4cf
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/VendorResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/VendorResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/VendorResponse'
        '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:
      - Vendors
      summary: Creates new vendor(s), overwrites previous record if exists.
      description: "Notes: \n1) Payment terms used by the vendor(s) need to exist in P2P. Payment terms can be imported through paymentTerms API or maintained manually in P2P.  \n2) Currencies used by the vendor(s) need to be active in P2P. Active currencies are maintained manually in P2P.  \n3) Vendors used with P2P Purchase need to have 'orderingFormat' value different from 'none'. 'OrderingFormat' field can be specified through vendors API (in orderingDetails -block), or it can be manually maintained in P2P. \n4) Posting vendors to Bsaware Portal requires company structure to be imported to portal. The company structure can also be backfilled to portal from P2P. \n5) Up to 200 vendor records can be sent in one POST vendors request.\n\nCheck out the [example JSONs using a minimal feasible set of fields](https://developer.basware.com/api/p2p/templates) from the developer site."
      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/VendorEntity'
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/VendorEntity'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/VendorEntity'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/VendorEntity'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/VendorEntity'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/VendorEntity'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/VendorEntity'
        '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:
      - Vendors
      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. \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.\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/vendors/{externalCode}:
    get:
      tags:
      - Vendors
      summary: Returns single vendor 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/VendorEntity'
            application/json:
              schema:
                $ref: '#/components/schemas/VendorEntity'
            text/json:
              schema:
                $ref: '#/components/schemas/VendorEntity'
        '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:
      - Vendors
      summary: Updates fields on specified vendor. Preserves existing values in fields, which were not updated.
      description: "Notes: \n1) 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'.\n2) This PATCH operation is not suitable for updating existing contents of vendor sub-entities, such as for updating existing contact or address details. Please use the POST operation for this instead."
      parameters:
      - name: externalCode
        in: path
        description: The ExternalCode of the vendor to be updated
        required: true
        schema:
          type: string
      requestBody:
        description: Entity to be updated
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/VendorEntity'
          application/json:
            schema:
              $ref: '#/components/schemas/VendorEntity'
          text/json:
            schema:
              $ref: '#/components/schemas/VendorEntity'
          application/*+json:
            schema:
              $ref: '#/components/schemas/VendorEntity'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/VendorEntity'
            application/json:
              schema:
                $ref: '#/components/schemas/VendorEntity'
            text/json:
              schema:
                $ref: '#/components/schemas/VendorEntity'
        '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:
    VendorPaymentTermEntity:
      required:
      - paymentTermCode
      type: object
      properties:
        paymentTermCode:
          maxLength: 25
          minLength: 1
          type: string
          description: Specifies the vendor's payment term code
          example: Net90
        description:
          maxLength: 200
          minLength: 0
          type:
          - string
          - 'null'
          example: Payment 90 days after invoice date
      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
    VendorProcessingStatusEntity:
      type: object
      properties:
        active:
          type:
          - boolean
          - 'null'
          description: 'Is the vendor active : true / false.'
        paymentDenied:
          type:
          - boolean
          - 'null'
          description: 'Is payment block is enabled for the vendor: true / false.'
          example: false
      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
    FinancialAccountIdentifierEntity:
      required:
      - schemeId
      type: object
      properties:
        schemeId:
          maxLength: 36
          minLength: 1
          type: string
          description: 'Account type: BBAN / IBAN.'
          example: IBAN
        description:
          maxLength: 200
          minLength: 0
          type:
          - string
          - 'null'
          description: 'Description. Note: Field is not used in P2P.'
          example: UK only
        id:
          maxLength: 50
          minLength: 0
          type:
          - string
          - 'null'
          description: 'The account number. Note: Max 32 chars when used with P2P.'
          example: GB29 NWBK 6016 1331 9268 19
        accountHolderName:
          maxLength: 200
          minLength: 0
          type:
          - string
          - 'null'
          description: 'Account holder name. Note: Field is not used in P2P.'
          example: United Parcels UK
        currencyCode:
          maxLength: 3
          minLength: 3
          type:
          - string
          - 'null'
          description: 'Currency code of the account. Note: Field is not used in P2P. To import the supplier specific currency code to P2P, use the ''currencyCode'' field in ''paymentMeans'' -block.'
          example: GBP
        accountAdditionalData1:
          maxLength: 200
          minLength: 0
          type:
          - string
          - 'null'
          description: Account additional data field 1.
          example: FRS123
        accountAdditionalData2:
          maxLength: 200
          minLength: 0
          type:
          - string
          - 'null'
          description: Account additional data field 2.
          example: 971298-1212
        default:
          type:
          - boolean
          - 'null'
          description: Is this the default account (true / false).
        linkedBbanOrIban:
          maxLength: 50
          minLength: 0
          type:
          - string
          - 'null'
          description: 'Allows linking BBAN and IBAN together when both represent the same bank account.

            Accounts are linked when the value of linkedBbanOrlban'' on account A is the same as the value of ''id'' on account B (and also the other way around).

            Also, the schemeld values need to be ''IBAN'' and ''BBAN'' and values of fields ''currencyCode'', ''accountAdditionalDatal'', ''accountAdditionalData2'', ''default'' need to be same on both accounts.

            Account linking is supported only by P2P.'
          example: ''
      additionalProperties: false
    VendorPaymentMeanEntity:
      required:
      - paymentMeansCode
      type: object
      properties:
        paymentMeansCode:
          maxLength: 25
          minLength: 1
          type: string
          description: Specifies the payment means code.
          example: A001
        description:
          maxLength: 200
          minLength: 0
          type:
          - string
          - 'null'
          description: Specifies payment means description.
          example: Payment by a pre-printed form (check).
        currencyCode:
          maxLength: 3
          minLength: 3
          type:
          - string
          - 'null'
          description: 'Specifies vendor default currency. This is used as vendor''s default currency in P2P. Notes: 1) currencyCode of the payment means -block where default = ''true'' is selected as the vendor''s default currency in P2P. 2) This currency needs to be marked as ''active'' in P2P.'
          example: USD
        financialAccounts:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VendorfinancialAccountsEntity'
        default:
          type:
          - boolean
          - 'null'
          description: Is this the default payment means (true / false).
      additionalProperties: false
    VendorOrderingDetailsEntity:
      type: object
      properties:
        orderingFormat:
          enum:
          - UBL
          - EHFXML21
          - email
          - other
          - none
          - BaswareNetwork
          type:
          - string
          - 'null'
          description: "Specifies format in which orders are sent to vendor (from P2P Purchase).\n'UBL' = Deprecated value, will be converted to 'BaswareNetwork'.\n'EHFXML21' = Deprecated value, will be converted to 'BaswareNetwork'.\n'email' = Deliver purchase orders by email as PDF attachments or SmartOrders.\n'other' = Deprecated value, will be converted to 'none'.\n'none' = Vendor not available for purchasing process.\n'BaswareNetwork' = Deliver purchase orders in XML UBL2.0 format to Basware Network. \n\nNote: Since all ERP systems do not have a field for this information, P2P can be configured so that this field is maintained in P2P instead of being imported through API."
          example: none
        orderingMessageLanguage:
          maxLength: 10
          minLength: 0
          type:
          - string
          - 'null'
          description: Specifies language of order -message sent to vendor from P2P Purchase.
          example: en-US
        orderingLanguage:
          maxLength: 25
          minLength: 0
          type:
          - string
          - 'null'
          description: Specifies region-specific texts, including number- and date formats used in the order -message sent to supplier from P2P Purchase.
          example: en-US
        orderEmail:
          maxLength: 320
          minLength: 3
          pattern: ^(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*)@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$
          type:
          - string
          - 'null'
          description: 'Specifies the supplier''s email address where the purchase order is sent to. Note: Since all ERP systems do not have a field for this information, P2P can be configured so that this field is maintained in P2P instead of being imported through API.'
          example: orders@vendor.com
        orderProcessType:
          maxLength: 50
          minLength: 0
          type:
          - string
          - 'null'
          description: Name of order process. Not used in Basware P2P.
        minimumOrderAllowed:
          type:
          - number
          - 'null'
          description: Value of the minimum order allowed. Not used in Basware P2P.
          format: double
        isTaxable:
          type:
          - boolean
          - 'null'
          description: Are purchases from this vendor taxable. Not used in Basware P2P.
        automaticallyReceiveOnInvoice:
          type:
          - boolean
          - 'null'
          description: Not used in Basware P2P.
        automaticallyReceiveOnOrder:
          type:
          - boolean
          - 'null'
          description: Not used in Basware P2P.
        hasActiveCatalog:
          type:
          - boolean
          - 'null'
          description: Not used in Basware P2P.
        createOrderAutomatically:
          type:
          - boolean
          - 'null'
          description: Not used in Basware P2P.
        deliverOrderAutomatically:
          type:
          - boolean
          - 'null'
          description: Not used in Basware P2P.
        noFreeformItems:
          type:
          - boolean
          - 'null'
          description: Not used in Basware P2P.
        sendToNetwork:
          type:
          - boolean
          - 'null'
          description: Not used in Basware P2P.
      additionalProperties: false
    VendorAddressEntity:
      required:
      - externalCode
      - name
      type: object
      properties:
        externalCode:
          maxLength: 36
          minLength: 1
          type: string
          description: External code for vendor address.
          example: d6437eef-0d71-4cb0-8a6e-7f114831479d
        name:
          maxLength: 200
          minLength: 1
          type: string
          description: Specifies the address' name for the vendor.
          example: Delivery address
        description:
          maxLength: 200
          minLength: 0
          type:
          - string
          - 'null'
          description: Freetext description of the address.
          example: Default delivery addrss
        addressType:
          enum:
          - AdditionalAddress
          - VisitingAddress
          - RemittanceAddress
          - DeliveryAddress
          - PostalAddress
          - RegistrationAddress
          type:
          - string
          - 'null'
          description: 'Specifies type of the address. Typically PostalAddress and DeliveryAddress are used with P2P. Types supported by P2P: PostalAddress, DeliveryAddress, AdditionalAddress, RemittanceAddress.'
          example: DeliveryAddress
        addressLine1:
          maxLength: 200
          minLength: 0
          type:
          - string
          - 'null'
          description: 'Vendor address as free text, line 1. Use by target systems - P2P: no, Vendor manager: yes.'
          example: 1800 Main Street
        addressLine2:
          maxLength: 200
          minLength: 0
          type:
          - string
          - 'null'
          description: 'Vendor address as free text, line 2. Use by target systems - P2P: no, Vendor manager: yes.'
        addressLine3:
          maxLength: 200
          minLength: 0
          type:
          - string
          - 'null'
          description: 'Vendor address as free text, line 3. Use by target systems - P2P: no, Vendor manager: yes.'
        cityName:
          maxLength: 50
          minLength: 0
          type:
          - string
          - 'null'
          example: Dallas
        postalZone:
          maxLength: 50
          minLength: 0
          type:
          - string
          - 'null'
          example: '75201'
        poBox:
          maxLength: 50
          minLength: 0
          type:
          - string
          - 'null'
          example: '724'
        streetName:
          maxLength: 50
          minLength: 0
          type:
          - string
          - 'null'
          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'
          example: TX
        countrySubEntityDescription:
          maxLength: 50
          minLength: 0
          type:
          - string
          - 'null'
          example: Texas
        countryId:
          maxLength: 2
          minLength: 2
          type:
          - string
          - 'null'
          description: 'Defines the country ID for the account. Please use 2-char ISO country codes (according to ISO-3166-1 -standard). Note: This field is not used in P2P.'
          example: US
        default:
          type:
          - boolean
          - 'null'
          description: Is this the default address (true / false).
        additionalAddressFields:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VendorAddressPartEntity'
          description: 'Additional address fields. Use by target systems - P2P: yes, Vendor manager: no.'
      additionalProperties: false
    VendorCompanyEntity:
      required:
      - companyCode
      type: object
      properties:
        companyCode:
          maxLength: 32
          minLength: 1
          type: string
          description: Specifies the organization that the vendor is mapped to.
          example: BW00
        inheritToChildUnits:
          type:
          - boolean
          - 'null'
          description: Specifies whether the vendor is inherited to lower organizations.
      additionalProperties: false
    VendorEntity:
      required:
      - companies
      - externalCode
      - name
      - vendorCode
      type: object
      properties:
        externalCode:
          maxLength: 36
          minLength: 1
          type: string
          description: Specifies a unique code to identify vendor for updates through Basware API.
          example: c6437eef-0d71-4cb0-8a6e-7f114831478d
        vendorCode:
          maxLength: 25
          minLength: 1
          type: string
          description: Vendor code. Normally the vendor code used by Customer ERP system.
          example: '81264'
        vendorParent:
          type:
          - string
          - 'null'
          description: VendorCode of parent. Not used in Basware P2P.
          example: AS12154
        buvid:
          maxLength: 36
          minLength: 0
          type:
          - string
          - 'null'
          description: Vendor identifier generated by Basware. Not to be included when posting data.
          example: f0b29a62-a5e0-4285-8ceb-11a92eccf212
        name:
          maxLength: 250
          minLength: 1
          type: string
          description: Vendor name.
          example: Things and Gadgets Inc.
        sourceSystem:
          maxLength: 36
          minLength: 0
          type:
          - string
          - 'null'
          description: Name of the source system, e.g. ERP instance
          example: SAPEUR1
        description:
          maxLength: 250
          minLength: 0
          type:
          - string
          - 'null'
          description: Freetext description of vendor
          example: ''
        lastUpdated:
          type: string
          description: Timestamp when the record was last sent to API. Set automatically.
          format: date-time
        supplierAssignedAccountId:
          maxLength: 128
          minLength: 0
          type:
          - string
          - 'null'
          description: Customer ID in vendor's system.
          example: '12890'
        eligibleForSourcing:
          type:
          - boolean
          - 'null'
          description: 'Specifies whether the vendor is eligible for sourcing activities. This flag can be used to mark vendors that need to be copied to an external sourcing system. Note: If your sourcing system does not support a multiple company -structure, please make sure only one company-specific instance of the each vendor has eligibleForSourcing = ''true''.'
          example: false
        vendorClass:
          maxLength: 100
          minLength: 0
          type:
          - string
          - 'null'
          description: 'Specifies vendor class. Can be used to determine preferred vendors in P2P Purchase. Values are determined by customer. Typical example values: A, B, C, Preferred. Note: Allowed values for vendor class need to be configured in P2P before posting data.'
          example: Preferred
        identifiers:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VendorIdentifierEntity'
          description: Vendor identifiers
        addresses:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VendorAddressEntity'
          description: Vendor addresses
        contacts:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schema

# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/basware/refs/heads/main/openapi/basware-vendors-api-openapi.yml