{
  "opencollection": "1.0.0",
  "info": {
    "name": "Basware OAUTH2 authentication APIs AccountingDocuments Vendors API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Vendors",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Returns vendors posted to Basware API.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/vendors",
            "headers": [
              {
                "name": "x-amz-meta-continuationtoken",
                "value": "3fb86dcb-654a-4bc3-866b-b82f9435f4cf"
              }
            ],
            "params": [
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "A limit for the number of items to be returned for one request. Limit can range between 1 and 500 items."
              },
              {
                "name": "companyCode",
                "value": "",
                "type": "query",
                "description": "Company filter. Returns items for specific company."
              },
              {
                "name": "lastUpdated",
                "value": "",
                "type": "query",
                "description": "Date Filter. Returns items that have been updated after specified date."
              }
            ]
          },
          "docs": "Returns vendors posted to Basware API."
        },
        {
          "info": {
            "name": "Creates new vendor(s), overwrites previous record if exists.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v1/vendors",
            "headers": [
              {
                "name": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Notes: \r\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.  \r\n2) Currencies used by the vendor(s) need to be active in P2P. Active currencies are maintained manually in P2P.  \r\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. \r\n4"
        },
        {
          "info": {
            "name": "Deletes data from Basware API. For manual one-time operations.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/v1/vendors",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Returns single vendor by externalCode -identifier.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/vendors/:externalCode",
            "params": [
              {
                "name": "externalCode",
                "value": "",
                "type": "path",
                "description": "The ExternalCode of the entity to be fetched"
              }
            ]
          },
          "docs": "Returns single vendor by externalCode -identifier."
        },
        {
          "info": {
            "name": "Updates fields on specified vendor. Preserves existing values in fields, which were not updated.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/v1/vendors/:externalCode",
            "params": [
              {
                "name": "externalCode",
                "value": "",
                "type": "path",
                "description": "The ExternalCode of the vendor to be updated"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Notes: \r\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'.\r\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."
        }
      ]
    }
  ],
  "bundled": true
}