v1

latestOpenAPI 3.1.02026-07-24111224223.3 KB

Vendors

Retrieves a vendor

Fetches the full vendor profile including identifiers you must echo back on PUT updates. Use before editing to avoid wiping optional fields, and when validating tax or payment metadata during bill entry.

get/vendors/{vendor_id}

Path parameters

vendor_idstring required

UUID of the vendor to be used in this operation.

Response

namestring required

account_codestring

The account code found in the Chart of Accounts

emailstring email

payment_termsinteger

ten_ninety_nine_eligibleboolean

tax_idstring

idstring uuid required

updated_atstring date-time required

Example response

{
  "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"
}