v1

latestOpenAPI 3.1.02026-07-24111224223.3 KB
Vendors

Creates a vendor

Adds a vendor master record the accounts-payable team can select on bills, vendor credits, and payments. Capture legal name, remit-to address, default currency, and payment terms so downstream bills inherit correct due dates and banking instructions.

post/vendors

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

OK

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