Skip to main content
A Vendor of a business can send bills and have payments applied to their bills. Vendors can be referenced when creating bills using either the Layer id, or the external id.

Attributes

string
required
Unique identifier for the vendor.
string
Unique ID of the vendor in your system for linking and idempotency.
string
Full name of the individual vendor or contact at a corporate vendor.
string
Name of the company vendor.
string
Email address of the vendor.
string
Mobile phone number of the vendor.
string
Office phone number of the vendor.
string
Full address of the vendor.
enum
Status of the vendor. Possible values are: ACTIVE, ARCHIVED Archived vendors will not appear when listing vendors, but their accounting continues to be tracked and they can still be retrieved directly in the API.
Array of Tags
string
Memo for any text you would like to associate with the vendor (for example, to display to end users).
object
Arbitrary custom metadata in JSON format with a size limit of 1KB.
string
Any (typically user-visible) identifier you would like to associate with the vendor. Can be used to filter when listing vendors.