v1

latestOpenAPI 3.1.02026-07-24111224223.3 KB

Vendors

Updates a vendor

IMPORTANT: This is a full-replace operation (PUT semantics). All fields must be included in the request body — omitting any field will set it to null, wiping existing data. Always call retrieve-a-vendor first to fetch the current record, then include ALL existing fields in your update request along with your changes.

put/vendors/{vendor_id}

Path parameters

vendor_idstring required

UUID of the vendor to be used in this operation.

Request body

namestring required

account_codestring

The account code found in the Chart of Accounts

emailstring email

payment_termsinteger

ten_ninety_nine_eligibleboolean

tax_idstring

Example request

{
  "name": "MyVendor",
  "account_code": "11112",
  "address": {
    "line1": "123 Main St",
    "line2": "Apt 4B",
    "city": "Nashville",
    "state": "TN",
    "zip_code": "37201",
    "country": "US"
  },
  "external_references": [
    {
      "type": "xyzSystemId",
      "id": "234",
      "url": "https://xyzsystempage.com/ids/234"
    }
  ],
  "tax_id": "123"
}

Response