Products

Download schema

Catalogue products. Each product belongs to a product group and carries one or more prices.

List products

GET

https://api.ledgerbee.com/api

/v1/products

x-api-key (header)

OAuth 2.0

Retrieves a paginated list of your company's products, each including its prices.

Pass ?search= to prefix-match on product name or number, or ?productGroupId= to narrow the list to one product group.

Required Scope

products-read

List products › query Parameters

page

number · min: 1

Page number (1-indexed)

Default: 1

limit

number · min: 1 · max: 100

Maximum number of items per page

Default: 25

search

string

Prefix search on name or number

Example: Hosting

productGroupId

string

Filter by product group ID

sortBy

string · enum

Field to sort by

Enum values:

productNumber

name

createdAt

Default: createdAt

sortOrder

string · enum

Sort direction

Enum values:

ASC

DESC

Default: DESC

List products › Responses

Paginated list of products for the company (each includes its prices)

ListProductsResponse

ProductListItem[] · required

Page of products (prices omitted; GET one product for its prices)

total

number · required

Total number of matching products

Example: 42

page

number · required

Current page number

Example: 1

limit

number · required

Items per page

Example: 25

totalPages

number · required

Total number of pages

Example: 2

Create a product

POST

https://api.ledgerbee.com/api

/v1/products

x-api-key (header)

OAuth 2.0

Creates a product.

An optional initial price can be supplied inline — it is created, activated, and set as the product's default price in the same transaction.

Required Scope

products-write

Create a product › Request Body

CreateProductRequest

productNumber

string · required

Unique product number within the company

Example: P001

name

string · required

Name of the product

Example: Web Hosting

unit

string · required

Unit of measurement

Example: pcs

productGroupId

string · required

Product group this product belongs to (must exist)

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

description

string

Optional description

isActive

boolean

Whether the product is active

Default: true

productType

string · enum

Product type (goods or services)

Enum values:

goods

services

Default: services

object

Optional initial price. If provided it is created, activated and set as default in one transaction.

Create a product › Responses

Product created successfully

ProductResponse

id

string · required

The unique identifier of the product

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

productNumber

string · required

Unique product number within the company

Example: P001

name

string · required

Name of the product

Example: Web Hosting

unit

string · required

Unit of measurement

Example: pcs

productGroupId

string · required

Product group this product belongs to

productType

string · enum · required

Product type (goods or services) for EU VAT

Enum values:

goods

services

isActive

boolean · required

Whether the product is active

Example: true

isArchived

boolean · required

Whether the product is archived

Example: false

isLocked

boolean · required

Whether the product is locked (in use, cannot be deleted)

Example: false

createdAt

string · date-time · required

When the product was created

Example: 2024-01-15T10:30:00Z

updatedAt

string · date-time · required

When the product was last updated

Example: 2024-01-15T10:30:00Z

description

string | null

Optional description

ProductPriceResponse[]

Prices configured for this product

POST/v1/products

curl https://api.ledgerbee.com/api/v1/products \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "productNumber": "P001",
  "name": "Web Hosting",
  "description": "description",
  "unit": "pcs",
  "productGroupId": "550e8400-e29b-41d4-a716-446655440000",
  "isActive": true,
  "productType": "services",
  "initialPrice": {
    "nickname": "Monthly",
    "unitAmount": "99.99",
    "billingPeriodType": "recurring",
    "pricingModel": "flat_rate",
    "billingInterval": "day",
    "billingIntervalCount": 1,
    "currency": "DKK",
    "meterId": "meterId",
    "tiers": [
      {
        "fromQuantity": 1,
        "toQuantity": 10,
        "unitAmount": "99.99",
        "flatFee": "10.00"
      }
    ]
  }
}'

Example Request Body

{
  "productNumber": "P001",
  "name": "Web Hosting",
  "description": "description",
  "unit": "pcs",
  "productGroupId": "550e8400-e29b-41d4-a716-446655440000",
  "isActive": true,
  "productType": "services",
  "initialPrice": {
    "nickname": "Monthly",
    "unitAmount": "99.99",
    "billingPeriodType": "recurring",
    "pricingModel": "flat_rate",
    "billingInterval": "day",
    "billingIntervalCount": 1,
    "currency": "DKK",
    "meterId": "meterId",
    "tiers": [
      {
        "fromQuantity": 1,
        "toQuantity": 10,
        "unitAmount": "99.99",
        "flatFee": "10.00"
      }
    ]
  }
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "productNumber": "P001",
  "name": "Web Hosting",
  "description": "description",
  "unit": "pcs",
  "productGroupId": "productGroupId",
  "productType": "goods",
  "isActive": true,
  "isArchived": false,
  "isLocked": false,
  "prices": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "productId": "productId",
      "nickname": "nickname",
      "unitAmount": "99.99",
      "billingPeriodType": "recurring",
      "pricingModel": "flat_rate",
      "billingInterval": "day",
      "billingIntervalCount": 1,
      "currency": "DKK",
      "baseCurrency": "DKK",
      "availableCurrencies": [
        "string"
      ],
      "status": "draft",
      "isDefault": false,
      "isLocked": false,
      "meterId": "meterId",
      "tiers": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "fromQuantity": 1,
          "toQuantity": 10,
          "unitAmount": "99.99",
          "flatFee": "10.00"
        }
      ],
      "vatRatesByZone": {}
    }
  ],
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

json

application/json

Get a product

GET

https://api.ledgerbee.com/api

/v1/products/{productId}

x-api-key (header)

OAuth 2.0

Returns a single product, including its prices.

Required Scope

products-read

Get a product › path Parameters

productId

string · required

Product ID

Get a product › Responses

Product details, including its prices

ProductResponse

id

string · required

The unique identifier of the product

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

productNumber

string · required

Unique product number within the company

Example: P001

name

string · required

Name of the product

Example: Web Hosting

unit

string · required

Unit of measurement

Example: pcs

productGroupId

string · required

Product group this product belongs to

productType

string · enum · required

Product type (goods or services) for EU VAT

Enum values:

goods

services

isActive

boolean · required

Whether the product is active

Example: true

isArchived

boolean · required

Whether the product is archived

Example: false

isLocked

boolean · required

Whether the product is locked (in use, cannot be deleted)

Example: false

createdAt

string · date-time · required

When the product was created

Example: 2024-01-15T10:30:00Z

updatedAt

string · date-time · required

When the product was last updated

Example: 2024-01-15T10:30:00Z

description

string | null

Optional description

ProductPriceResponse[]

Prices configured for this product

GET/v1/products/{productId}

curl https://api.ledgerbee.com/api/v1/products/:productId \
  --header 'x-api-key: <api-key>'

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "productNumber": "P001",
  "name": "Web Hosting",
  "description": "description",
  "unit": "pcs",
  "productGroupId": "productGroupId",
  "productType": "goods",
  "isActive": true,
  "isArchived": false,
  "isLocked": false,
  "prices": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "productId": "productId",
      "nickname": "nickname",
      "unitAmount": "99.99",
      "billingPeriodType": "recurring",
      "pricingModel": "flat_rate",
      "billingInterval": "day",
      "billingIntervalCount": 1,
      "currency": "DKK",
      "baseCurrency": "DKK",
      "availableCurrencies": [
        "string"
      ],
      "status": "draft",
      "isDefault": false,
      "isLocked": false,
      "meterId": "meterId",
      "tiers": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "fromQuantity": 1,
          "toQuantity": 10,
          "unitAmount": "99.99",
          "flatFee": "10.00"
        }
      ],
      "vatRatesByZone": {}
    }
  ],
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

json

application/json

Delete a product

DELETE

https://api.ledgerbee.com/api

/v1/products/{productId}

x-api-key (header)

OAuth 2.0

Deletes a product. A product that is locked (in use) cannot be deleted.

Required Scope

products-write

Delete a product › path Parameters

productId

string · required

Product ID

Delete a product › Responses

Product deleted successfully

No data returned

Update a product

PATCH

https://api.ledgerbee.com/api

/v1/products/{productId}

x-api-key (header)

OAuth 2.0

Updates a product. Only the fields provided in the request are changed.

Required Scope

products-write

Update a product › path Parameters

productId

string · required

Product ID

Update a product › Request Body

UpdateProductRequest

productNumber

string

Unique product number within the company

Example: P001

name

string

Name of the product

Example: Web Hosting

description

string

Optional description

unit

string

Unit of measurement

Example: pcs

productGroupId

string

Product group this product belongs to

isActive

boolean

Whether the product is active

productType

string · enum

Product type (goods or services)

Enum values:

goods

services

Update a product › Responses

Product updated successfully

ProductResponse

id

string · required

The unique identifier of the product

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

productNumber

string · required

Unique product number within the company

Example: P001

name

string · required

Name of the product

Example: Web Hosting

unit

string · required

Unit of measurement

Example: pcs

productGroupId

string · required

Product group this product belongs to

productType

string · enum · required

Product type (goods or services) for EU VAT

Enum values:

goods

services

isActive

boolean · required

Whether the product is active

Example: true

isArchived

boolean · required

Whether the product is archived

Example: false

isLocked

boolean · required

Whether the product is locked (in use, cannot be deleted)

Example: false

createdAt

string · date-time · required

When the product was created

Example: 2024-01-15T10:30:00Z

updatedAt

string · date-time · required

When the product was last updated

Example: 2024-01-15T10:30:00Z

description

string | null

Optional description

ProductPriceResponse[]

Prices configured for this product

PATCH/v1/products/{productId}

curl https://api.ledgerbee.com/api/v1/products/:productId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "productNumber": "P001",
  "name": "Web Hosting",
  "description": "description",
  "unit": "pcs",
  "productGroupId": "productGroupId",
  "isActive": true,
  "productType": "goods"
}'

Example Request Body

{
  "productNumber": "P001",
  "name": "Web Hosting",
  "description": "description",
  "unit": "pcs",
  "productGroupId": "productGroupId",
  "isActive": true,
  "productType": "goods"
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "productNumber": "P001",
  "name": "Web Hosting",
  "description": "description",
  "unit": "pcs",
  "productGroupId": "productGroupId",
  "productType": "goods",
  "isActive": true,
  "isArchived": false,
  "isLocked": false,
  "prices": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "productId": "productId",
      "nickname": "nickname",
      "unitAmount": "99.99",
      "billingPeriodType": "recurring",
      "pricingModel": "flat_rate",
      "billingInterval": "day",
      "billingIntervalCount": 1,
      "currency": "DKK",
      "baseCurrency": "DKK",
      "availableCurrencies": [
        "string"
      ],
      "status": "draft",
      "isDefault": false,
      "isLocked": false,
      "meterId": "meterId",
      "tiers": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "fromQuantity": 1,
          "toQuantity": 10,
          "unitAmount": "99.99",
          "flatFee": "10.00"
        }
      ],
      "vatRatesByZone": {}
    }
  ],
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

json

application/json

Product Prices Projects

LedgerBee Public API

Products

Download schema

Catalogue products. Each product belongs to a product group and carries one or more prices.

List products

GET

https://api.ledgerbee.com/api

/v1/products

x-api-key (header)

OAuth 2.0

Retrieves a paginated list of your company's products, each including its prices.

Pass ?search= to prefix-match on product name or number, or ?productGroupId= to narrow the list to one product group.

Required Scope

products-read

List products › query Parameters

page

number · min: 1

Page number (1-indexed)

Default: 1

limit

number · min: 1 · max: 100

Maximum number of items per page

Default: 25

search

string

Prefix search on name or number

Example: Hosting

productGroupId

string

Filter by product group ID

sortBy

string · enum

Field to sort by

Enum values:

productNumber

name

createdAt

Default: createdAt

sortOrder

string · enum

Sort direction

Enum values:

ASC

DESC

Default: DESC

List products › Responses

Paginated list of products for the company (each includes its prices)

ListProductsResponse

ProductListItem[] · required

Page of products (prices omitted; GET one product for its prices)

total

number · required

Total number of matching products

Example: 42

page

number · required

Current page number

Example: 1

limit

number · required

Items per page

Example: 25

totalPages

number · required

Total number of pages

Example: 2

Create a product

POST

https://api.ledgerbee.com/api

/v1/products

x-api-key (header)

OAuth 2.0

Creates a product.

An optional initial price can be supplied inline — it is created, activated, and set as the product's default price in the same transaction.

Required Scope

products-write

Create a product › Request Body

CreateProductRequest

productNumber

string · required

Unique product number within the company

Example: P001

name

string · required

Name of the product

Example: Web Hosting

unit

string · required

Unit of measurement

Example: pcs

productGroupId

string · required

Product group this product belongs to (must exist)

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

description

string

Optional description

isActive

boolean

Whether the product is active

Default: true

productType

string · enum

Product type (goods or services)

Enum values:

goods

services

Default: services

object

Optional initial price. If provided it is created, activated and set as default in one transaction.

Create a product › Responses

Product created successfully

ProductResponse

id

string · required

The unique identifier of the product

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

productNumber

string · required

Unique product number within the company

Example: P001

name

string · required

Name of the product

Example: Web Hosting

unit

string · required

Unit of measurement

Example: pcs

productGroupId

string · required

Product group this product belongs to

productType

string · enum · required

Product type (goods or services) for EU VAT

Enum values:

goods

services

isActive

boolean · required

Whether the product is active

Example: true

isArchived

boolean · required

Whether the product is archived

Example: false

isLocked

boolean · required

Whether the product is locked (in use, cannot be deleted)

Example: false

createdAt

string · date-time · required

When the product was created

Example: 2024-01-15T10:30:00Z

updatedAt

string · date-time · required

When the product was last updated

Example: 2024-01-15T10:30:00Z

description

string | null

Optional description

ProductPriceResponse[]

Prices configured for this product

POST/v1/products

curl https://api.ledgerbee.com/api/v1/products \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "productNumber": "P001",
  "name": "Web Hosting",
  "description": "description",
  "unit": "pcs",
  "productGroupId": "550e8400-e29b-41d4-a716-446655440000",
  "isActive": true,
  "productType": "services",
  "initialPrice": {
    "nickname": "Monthly",
    "unitAmount": "99.99",
    "billingPeriodType": "recurring",
    "pricingModel": "flat_rate",
    "billingInterval": "day",
    "billingIntervalCount": 1,
    "currency": "DKK",
    "meterId": "meterId",
    "tiers": [
      {
        "fromQuantity": 1,
        "toQuantity": 10,
        "unitAmount": "99.99",
        "flatFee": "10.00"
      }
    ]
  }
}'

Example Request Body

{
  "productNumber": "P001",
  "name": "Web Hosting",
  "description": "description",
  "unit": "pcs",
  "productGroupId": "550e8400-e29b-41d4-a716-446655440000",
  "isActive": true,
  "productType": "services",
  "initialPrice": {
    "nickname": "Monthly",
    "unitAmount": "99.99",
    "billingPeriodType": "recurring",
    "pricingModel": "flat_rate",
    "billingInterval": "day",
    "billingIntervalCount": 1,
    "currency": "DKK",
    "meterId": "meterId",
    "tiers": [
      {
        "fromQuantity": 1,
        "toQuantity": 10,
        "unitAmount": "99.99",
        "flatFee": "10.00"
      }
    ]
  }
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "productNumber": "P001",
  "name": "Web Hosting",
  "description": "description",
  "unit": "pcs",
  "productGroupId": "productGroupId",
  "productType": "goods",
  "isActive": true,
  "isArchived": false,
  "isLocked": false,
  "prices": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "productId": "productId",
      "nickname": "nickname",
      "unitAmount": "99.99",
      "billingPeriodType": "recurring",
      "pricingModel": "flat_rate",
      "billingInterval": "day",
      "billingIntervalCount": 1,
      "currency": "DKK",
      "baseCurrency": "DKK",
      "availableCurrencies": [
        "string"
      ],
      "status": "draft",
      "isDefault": false,
      "isLocked": false,
      "meterId": "meterId",
      "tiers": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "fromQuantity": 1,
          "toQuantity": 10,
          "unitAmount": "99.99",
          "flatFee": "10.00"
        }
      ],
      "vatRatesByZone": {}
    }
  ],
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

json

application/json

Get a product

GET

https://api.ledgerbee.com/api

/v1/products/{productId}

x-api-key (header)

OAuth 2.0

Returns a single product, including its prices.

Required Scope

products-read

Get a product › path Parameters

productId

string · required

Product ID

Get a product › Responses

Product details, including its prices

ProductResponse

id

string · required

The unique identifier of the product

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

productNumber

string · required

Unique product number within the company

Example: P001

name

string · required

Name of the product

Example: Web Hosting

unit

string · required

Unit of measurement

Example: pcs

productGroupId

string · required

Product group this product belongs to

productType

string · enum · required

Product type (goods or services) for EU VAT

Enum values:

goods

services

isActive

boolean · required

Whether the product is active

Example: true

isArchived

boolean · required

Whether the product is archived

Example: false

isLocked

boolean · required

Whether the product is locked (in use, cannot be deleted)

Example: false

createdAt

string · date-time · required

When the product was created

Example: 2024-01-15T10:30:00Z

updatedAt

string · date-time · required

When the product was last updated

Example: 2024-01-15T10:30:00Z

description

string | null

Optional description

ProductPriceResponse[]

Prices configured for this product

GET/v1/products/{productId}

curl https://api.ledgerbee.com/api/v1/products/:productId \
  --header 'x-api-key: <api-key>'

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "productNumber": "P001",
  "name": "Web Hosting",
  "description": "description",
  "unit": "pcs",
  "productGroupId": "productGroupId",
  "productType": "goods",
  "isActive": true,
  "isArchived": false,
  "isLocked": false,
  "prices": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "productId": "productId",
      "nickname": "nickname",
      "unitAmount": "99.99",
      "billingPeriodType": "recurring",
      "pricingModel": "flat_rate",
      "billingInterval": "day",
      "billingIntervalCount": 1,
      "currency": "DKK",
      "baseCurrency": "DKK",
      "availableCurrencies": [
        "string"
      ],
      "status": "draft",
      "isDefault": false,
      "isLocked": false,
      "meterId": "meterId",
      "tiers": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "fromQuantity": 1,
          "toQuantity": 10,
          "unitAmount": "99.99",
          "flatFee": "10.00"
        }
      ],
      "vatRatesByZone": {}
    }
  ],
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

json

application/json

Delete a product

DELETE

https://api.ledgerbee.com/api

/v1/products/{productId}

x-api-key (header)

OAuth 2.0

Deletes a product. A product that is locked (in use) cannot be deleted.

Required Scope

products-write

Delete a product › path Parameters

productId

string · required

Product ID

Delete a product › Responses

Product deleted successfully

No data returned

Update a product

PATCH

https://api.ledgerbee.com/api

/v1/products/{productId}

x-api-key (header)

OAuth 2.0

Updates a product. Only the fields provided in the request are changed.

Required Scope

products-write

Update a product › path Parameters

productId

string · required

Product ID

Update a product › Request Body

UpdateProductRequest

productNumber

string

Unique product number within the company

Example: P001

name

string

Name of the product

Example: Web Hosting

description

string

Optional description

unit

string

Unit of measurement

Example: pcs

productGroupId

string

Product group this product belongs to

isActive

boolean

Whether the product is active

productType

string · enum

Product type (goods or services)

Enum values:

goods

services

Update a product › Responses

Product updated successfully

ProductResponse

id

string · required

The unique identifier of the product

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

productNumber

string · required

Unique product number within the company

Example: P001

name

string · required

Name of the product

Example: Web Hosting

unit

string · required

Unit of measurement

Example: pcs

productGroupId

string · required

Product group this product belongs to

productType

string · enum · required

Product type (goods or services) for EU VAT

Enum values:

goods

services

isActive

boolean · required

Whether the product is active

Example: true

isArchived

boolean · required

Whether the product is archived

Example: false

isLocked

boolean · required

Whether the product is locked (in use, cannot be deleted)

Example: false

createdAt

string · date-time · required

When the product was created

Example: 2024-01-15T10:30:00Z

updatedAt

string · date-time · required

When the product was last updated

Example: 2024-01-15T10:30:00Z

description

string | null

Optional description

ProductPriceResponse[]

Prices configured for this product

PATCH/v1/products/{productId}

curl https://api.ledgerbee.com/api/v1/products/:productId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "productNumber": "P001",
  "name": "Web Hosting",
  "description": "description",
  "unit": "pcs",
  "productGroupId": "productGroupId",
  "isActive": true,
  "productType": "goods"
}'

Example Request Body

{
  "productNumber": "P001",
  "name": "Web Hosting",
  "description": "description",
  "unit": "pcs",
  "productGroupId": "productGroupId",
  "isActive": true,
  "productType": "goods"
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "productNumber": "P001",
  "name": "Web Hosting",
  "description": "description",
  "unit": "pcs",
  "productGroupId": "productGroupId",
  "productType": "goods",
  "isActive": true,
  "isArchived": false,
  "isLocked": false,
  "prices": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "productId": "productId",
      "nickname": "nickname",
      "unitAmount": "99.99",
      "billingPeriodType": "recurring",
      "pricingModel": "flat_rate",
      "billingInterval": "day",
      "billingIntervalCount": 1,
      "currency": "DKK",
      "baseCurrency": "DKK",
      "availableCurrencies": [
        "string"
      ],
      "status": "draft",
      "isDefault": false,
      "isLocked": false,
      "meterId": "meterId",
      "tiers": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "fromQuantity": 1,
          "toQuantity": 10,
          "unitAmount": "99.99",
          "flatFee": "10.00"
        }
      ],
      "vatRatesByZone": {}
    }
  ],
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

json

application/json

Product Prices Projects