Vendors
Stores vendor records including contact details, payment terms, and tax information, forming the master list of suppliers for QuickBooks Online.
Columns
| Name | Type | ReadOnly | References | Filterable | Sortable | Description |
| Id [KEY] | String | True | True | True |
The unique identifier (Id) that is assigned by QuickBooks Online to this vendor record. It is required to retrieve or reference the vendor programmatically and for updates or deletions. | |
| SyncToken | String | True | False | False |
The version control token for this vendor record that is used to prevent conflicting updates. QuickBooks Online increments this sync token each time the vendor record is modified, and only the latest sync token is accepted for edits. | |
| MetaData_CreateTime | Datetime | False | True | True |
The date and time stamp (Coordinated Universal Time) for when QuickBooks Online created this vendor record. | |
| MetaData_LastUpdatedTime | Datetime | False | True | True |
The date and time stamp (Coordinated Universal Time) for when this vendor record was last modified in QuickBooks Online. | |
| Title | String | False | False | False |
The title of the individual associated with this vendor (for example, Mr., Ms., Dr.). | |
| GivenName | String | False | True | True |
The given name or first name of the individual associated with this vendor. | |
| MiddleName | String | False | True | True |
The middle name of the individual associated with this vendor. | |
| FamilyName | String | False | True | True |
The family name or last name of the individual associated with this vendor. | |
| Suffix | String | False | False | False |
The suffix that is appended to the name of the individual associated with this vendor (for example, Jr., Sr., III). | |
| DisplayName | String | False | True | True |
The display name of the vendor as it appears in QuickBooks Online. This name is the primary name used in lookups and on forms. | |
| CompanyName | String | False | True | True |
The name of the company or organization that is associated with this vendor. | |
| PrintOnCheckName | String | False | True | True |
The name of the person or organization as it appears on printed checks that are issued to this vendor. | |
| Active | Boolean | False | True | False |
Indicates whether this vendor record is currently active (true) or inactive (false) in QuickBooks Online. Inactive vendors are hidden from most transaction lists but retained for historical purposes. | |
| PrimaryPhone_FreeFormNumber | String | False | False | False |
The primary telephone number for contacting the vendor. | |
| AlternatePhone_FreeFormNumber | String | False | False | False |
An alternate telephone number for contacting the vendor. | |
| Mobile_FreeFormNumber | String | False | False | False |
The mobile telephone number for contacting the vendor. | |
| Fax_FreeFormNumber | String | False | False | False |
The fax number for contacting the vendor. | |
| PrimaryEmailAddr_Address | String | False | False | False |
The primary email address of the vendor. This address is used for sending purchase orders or other communications, if enabled. | |
| WebAddr_URI | String | False | False | False |
The website Uniform Resource Locater (URL) for the vendor or their organization. | |
| BillAddr_Id | String | False | False | False |
The unique Id of the billing-address entity for this vendor, mainly used for modifying the address. This field is assigned by the QuickBooks Online data service. | |
| BillAddr_Line1 | String | False | False | False |
The first line of the vendor's billing address. | |
| BillAddr_Line2 | String | False | False | False |
The second line of the vendor's billing address. | |
| BillAddr_Line3 | String | False | False | False |
The third line of the vendor's billing address. | |
| BillAddr_Line4 | String | False | False | False |
The fourth line of the vendor's billing address. | |
| BillAddr_Line5 | String | False | False | False |
The fifth line of the vendor's billing address. | |
| BillAddr_City | String | False | False | False |
The city portion of the vendor's billing address. | |
| BillAddr_Country | String | False | False | False |
The country portion of the vendor's billing address. | |
| BillAddr_CountrySubDivisionCode | String | False | False | False |
The region within a country for the vendor's billing address. For example, this value is the state name for the USA and the province name for Canada. | |
| BillAddr_PostalCode | String | False | False | False |
The postal code for the vendor's billing address. For example, this value is the ZIP code for the USA and the postal code for Canada. | |
| BillAddr_Lat | String | False | False | False |
The latitude coordinate of the geocoded billing address for this vendor. | |
| BillAddr_Long | String | False | False | False |
The longitude coordinate of the geocoded billing address for this vendor. | |
| OtherContactInfo_Type | String | False | False | False |
Specifies the type of other contact information (for example, social-media handle, secondary email, or alternate phone). | |
| OtherContactInfo_Telephone_FreeFormNumber | String | False | False | False |
The telephone number that is associated with the type of contact information that is defined in the OtherContactInfo_Type parameter. | |
| TaxIdentifier | String | False | False | False |
The tax identification number (TIN) of the vendor (such as a business tax number or social security number) used for compliance and reporting purposes. | |
| TermRef | String | False |
Terms.Id | False | False |
The unique Id of the payment term that is associated with this vendor. This Id determines the due date and discount structure for bills from this vendor. |
| TermRef_Name | String | True |
Terms.Name | False | False |
The display name of the payment term that is associated with this vendor. |
| Balance | String | False | True | True |
The amount the company currently owes to this vendor. For create operations, this represents the opening balance or unpaid amount for the vendor. When returned in response to a query, it represents the current open balance or unpaid amount for that vendor. | |
| AcctNum | String | False | False | False |
The vendor's account number or name with your organization. This account information can be used to match internal systems with QuickBooks Online vendor records. | |
| Vendor1099 | Boolean | False | False | False |
Indicates whether this vendor is an independent contractor who should receive a 1099-MISC form at year end. A 1099 vendor is paid with regular checks and taxes are not withheld on their behalf. | |
| CurrencyRef | String | False | False | False |
The unique Id of the currency that is used in all business transactions created for or received from this vendor. | |
| CurrencyRef_Name | String | True | False | False |
The display name of the currency that is used in all business transactions created for or received from this vendor. | |
| APAccountRef | String | False |
Accounts.Id | False | False |
The unique Id of the accounts-payable liability account that is used for this supplier. When this Id is specified, the account must be a Liability account with a subtype of Payables. |
| APAccountRef_Name | String | True |
Accounts.Name | False | False |
The display name of the accounts-payable liability account used for this supplier. When this name is specified, the account must be a Liability account with a subtype of Payables. |
| Source | String | False | False | False |
The source type of the transactions that is created by QuickBooks Commerce for this vendor (for example, imported from an external system). The allowed values are QBCommerce. | |
| GSTIN | String | False | False | False |
The Goods and Services Tax Identification Number (GSTIN) that is assigned to every GST-registered business. This field is used only for India region. | |
| T4AEligible | Boolean | False | False | False |
Indicates whether the vendor is T4A eligible. This field is valid for the CA locale and determines whether T4A tax slips should be issued. | |
| T5018Eligible | Boolean | False | False | False |
Indicates whether the vendor is T5018 eligible. This field is valid for the CA locale and determines whether T5018 tax slips should be issued. | |
| HasTPAR | Boolean | False | False | False |
Indicates whether this vendor has Taxable Payments Annual Report (TPAR) enabled. TPAR is required by the Australian Taxation Office (ATO). | |
| BusinessNumber | String | False | False | False |
A code that is also the Permanent Tax Number (PAN) in India. This code acts as an identification for individuals, families, and corporations, especially for those who pay taxes on their income. | |
| GSTRegistrationType | String | False | False | False |
Specifies the GST registration type for this vendor. For filing of GSTR, transactions need to be classified depending on the type of customer to whom the sale is done. The allowed values are GST_REG_REG, GST_REG_COMP, GST_UNREG, CONSUMER, OVERSEAS, SEZ, DEEMED. | |
| CostRate | Decimal | False | False | False |
The pay rate for this vendor. Typically, this rate is the cost rate you incur for their services. | |
| BillRate | Decimal | False | False | False |
The hourly billing rate that is set for this vendor when their services are billed to customers. | |
| TaxReportingBasis | String | False | False | False |
The method by which this supplier tracks their income for tax reporting purposes. This field is applicable for French companies only. | |
| VendorPaymentBankDetail_BankAccountName | String | False | False | False |
The name on the bank account for payments to this vendor. Required if the VendorPaymentBankDetail information is present in the request. | |
| VendorPaymentBankDetail_BankBranchIdentifier | String | False | False | False |
The bank branch Id that is used to identify the bank branch (a 6-digit value in the format xxx-xxx). This Id is required if VendorPaymentBankDetail information is present in the request. | |
| VendorPaymentBankDetail_BankAccountNumber | String | False | False | False |
The vendor's bank account number for payments. This account number is required if VendorPaymentBankDetail information is present in the request. In response, the value is masked and only the last four digits are returned. | |
| VendorPaymentBankDetail_StatementText | String | False | False | False |
The text, note, or comment for the remittance statement that accompanies a payment to this vendor. |