Vendors

Download schema

deprecated

List vendors

GET

https://api.ledgerbee.com/api

/v1/vendors

x-api-key (header)

OAuth 2.0

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.

DEPRECATED — sunset on 2026-12-31 (RFC 8594; every response carries Deprecation/Sunset/Link headers). Migrate to the supplier endpoints under /api/v1/suppliers — identical shapes with supplier-named fields and SUPPLIER_* error codes.

Required Scope

suppliers-read

List vendors › Responses

List of vendors for the company

VendorResponse[]

VendorResponse

id

string · required

The unique identifier of the vendor

Example: 550e8400-e29b-41d4-a716-446655440000

vendorNumber

string · required

Vendor number

Example: V001

name

string · required

Name of the vendor

Example: Acme Supplies

vendorGroupId

string · required

Vendor group ID

Example: 550e8400-e29b-41d4-a716-446655440001

currency

string · required

Currency code

Example: DKK

status

string · enum · required

Vendor status

Enum values:

active

inactive

archived

Example: active

vendorGroupName

string

Vendor group name

Example: Domestic Vendors

email

string

Email address

Example: contact@acme-supplies.com

phone

string

Phone number

Example: +45 12345678

address

string

Street address

Example: 123 Main Street

city

string

City

Example: Copenhagen

postalCode

string

Postal code

Example: 2100

countryCode

string

Two-letter country code (ISO 3166-1 alpha-2)

Example: DK

vatNumber

string

VAT registration number

Example: DK12345678

attention

string

Attention field

Example: Accounts Payable

paymentTerms

number

Payment terms in days

Example: 30

openingBalance

number

Opening balance in the company base currency (signed: positive = we owe the vendor)

Example: 1000

deprecated

Create a vendor

POST

https://api.ledgerbee.com/api

/v1/vendors

x-api-key (header)

OAuth 2.0

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

suppliers-write

Create a vendor › Headers

x-api-idempotency-key

string · maxLength: 255

Optional idempotency key for safely retrying mutating requests.

Create a vendor › Request Body

CreateVendorRequest

vendorNumber

string · required

Unique vendor number

Example: V001

name

string · required

Vendor name

Example: Acme Supplies

vendorGroupId

string · required

Vendor group ID

Example: 550e8400-e29b-41d4-a716-446655440001

currency

string · pattern: ^[A-Za-z]{3}$ · required

The currency this vendor bills us in, ISO 4217 alpha-3.

Example: DKK

countryCode

string · required

Two-letter country code

Example: DK

CreateVendorContactRequest[] · minItems: 1 · maxItems: 50 · required

Contacts for the vendor. At least one contact with isDefault: true is required.

email

string

Email address

Example: contact@acme-supplies.com

phone

string

Phone number

Example: +45 12345678

address

string · maxLength: 255

Street address

Example: 123 Main Street

city

string

City

Example: Copenhagen

postalCode

string

Postal code

Example: 2100

vatNumber

string

VAT registration number

Example: DK12345678

attention

string

Attention field

Example: Accounts Payable

paymentTerms

number · min: 0

Payment terms in days

Example: 30

openingBalance

number

Opening balance in the company base currency, seeding payables that predate LedgerBee. Signed: positive = we owe the vendor, negative = a credit position.

Example: 1000

defaultAccountId

string

Default ledger account ID

Example: 550e8400-e29b-41d4-a716-446655440002

Create a vendor › Responses

Vendor created successfully

CreateVendorResponse

id

string · required

The unique identifier of the created vendor

Example: 550e8400-e29b-41d4-a716-446655440000

vendorNumber

string · required

Vendor number

Example: V001

POST/v1/vendors

curl https://api.ledgerbee.com/api/v1/vendors \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "vendorNumber": "V001",
  "name": "Acme Supplies",
  "vendorGroupId": "550e8400-e29b-41d4-a716-446655440001",
  "currency": "DKK",
  "countryCode": "DK",
  "email": "contact@acme-supplies.com",
  "phone": "+45 12345678",
  "address": "123 Main Street",
  "city": "Copenhagen",
  "postalCode": "2100",
  "vatNumber": "DK12345678",
  "attention": "Accounts Payable",
  "paymentTerms": 30,
  "openingBalance": 1000,
  "defaultAccountId": "550e8400-e29b-41d4-a716-446655440002",
  "contacts": [
    {
      "name": "John Doe",
      "email": "john.doe@acme-supplies.com",
      "phone": "+45 12345678",
      "isDefault": true
    }
  ]
}'

Example Request Body

{
  "vendorNumber": "V001",
  "name": "Acme Supplies",
  "vendorGroupId": "550e8400-e29b-41d4-a716-446655440001",
  "currency": "DKK",
  "countryCode": "DK",
  "email": "contact@acme-supplies.com",
  "phone": "+45 12345678",
  "address": "123 Main Street",
  "city": "Copenhagen",
  "postalCode": "2100",
  "vatNumber": "DK12345678",
  "attention": "Accounts Payable",
  "paymentTerms": 30,
  "openingBalance": 1000,
  "defaultAccountId": "550e8400-e29b-41d4-a716-446655440002",
  "contacts": [
    {
      "name": "John Doe",
      "email": "john.doe@acme-supplies.com",
      "phone": "+45 12345678",
      "isDefault": true
    }
  ]
}

json

application/json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "vendorNumber": "V001"
}

json

application/json

deprecated

List vendor contacts

GET

https://api.ledgerbee.com/api

/v1/vendors/{vendorId}/contacts

x-api-key (header)

OAuth 2.0

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

suppliers-read

List vendor contacts › path Parameters

vendorId

string · required

Vendor ID

List vendor contacts › Responses

List of contacts for a vendor

VendorContactResponse[]

VendorContactResponse

id

string · required

The unique identifier of the contact

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · required

Name of the contact

Example: John Doe

isDefaultForVendor

boolean · required

Whether this is the default contact for the vendor

Example: true

email

string

Email address

Example: john.doe@acme-supplies.com

phone

string

Phone number

Example: +45 12345678

deprecated

List vendor departments

GET

https://api.ledgerbee.com/api

/v1/vendors/{vendorId}/departments

x-api-key (header)

OAuth 2.0

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

suppliers-read

List vendor departments › path Parameters

vendorId

string · required

Vendor ID

List vendor departments › Responses

List of departments for a vendor

VendorDepartmentResponse[]

VendorDepartmentResponse

id

string · required

The unique identifier of the department

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · required

Name of the department

Example: Headquarters

isDefault

boolean · required

Whether this is the default department for the vendor

Example: true

isActive

boolean · required

Whether the department is active

Example: true

poNumber

string

Purchase order number

Example: PO-12345

eanNumber

string

EAN number for e-invoicing

Example: 5790000000000

address

string

Street address

Example: 123 Main Street

city

string

City

Example: Copenhagen

postalCode

string

Postal code

Example: 2100

countryCode

string

Two-letter country code (ISO 3166-1 alpha-2)

Example: DK

deprecated

List vendor groups

GET

https://api.ledgerbee.com/api

/v1/vendors/groups

x-api-key (header)

OAuth 2.0

Retrieves all vendor groups for your company, sorted alphabetically by name.

The list is cached for 5 seconds.

Required Scope

suppliers-read

List vendor groups › Responses

List of vendor groups for the company

VendorGroupResponse[]

VendorGroupResponse

id

string · required

The unique identifier of the vendor group

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · required

Name of the vendor group

Example: Domestic Vendors

description

string

Description of the vendor group

Example: All domestic vendor accounts

defaultAccountId

string

Default ledger account ID

Example: 550e8400-e29b-41d4-a716-446655440001

VAT Codes Webhook Endpoints

LedgerBee Public API

Vendors

Download schema

deprecated

List vendors

GET

https://api.ledgerbee.com/api

/v1/vendors

x-api-key (header)

OAuth 2.0

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

suppliers-read

List vendors › Responses

List of vendors for the company

VendorResponse[]

VendorResponse

id

string · required

The unique identifier of the vendor

Example: 550e8400-e29b-41d4-a716-446655440000

vendorNumber

string · required

Vendor number

Example: V001

name

string · required

Name of the vendor

Example: Acme Supplies

vendorGroupId

string · required

Vendor group ID

Example: 550e8400-e29b-41d4-a716-446655440001

currency

string · required

Currency code

Example: DKK

status

string · enum · required

Vendor status

Enum values:

active

inactive

archived

Example: active

vendorGroupName

string

Vendor group name

Example: Domestic Vendors

email

string

Email address

Example: contact@acme-supplies.com

phone

string

Phone number

Example: +45 12345678

address

string

Street address

Example: 123 Main Street

city

string

City

Example: Copenhagen

postalCode

string

Postal code

Example: 2100

countryCode

string

Two-letter country code (ISO 3166-1 alpha-2)

Example: DK

vatNumber

string

VAT registration number

Example: DK12345678

attention

string

Attention field

Example: Accounts Payable

paymentTerms

number

Payment terms in days

Example: 30

openingBalance

number

Opening balance in the company base currency (signed: positive = we owe the vendor)

Example: 1000

deprecated

Create a vendor

POST

https://api.ledgerbee.com/api

/v1/vendors

x-api-key (header)

OAuth 2.0

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.

The response contains only the new vendor's id and vendorNumber; fetch the full record via the list endpoint.

Required Scope

suppliers-write

Create a vendor › Headers

x-api-idempotency-key

string · maxLength: 255

Optional idempotency key for safely retrying mutating requests.

Create a vendor › Request Body

CreateVendorRequest

vendorNumber

string · required

Unique vendor number

Example: V001

name

string · required

Vendor name

Example: Acme Supplies

vendorGroupId

string · required

Vendor group ID

Example: 550e8400-e29b-41d4-a716-446655440001

currency

string · pattern: ^[A-Za-z]{3}$ · required

The currency this vendor bills us in, ISO 4217 alpha-3.

Example: DKK

countryCode

string · required

Two-letter country code

Example: DK

CreateVendorContactRequest[] · minItems: 1 · maxItems: 50 · required

Contacts for the vendor. At least one contact with isDefault: true is required.

email

string

Email address

Example: contact@acme-supplies.com

phone

string

Phone number

Example: +45 12345678

address

string · maxLength: 255

Street address

Example: 123 Main Street

city

string

City

Example: Copenhagen

postalCode

string

Postal code

Example: 2100

vatNumber

string

VAT registration number

Example: DK12345678

attention

string

Attention field

Example: Accounts Payable

paymentTerms

number · min: 0

Payment terms in days

Example: 30

openingBalance

number

Opening balance in the company base currency, seeding payables that predate LedgerBee. Signed: positive = we owe the vendor, negative = a credit position.

Example: 1000

defaultAccountId

string

Default ledger account ID

Example: 550e8400-e29b-41d4-a716-446655440002

Create a vendor › Responses

Vendor created successfully

CreateVendorResponse

id

string · required

The unique identifier of the created vendor

Example: 550e8400-e29b-41d4-a716-446655440000

vendorNumber

string · required

Vendor number

Example: V001

POST/v1/vendors

curl https://api.ledgerbee.com/api/v1/vendors \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "vendorNumber": "V001",
  "name": "Acme Supplies",
  "vendorGroupId": "550e8400-e29b-41d4-a716-446655440001",
  "currency": "DKK",
  "countryCode": "DK",
  "email": "contact@acme-supplies.com",
  "phone": "+45 12345678",
  "address": "123 Main Street",
  "city": "Copenhagen",
  "postalCode": "2100",
  "vatNumber": "DK12345678",
  "attention": "Accounts Payable",
  "paymentTerms": 30,
  "openingBalance": 1000,
  "defaultAccountId": "550e8400-e29b-41d4-a716-446655440002",
  "contacts": [
    {
      "name": "John Doe",
      "email": "john.doe@acme-supplies.com",
      "phone": "+45 12345678",
      "isDefault": true
    }
  ]
}'

Example Request Body

{
  "vendorNumber": "V001",
  "name": "Acme Supplies",
  "vendorGroupId": "550e8400-e29b-41d4-a716-446655440001",
  "currency": "DKK",
  "countryCode": "DK",
  "email": "contact@acme-supplies.com",
  "phone": "+45 12345678",
  "address": "123 Main Street",
  "city": "Copenhagen",
  "postalCode": "2100",
  "vatNumber": "DK12345678",
  "attention": "Accounts Payable",
  "paymentTerms": 30,
  "openingBalance": 1000,
  "defaultAccountId": "550e8400-e29b-41d4-a716-446655440002",
  "contacts": [
    {
      "name": "John Doe",
      "email": "john.doe@acme-supplies.com",
      "phone": "+45 12345678",
      "isDefault": true
    }
  ]
}

json

application/json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "vendorNumber": "V001"
}

json

application/json

deprecated

List vendor contacts

GET

https://api.ledgerbee.com/api

/v1/vendors/{vendorId}/contacts

x-api-key (header)

OAuth 2.0

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

suppliers-read

List vendor contacts › path Parameters

vendorId

string · required

Vendor ID

List vendor contacts › Responses

List of contacts for a vendor

VendorContactResponse[]

VendorContactResponse

id

string · required

The unique identifier of the contact

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · required

Name of the contact

Example: John Doe

isDefaultForVendor

boolean · required

Whether this is the default contact for the vendor

Example: true

email

string

Email address

Example: john.doe@acme-supplies.com

phone

string

Phone number

Example: +45 12345678

deprecated

List vendor departments

GET

https://api.ledgerbee.com/api

/v1/vendors/{vendorId}/departments

x-api-key (header)

OAuth 2.0

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

suppliers-read

List vendor departments › path Parameters

vendorId

string · required

Vendor ID

List vendor departments › Responses

List of departments for a vendor

VendorDepartmentResponse[]

VendorDepartmentResponse

id

string · required

The unique identifier of the department

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · required

Name of the department

Example: Headquarters

isDefault

boolean · required

Whether this is the default department for the vendor

Example: true

isActive

boolean · required

Whether the department is active

Example: true

poNumber

string

Purchase order number

Example: PO-12345

eanNumber

string

EAN number for e-invoicing

Example: 5790000000000

address

string

Street address

Example: 123 Main Street

city

string

City

Example: Copenhagen

postalCode

string

Postal code

Example: 2100

countryCode

string

Two-letter country code (ISO 3166-1 alpha-2)

Example: DK

deprecated

List vendor groups

GET

https://api.ledgerbee.com/api

/v1/vendors/groups

x-api-key (header)

OAuth 2.0

Retrieves all vendor groups for your company, sorted alphabetically by name.

The list is cached for 5 seconds.

Required Scope

suppliers-read

List vendor groups › Responses

List of vendor groups for the company

VendorGroupResponse[]

VendorGroupResponse

id

string · required

The unique identifier of the vendor group

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · required

Name of the vendor group

Example: Domestic Vendors

description

string

Description of the vendor group

Example: All domestic vendor accounts

defaultAccountId

string

Default ledger account ID

Example: 550e8400-e29b-41d4-a716-446655440001

VAT Codes Webhook Endpoints