v1

latestOpenAPI 3.0.32026-07-2632131.4 MB

Vendors (only available for accounting add-on users)

Update a vendor

patch/vendors/{id}

Path parameters

idstring required

Example:6092061fdeaae7002f92078e

Vendor id to update

Request body

companystring

The company name

firstNamestring

The first name

lastNamestring

The last name

phonestring[]

The phone numbers

emailstring[]

The email addresses

addressstring

The address

notesstring

The notes

Example request

{
  "company": "Acme Inc.",
  "firstName": "John",
  "lastName": "Doe",
  "phone": [
    "1234567890",
    "0987654321"
  ],
  "email": [
    "john.doe@example.com",
    "jane.doe@example.com"
  ],
  "address": "123 Main St, Anytown, USA",
  "notes": "Notes for the vendor",
  "payoutMethod": {
    "type": "ABA",
    "accountHolderName": "John Doe",
    "bankName": "Bank of America",
    "accountNumber": "1234567890",
    "routingNumber": "1234567890",
    "accountType": "Checking",
    "accountHolderType": "individual"
  }
}

Response

Vendor response

_idstring required

The vendor id

companystring required

The company name

firstNamestring required

The first name

lastNamestring required

The last name

fullNamestring

The full name

phonestring[] required

The phone numbers

emailstring[] required

The email addresses

addressstring

The address

codestring

Tax vendor code.

notesstring

The notes

Example response

{
  "_id": "6092061fdeaae7002f92078e",
  "company": "Company Inc.",
  "firstName": "John",
  "lastName": "Doe",
  "fullName": "John Doe",
  "phone": [
    "1234567890",
    "0987654321"
  ],
  "email": [
    "john.doe@example.com",
    "jane.doe@example.com"
  ],
  "address": "123 Main St, Anytown, USA",
  "code": "VAT",
  "notes": "Notes for the vendor",
  "payoutMethod": {
    "type": "ABA",
    "accountHolderName": "John Doe",
    "bankName": "Bank of America",
    "accountNumber": "1234567890",
    "routingNumber": "1234567890",
    "accountType": "Checking",
    "accountHolderType": "individual"
  }
}