JDBC Driver for FreshBooks

Build 23.0.8839

BillVendors

A Vendor will work with your business to provide goods or services with a Bill to be paid at a later date.

Table Specific Information

Insert

To insert, VendorName, CurrencyCode and Language fields are required. To insert BillVendors with multiple tax defaults, you can either insert an aggregate value into the TaxDefaults field, or use a temporary table. This section provides examples of both procedures.

You can insert BillVendors with multiple tax defaults using aggregates. For example:

Insert Into BillVendors (VendorName, CurrencyCode, Language, TaxDefaultsAggregate) Values ('Test23', 'INR', 'en', '[{\"system_taxid\":\"7620\"}]')

You can also insert Invoices with multiple line items using a temporary table.

The temporary table you are populating is dynamic and will be created at run time the first time you insert to it. Temporary tables are denoted by a # appearing in their name. When using a temporary table to insert, the temporary table must be named in the format of [TableName]#TEMP, where TableName is the name of the table you will be inserting to. For example:

INSERT INTO BillVendorsTaxDefaults#TEMP (SystemTaxId) VALUES ('23145')

Once your temporary table is populated, it is now time to insert to the actual table in FreshBooks. You can do this by performing an INSERT to the actual table and setting the name of the temporary table as a value for LinesAggregate. For example:

Insert INTO BillVendors (VendorName, CurrencyCode, Language, TaxDefaultsAggregate) Values ('Test23', 'INR', 'en',  BillVendorsTaxDefaults#TEMP)

Update

To update, the VendorId value is required in the WHERE clause. For example:
Update BillVendors set VendorName = 'testing' where VendorId = 16651

Delete

To delete, VendorId value is required in the WHERE clause.
DELETE from BillVendors where VendorId = '26157'

Columns

Name Type ReadOnly Description
VendorId [KEY] Integer True

Unique identifier for vendor

AccountNumber String False

Account number of the vendor

City String False

City of vendor

Country String False

Country of vendor

CreatedAt Datetime True

The vendor was created, YYYY-MM-DD HH:MM:SS format

CurrencyCode String False

Default three-letter currency code for vendor

Is1099 Boolean False

Set true if vendor is a 1099 contractor

Language String False

Two-letter language code, e.g. “en”

Note String True

Note

OutstandingBalanceAmount String True

The outstanding amount to be paid to the Vendor

OutstandingBalanceCode String True

Three-letter currency code

OverdueBalanceAmount String True

Overdue amount to be paid to the Vendor

OverdueBalanceCode String True

Three-letter currency code

Phone String False

Phone number

PostalCode String False

Postal code

PrimaryContactEmail String False

Vendor primary email

PrimaryContactFirstName String False

Vendor primary first name

PrimaryContactLastName String False

Vendor primary last name

Province String False

Province

Street String False

Street address

Street2 String False

Street address 2nd part

TaxDefaultsAggregate String False

Tax Defaults Aggregate

UpdatedAt Datetime True

Time of last modification to resource

VendorName String False

Vendor Name

VisState Integer True

Visibility state, possible values are 0, 1, 2

Website String False

Vendor website address

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839