Vendors
List vendors
Retrieves all vendors for your company, sorted by vendor number.
The list is cached for 5 seconds; creating a vendor through this API invalidates the cache, so a just-created vendor is immediately visible.
Required Scope
vendors-read
List vendors › Responses
List of vendors for the company
idThe unique identifier of the vendor
vendorNumberVendor number
nameName of the vendor
vendorGroupIdVendor group ID
currencyCurrency code
statusVendor status
vendorGroupNameVendor group name
emailEmail address
phonePhone number
addressStreet address
cityCity
postalCodePostal code
countryCodeTwo-letter country code (ISO 3166-1 alpha-2)
vatNumberVAT registration number
attentionAttention field
paymentTermsPayment terms in days
openingBalanceOpening balance in the company base currency (signed: positive = we owe the vendor)
Create a vendor
Creates a vendor together with its contacts.
vendorNumber is trimmed and must be unique within your company — a
duplicate returns 400 with error code VENDOR_NUMBER_ALREADY_EXISTS.
Exactly one contact must be marked as default. When you provide a single
contact it is made the default automatically; otherwise a missing or
duplicated default returns 400 with error code CONTACT_DEFAULT_REQUIRED
or CONTACT_MULTIPLE_DEFAULTS.
vendorGroupId must reference an existing vendor group in your company
(404 VENDOR_GROUP_NOT_FOUND), and defaultAccountId, when provided,
must reference an existing ledger account (404 LEDGER_NOT_FOUND).
The response contains only the new vendor's id and vendorNumber;
fetch the full record via the list endpoint.
Required Scope
vendors-write
Create a vendor › Request Body
vendorNumberUnique vendor number
nameVendor name
vendorGroupIdVendor group ID
currencyCurrency code
countryCodeTwo-letter country code
Contacts for the vendor. At least one contact with isDefault: true is required.
emailEmail address
phonePhone number
addressStreet address
cityCity
postalCodePostal code
vatNumberVAT registration number
attentionAttention field
paymentTermsPayment terms in days
openingBalanceOpening balance in the company base currency, seeding payables that predate LedgerBee. Signed: positive = we owe the vendor, negative = a credit position.
defaultAccountIdDefault ledger account ID
Create a vendor › Responses
Vendor created successfully
idThe unique identifier of the created vendor
vendorNumberVendor number
List vendor contacts
Retrieves all contacts for a vendor, with the default contact first and the rest sorted alphabetically by name.
Returns 404 with error code VENDOR_NOT_FOUND when the vendor does not
exist in your company.
Required Scope
vendors-read
path Parameters
vendorIdVendor ID
List vendor contacts › Responses
List of contacts for a vendor
idThe unique identifier of the contact
nameName of the contact
isDefaultForVendorWhether this is the default contact for the vendor
emailEmail address
phonePhone number
List vendor departments
Retrieves all departments for a vendor, with the default department first and the rest sorted alphabetically by name.
Returns 404 with error code VENDOR_NOT_FOUND when the vendor does not
exist in your company.
Required Scope
vendors-read
path Parameters
vendorIdVendor ID
List vendor departments › Responses
List of departments for a vendor
idThe unique identifier of the department
nameName of the department
isDefaultWhether this is the default department for the vendor
isActiveWhether the department is active
poNumberPurchase order number
eanNumberEAN number for e-invoicing
addressStreet address
cityCity
postalCodePostal code
countryCodeTwo-letter country code (ISO 3166-1 alpha-2)
List vendor groups
Retrieves all vendor groups for your company, sorted alphabetically by name.
The list is cached for 5 seconds.
Required Scope
vendors-read
List vendor groups › Responses
List of vendor groups for the company
idThe unique identifier of the vendor group
nameName of the vendor group
descriptionDescription of the vendor group
defaultAccountIdDefault ledger account ID