Suppliers

List suppliers

GET

https://api.ledgerbee.com/api

/v1/suppliers

x-api-key (header)

OAuth 2.0

Retrieves all suppliers for your company, sorted by supplier number.

The list is cached for 5 seconds; creating a supplier through this API invalidates the cache, so a just-created supplier is immediately visible.

Required Scope

suppliers-read

List suppliers › Responses

List of suppliers for the company

SupplierResponse[]

SupplierResponse

id

string · required

The unique identifier of the supplier

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

supplierNumber

string · required

Supplier number

Example: V001

name

string · required

Name of the supplier

Example: Acme Supplies

supplierGroupId

string · required

Supplier group ID

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

currency

string · required

Currency code

Example: DKK

status

string · enum · required

Supplier status

Enum values:

active

inactive

archived

Example: active

supplierGroupName

string

Supplier group name

Example: Domestic Suppliers

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 supplier)

Example: 1000

Create a supplier

POST

https://api.ledgerbee.com/api

/v1/suppliers

x-api-key (header)

OAuth 2.0

Creates a supplier together with its contacts.

supplierNumber is trimmed and must be unique within your company — a duplicate returns 400 with error code SUPPLIER_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.

supplierGroupId must reference an existing supplier group in your company (404 SUPPLIER_GROUP_NOT_FOUND), and defaultAccountId, when provided, must reference an existing ledger account (404 LEDGER_NOT_FOUND).

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

Required Scope

suppliers-write

Create a supplier › Headers

x-api-idempotency-key

string · maxLength: 255

Optional idempotency key for safely retrying mutating requests.

Create a supplier › Request Body

CreateSupplierRequest

supplierNumber

string · required

Unique supplier number

Example: V001

name

string · required

Supplier name

Example: Acme Supplies

supplierGroupId

string · required

Supplier group ID

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

currency

string · minLength: 3 · maxLength: 3 · required

Currency code

Example: DKK

countryCode

string · required

Two-letter country code

Example: DK

CreateSupplierContactRequest[] · required

Contacts for the supplier. 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 supplier, negative = a credit position.

Example: 1000

defaultAccountId

string

Default ledger account ID

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

Create a supplier › Responses

Supplier created successfully

CreateSupplierResponse

id

string · required

The unique identifier of the created supplier

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

supplierNumber

string · required

Supplier number

Example: V001

POST/v1/suppliers

curl https://api.ledgerbee.com/api/v1/suppliers \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "supplierNumber": "V001",
  "name": "Acme Supplies",
  "supplierGroupId": "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

{
  "supplierNumber": "V001",
  "name": "Acme Supplies",
  "supplierGroupId": "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",
  "supplierNumber": "V001"
}

json

application/json

List supplier contacts

GET

https://api.ledgerbee.com/api

/v1/suppliers/{supplierId}/contacts

x-api-key (header)

OAuth 2.0

Retrieves all contacts for a supplier, with the default contact first and the rest sorted alphabetically by name.

Returns 404 with error code SUPPLIER_NOT_FOUND when the supplier does not exist in your company.

Required Scope

suppliers-read

List supplier contacts › path Parameters

supplierId

string · required

Supplier ID

List supplier contacts › Responses

List of contacts for a supplier

SupplierContactResponse[]

SupplierContactResponse

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

isDefaultForSupplier

boolean · required

Whether this is the default contact for the supplier

Example: true

email

string

Email address

Example: john.doe@acme-supplies.com

phone

string

Phone number

Example: +45 12345678

List supplier departments

GET

https://api.ledgerbee.com/api

/v1/suppliers/{supplierId}/departments

x-api-key (header)

OAuth 2.0

Retrieves all departments for a supplier, with the default department first and the rest sorted alphabetically by name.

Returns 404 with error code SUPPLIER_NOT_FOUND when the supplier does not exist in your company.

Required Scope

suppliers-read

List supplier departments › path Parameters

supplierId

string · required

Supplier ID

List supplier departments › Responses

List of departments for a supplier

SupplierDepartmentResponse[]

SupplierDepartmentResponse

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 supplier

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

List supplier groups

GET

https://api.ledgerbee.com/api

/v1/suppliers/groups

x-api-key (header)

OAuth 2.0

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

The list is cached for 5 seconds.

Required Scope

suppliers-read

List supplier groups › Responses

List of supplier groups for the company

SupplierGroupResponse[]

SupplierGroupResponse

id

string · required

The unique identifier of the supplier group

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

name

string · required

Name of the supplier group

Example: Domestic Suppliers

description

string

Description of the supplier group

Example: All domestic supplier accounts

defaultAccountId

string

Default ledger account ID

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

Subscriptions VAT Codes

LedgerBee Public API

Suppliers

Download schema

List suppliers

GET

https://api.ledgerbee.com/api

/v1/suppliers

x-api-key (header)

OAuth 2.0

Retrieves all suppliers for your company, sorted by supplier number.

The list is cached for 5 seconds; creating a supplier through this API invalidates the cache, so a just-created supplier is immediately visible.

Required Scope

suppliers-read

List suppliers › Responses

List of suppliers for the company

SupplierResponse[]

SupplierResponse

id

string · required

The unique identifier of the supplier

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

supplierNumber

string · required

Supplier number

Example: V001

name

string · required

Name of the supplier

Example: Acme Supplies

supplierGroupId

string · required

Supplier group ID

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

currency

string · required

Currency code

Example: DKK

status

string · enum · required

Supplier status

Enum values:

active

inactive

archived

Example: active

supplierGroupName

string

Supplier group name

Example: Domestic Suppliers

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 supplier)

Example: 1000

Create a supplier

POST

https://api.ledgerbee.com/api

/v1/suppliers

x-api-key (header)

OAuth 2.0

Creates a supplier together with its contacts.

supplierNumber is trimmed and must be unique within your company — a duplicate returns 400 with error code SUPPLIER_NUMBER_ALREADY_EXISTS.

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

Required Scope

suppliers-write

Create a supplier › Headers

x-api-idempotency-key

string · maxLength: 255

Optional idempotency key for safely retrying mutating requests.

Create a supplier › Request Body

CreateSupplierRequest

supplierNumber

string · required

Unique supplier number

Example: V001

name

string · required

Supplier name

Example: Acme Supplies

supplierGroupId

string · required

Supplier group ID

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

currency

string · minLength: 3 · maxLength: 3 · required

Currency code

Example: DKK

countryCode

string · required

Two-letter country code

Example: DK

CreateSupplierContactRequest[] · required

Contacts for the supplier. 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 supplier, negative = a credit position.

Example: 1000

defaultAccountId

string

Default ledger account ID

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

Create a supplier › Responses

Supplier created successfully

CreateSupplierResponse

id

string · required

The unique identifier of the created supplier

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

supplierNumber

string · required

Supplier number

Example: V001

POST/v1/suppliers

curl https://api.ledgerbee.com/api/v1/suppliers \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "supplierNumber": "V001",
  "name": "Acme Supplies",
  "supplierGroupId": "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

{
  "supplierNumber": "V001",
  "name": "Acme Supplies",
  "supplierGroupId": "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",
  "supplierNumber": "V001"
}

json

application/json

List supplier contacts

GET

https://api.ledgerbee.com/api

/v1/suppliers/{supplierId}/contacts

x-api-key (header)

OAuth 2.0

Retrieves all contacts for a supplier, with the default contact first and the rest sorted alphabetically by name.

Returns 404 with error code SUPPLIER_NOT_FOUND when the supplier does not exist in your company.

Required Scope

suppliers-read

List supplier contacts › path Parameters

supplierId

string · required

Supplier ID

List supplier contacts › Responses

List of contacts for a supplier

SupplierContactResponse[]

SupplierContactResponse

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

isDefaultForSupplier

boolean · required

Whether this is the default contact for the supplier

Example: true

email

string

Email address

Example: john.doe@acme-supplies.com

phone

string

Phone number

Example: +45 12345678

List supplier departments

GET

https://api.ledgerbee.com/api

/v1/suppliers/{supplierId}/departments

x-api-key (header)

OAuth 2.0

Retrieves all departments for a supplier, with the default department first and the rest sorted alphabetically by name.

Returns 404 with error code SUPPLIER_NOT_FOUND when the supplier does not exist in your company.

Required Scope

suppliers-read

List supplier departments › path Parameters

supplierId

string · required

Supplier ID

List supplier departments › Responses

List of departments for a supplier

SupplierDepartmentResponse[]

SupplierDepartmentResponse

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 supplier

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

List supplier groups

GET

https://api.ledgerbee.com/api

/v1/suppliers/groups

x-api-key (header)

OAuth 2.0

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

The list is cached for 5 seconds.

Required Scope

suppliers-read

List supplier groups › Responses

List of supplier groups for the company

SupplierGroupResponse[]

SupplierGroupResponse

id

string · required

The unique identifier of the supplier group

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

name

string · required

Name of the supplier group

Example: Domestic Suppliers

description

string

Description of the supplier group

Example: All domestic supplier accounts

defaultAccountId

string

Default ledger account ID

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

Subscriptions VAT Codes