Vendors

Vendors
An individual or business that provides goods or services.

FieldTypeDescription
externalIdstringFriendly reference of the vendor/reference of vendor from an external system
idstringIdentifier for the vendor, unique to the company in the accounting platform.
namestringName of the vendor as recorded in the accounting system, typically the company name.
activebooleanCurrent state of the vendor
creditLimitnumberCurrent credit limit available from the vendor.
descriptionstringAny additional information about the vendor
webSitestringWeb address of the vendor.
accountstringThe account linked to the vendor in the accounting system.
createdDatedateDate the record was created in the accounting system.
currencystringCurrency in which the transactions are made with vendor
modifiedDatedateDate the record was last updated in the accounting system.
totalOutstandingAmountnumberAmount paid to the vendor across all transactions.
bankAccountNumberstringBank Account Number of the vendor to which payments are made.
languagestringLanguage the vendor transacts in
typestringType of the vendor i.e. Primary, alternate etc
corporateAddressobjectAn object of corporate addresses
contactobjectAn object of contact
billingAddressobjectAn object of billing addresses
shippingAddressobjectAn object of shipping addresses
paymentTermsobjectAn object of payment terms applicable to the customer
parentobjectAn object of the parent company of the vendor. Recorded only if the parent company is also a vendor.
subsidiaryobjectAn object of the subsidiary company of the vendor. Recorded only if the subsidiary company is also a vendor.

corporateAddress

FieldTypeDescription
corporateAddress.idstringIdentifier of vendor's corporate address in accounting system
corporateAddress.citystringCity of vendor's corporate address
corporateAddress.countrystringCountry of vendor's corporate address
corporateAddress.line1stringAddress line1 of vendor's corporate address
corporateAddress.line2stringAddress line2 of vendor's corporate address
corporateAddress.phonestringPhone number of vendor's corporate address
corporateAddress.postalCodestringPostal code of vendor's corporate address
corporateAddress.provincestringProvince/State of vendor's corporate address

contact

FieldTypeDescription
contact.address.citystringCity of primary contact at vendor
contact.address.countrystringCountry of primary contact at vendor
contact.address.line1stringAddress line1 of primary contact at vendor
contact.address.line2stringAddress line2 of primary contact at vendor
contact.address.postalCodestringPostal code of primary contact at vendor
contact.address.provincestringProvince/State of primary contact at vendor
contact.emailstringEmail ID of primary contact at vendor
contact.faxstringFax of primary contact at vendor
contact.firstNamestringFirst name of primary contact at vendor
contact.lastNamestringLast name of primary contact at vendor
contact.middleNamestringMiddle name of primary contact at vendor
contact.mobilenumberMobile number of primary contact at vendor
contact.phonestringPhone number of primary contact at vendor
contact.salutationstringSalutation of primary contact at vendor

billingAddress

FieldTypeDescription
billingAddress.citystringCity of vendor's billing address
billingAddress.countrystringCountry of vendor's billing address
billingAddress.contact.firstNamestringFirst name of contact at vendor's billing address
billingAddress.idstringIdentifier of vendor's billing address in accounting system
billingAddress.contact.lastNamestringLast name of contact at vendor's billing address
billingAddress.line1stringAddress line1 of vendor's billing address
billingAddress.line2stringAddress line2 of vendor's billing address
billingAddress.contact.middleNamestringMiddle name of contact at vendor's billing address
billingAddress.postalCodestringPostal code of vendor's billing address
billingAddress.provincestringProvince of vendor's billing address
billingAddress.contact.emailstringEmail of contact at vendor's billing address
billingAddress.phonestringPhone number of vendor's billing address

shippingAddress

FieldTypeDescription
shippingAddress.citystringCity of vendor's shipping address
shippingAddress.countrystringCountry of vendor's shipping address
shippingAddress.contact.firstNamestringFirst name of contact at vendor's shipping address
shippingAddress.idstringIdentifier of vendor's shipping address in accounting system
shippingAddress.contact.lastNamestringLast name of contact at vendor's billing address
shippingAddress.line1stringAddress line1 of vendor's shipping address
shippingAddress.line2stringAddress line2 of vendor's shipping address
shippingAddress.contact.middleNamestringMiddle name of contact at vendor's billing address
shippingAddress.phonestringPhone number of vendor's shipping address
shippingAddress.postalCodestringPostal code of vendor's shipping address
shippingAddress.provincestringProvince of vendor's shipping address
shippingAddress.contact.emailstringEmail of contact at vendor's shipping address

parent

FieldTypeDescription
parent.idstringIdentifier of the parent company of the vendor.
parent.namestringName of the parent company of the vendor.

subsidiary

FieldTypeDescription
subsidiary.idstringIdentifier of the subsidiary company of the vendor.
subsidiary.namestringName of the subsidiary company of the vendor.