Vendors
An individual or business that provides goods or services.
Field | Type | Description |
externalId | string | Friendly reference of the vendor/reference of vendor from an external system |
id | string | Identifier for the vendor, unique to the company in the accounting platform. |
name | string | Name of the vendor as recorded in the accounting system, typically the company name. |
active | boolean | Current state of the vendor |
creditLimit | number | Current credit limit available from the vendor. |
description | string | Any additional information about the vendor |
webSite | string | Web address of the vendor. |
account | string | The account linked to the vendor in the accounting system. |
createdDate | date | Date the record was created in the accounting system. |
currency | string | Currency in which the transactions are made with vendor |
modifiedDate | date | Date the record was last updated in the accounting system. |
totalOutstandingAmount | number | Amount paid to the vendor across all transactions. |
bankAccountNumber | string | Bank Account Number of the vendor to which payments are made. |
language | string | Language the vendor transacts in |
type | string | Type of the vendor i.e. Primary, alternate etc |
corporateAddress | object | An object of corporate addresses |
contact | object | An object of contact |
billingAddress | object | An object of billing addresses |
shippingAddress | object | An object of shipping addresses |
paymentTerms | object | An object of payment terms applicable to the customer |
parent | object | An object of the parent company of the vendor. Recorded only if the parent company is also a vendor. |
subsidiary | object | An object of the subsidiary company of the vendor. Recorded only if the subsidiary company is also a vendor. |
corporateAddress
Field | Type | Description |
corporateAddress.id | string | Identifier of vendor's corporate address in accounting system |
corporateAddress.city | string | City of vendor's corporate address |
corporateAddress.country | string | Country of vendor's corporate address |
corporateAddress.line1 | string | Address line1 of vendor's corporate address |
corporateAddress.line2 | string | Address line2 of vendor's corporate address |
corporateAddress.phone | string | Phone number of vendor's corporate address |
corporateAddress.postalCode | string | Postal code of vendor's corporate address |
corporateAddress.province | string | Province/State of vendor's corporate address |
contact
Field | Type | Description |
contact.address.city | string | City of primary contact at vendor |
contact.address.country | string | Country of primary contact at vendor |
contact.address.line1 | string | Address line1 of primary contact at vendor |
contact.address.line2 | string | Address line2 of primary contact at vendor |
contact.address.postalCode | string | Postal code of primary contact at vendor |
contact.address.province | string | Province/State of primary contact at vendor |
contact.email | string | Email ID of primary contact at vendor |
contact.fax | string | Fax of primary contact at vendor |
contact.firstName | string | First name of primary contact at vendor |
contact.lastName | string | Last name of primary contact at vendor |
contact.middleName | string | Middle name of primary contact at vendor |
contact.mobile | number | Mobile number of primary contact at vendor |
contact.phone | string | Phone number of primary contact at vendor |
contact.salutation | string | Salutation of primary contact at vendor |
billingAddress
Field | Type | Description |
billingAddress.city | string | City of vendor's billing address |
billingAddress.country | string | Country of vendor's billing address |
billingAddress.contact.firstName | string | First name of contact at vendor's billing address |
billingAddress.id | string | Identifier of vendor's billing address in accounting system |
billingAddress.contact.lastName | string | Last name of contact at vendor's billing address |
billingAddress.line1 | string | Address line1 of vendor's billing address |
billingAddress.line2 | string | Address line2 of vendor's billing address |
billingAddress.contact.middleName | string | Middle name of contact at vendor's billing address |
billingAddress.postalCode | string | Postal code of vendor's billing address |
billingAddress.province | string | Province of vendor's billing address |
billingAddress.contact.email | string | Email of contact at vendor's billing address |
billingAddress.phone | string | Phone number of vendor's billing address |
shippingAddress
Field | Type | Description |
shippingAddress.city | string | City of vendor's shipping address |
shippingAddress.country | string | Country of vendor's shipping address |
shippingAddress.contact.firstName | string | First name of contact at vendor's shipping address |
shippingAddress.id | string | Identifier of vendor's shipping address in accounting system |
shippingAddress.contact.lastName | string | Last name of contact at vendor's billing address |
shippingAddress.line1 | string | Address line1 of vendor's shipping address |
shippingAddress.line2 | string | Address line2 of vendor's shipping address |
shippingAddress.contact.middleName | string | Middle name of contact at vendor's billing address |
shippingAddress.phone | string | Phone number of vendor's shipping address |
shippingAddress.postalCode | string | Postal code of vendor's shipping address |
shippingAddress.province | string | Province of vendor's shipping address |
shippingAddress.contact.email | string | Email of contact at vendor's shipping address |
parent
Field | Type | Description |
parent.id | string | Identifier of the parent company of the vendor. |
parent.name | string | Name of the parent company of the vendor. |
subsidiary
Field | Type | Description |
subsidiary.id | string | Identifier of the subsidiary company of the vendor. |
subsidiary.name | string | Name of the subsidiary company of the vendor. |