v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB

Vendor

Retrieves the collection of Vendor resources.

get/vendors

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

Vendor collection

idstring

Unique identifier for this vendor note that no particular pattern in this field is guaranteed, only that this field is unique e.g: "quickbooks-726"

integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring

The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S"

givenNamestring nullable

First name of the vendor e.g. "Jane"

familyNamestring nullable

Last name of the vendor e.g. "Doe"

companyNamestring nullable

Name of the company e.g. "Doyle-Koch LLC"

displayNamestring nullable

Name displayed for vendor e.g. "Doyle-Koch"

contactNamestring nullable

Name of the main contact for the vendor e.g. "John Smith"

contactTitlestring nullable

Title of the main contact for the vendor e.g. "Account Manager"

accountNumberstring nullable

Account number for the vendor e.g. "420042"

phonestring nullable

Phone number e.g. "281-381-4241"

mobilestring nullable

Mobile number e.g. "786-258-0182"

faxstring nullable

Fax number e.g. "281-381-4255"

emailstring nullable

Email address for the vendor e.g. "doyle-koch@email.com"

websitestring nullable

Vendor website e.g. "https://www.doylekoch.com"

addressstring nullable

First line of vendor address e.g. "708 Woodland Avenue"

addressLine2string nullable

Vendor address line 2 e.g. "Unit 105"

citystring nullable

City of the address e.g. "St Paul"

statestring nullable

Vendor state address e.g. "Alaska"

countrystring nullable

Country of the address

e.g. "United States"

postalCodestring nullable

Postal code of the address

e.g. "99660"

currencystring nullable

Currency code used by vendor e.g. "USD"

balanceinteger nullable

Balance in ledger for vendor in cents e.g. 650000

bankAccountNamestring nullable

Bank account name associated with the vendor e.g. "Business Bank Account"

bankAccountNumberstring nullable

Bank acount number associated with the vendor e.g. "123654"

notesstring nullable

Additional note attached to vendor e.g. "Quality vendor"

taxTypestring nullable

Type of tax applied to vendor e.g. "Global"

isContractorboolean nullable

Whether the vendor is a contractor

activeboolean nullable

Whether the vendor is active

createdstring date-time nullable

Date of vendor account creation e.g. "2013-11-18T02:17:40.080Z"

modifiedstring date-time nullable

Date entry was last modified e.g. "2013-11-22T02:17:40.080Z"

termIdstring nullable

Reference to a Term object (payment terms) associated with this Vendor e.g. "1d80716b-427e-4cad-80c6-c4b3a18eb23d"

termDaysinteger nullable

The days value of the payment terms for this Vendor e.g. "15"

termTypestring nullable

The type of the payment terms for this Vendor e.g. "DAYSAFTERBILLDATE"

Example response

[
  {
    "id": "quickbooks-726",
    "integration": "quickbooks",
    "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
    "givenName": "Jane",
    "familyName": "Doe",
    "companyName": "Doyle-Koch LLC",
    "displayName": "Doyle-Koch",
    "contactName": "John Smith",
    "contactTitle": "Account Manager",
    "accountNumber": "420042",
    "phone": "281-381-4241",
    "mobile": "786-258-0182",
    "fax": "281-381-4255",
    "email": "doyle-koch@email.com",
    "website": "https://www.doylekoch.com",
    "address": "708 Woodland Avenue",
    "addressLine2": "Unit 105",
    "city": "St Paul",
    "state": "Alaska",
    "country": "United States",
    "postalCode": "99660",
    "currency": "USD",
    "balance": 650000,
    "bankAccountName": "Business Bank Account",
    "bankAccountNumber": "123654",
    "notes": "Quality vendor",
    "taxType": "Global",
    "isContractor": true,
    "active": true,
    "created": "2013-11-18T02:17:40.080Z",
    "modified": "2013-11-22T02:17:40.080Z",
    "termId": "1d80716b-427e-4cad-80c6-c4b3a18eb23d",
    "termType": "DAYSAFTERBILLDATE"
  }
]