Entitlements

Download schema

List entitlements

GET

https://api.ledgerbee.com/api

/v1/entitlements

x-api-key (header)

OAuth 2.0

Credential: a company's API key or OAuth token.

List entitlements › query Parameters

page

number · min: 1

Page number

Default: 1

limit

number · min: 1 · max: 100

Maximum items per page

Default: 25

search

string · maxLength: 255

Search by name or key

sortOrder

string · enum

Sort direction

Enum values:

ASC

DESC

Default: ASC

List entitlements › Responses

ListEntitlementsResponse

EntitlementResponse[] · required

total

number · required

page

number · required

limit

number · required

totalPages

number · required

Create an entitlement

POST

https://api.ledgerbee.com/api

/v1/entitlements

x-api-key (header)

OAuth 2.0

Credential: a company's API key or OAuth token.

Create an entitlement › Headers

x-api-idempotency-key

string · maxLength: 255

Optional idempotency key for safely retrying mutating requests.

Create an entitlement › Request Body

CreateEntitlementRequest

name

string · required

Entitlement name

Example: Advanced reporting

key

string | null

Stable integration key

Example: advanced_reporting

Create an entitlement › Responses

Entitlement created

EntitlementResponse

id

string · required

Entitlement ID

name

string · required

Entitlement name

Example: Advanced reporting

managedExternally

boolean · required

True when the entitlement is maintained by an external system rather than created by an operator in the app. Only rows with externalSource "api" can be modified through this API.

Example: false

externalSource

string | null · enum · required

Which system maintains the entitlement: "api" (created via this API), "platform" (managed by LedgerBee, read-only here), or null for operator-created rows.

Enum values:

api

platform

Example: api

createdAt

string · date-time · required

When the entitlement was created

updatedAt

string · date-time · required

When the entitlement was last updated

key

string | null

Stable integration key

Example: advanced_reporting

Get an entitlement

GET

https://api.ledgerbee.com/api

/v1/entitlements/{id}

x-api-key (header)

OAuth 2.0

Credential: a company's API key or OAuth token.

Get an entitlement › path Parameters

id

string · required

Get an entitlement › Responses

EntitlementResponse

id

string · required

Entitlement ID

name

string · required

Entitlement name

Example: Advanced reporting

managedExternally

boolean · required

True when the entitlement is maintained by an external system rather than created by an operator in the app. Only rows with externalSource "api" can be modified through this API.

Example: false

externalSource

string | null · enum · required

Which system maintains the entitlement: "api" (created via this API), "platform" (managed by LedgerBee, read-only here), or null for operator-created rows.

Enum values:

api

platform

Example: api

createdAt

string · date-time · required

When the entitlement was created

updatedAt

string · date-time · required

When the entitlement was last updated

key

string | null

Stable integration key

Example: advanced_reporting

Delete an entitlement

DELETE

https://api.ledgerbee.com/api

/v1/entitlements/{id}

x-api-key (header)

OAuth 2.0

Credential: a company's API key or OAuth token.

Delete an entitlement › path Parameters

id

string · required

Delete an entitlement › Headers

x-api-idempotency-key

string · maxLength: 255

Optional idempotency key for safely retrying mutating requests.

Delete an entitlement › Responses

No data returned

Update an entitlement

PATCH

https://api.ledgerbee.com/api

/v1/entitlements/{id}

x-api-key (header)

OAuth 2.0

Credential: a company's API key or OAuth token.

Update an entitlement › path Parameters

id

string · required

Update an entitlement › Headers

x-api-idempotency-key

string · maxLength: 255

Optional idempotency key for safely retrying mutating requests.

Update an entitlement › Request Body

UpdateEntitlementRequest

name

string

Entitlement name

key

string | null

Stable integration key

Update an entitlement › Responses

EntitlementResponse

id

string · required

Entitlement ID

name

string · required

Entitlement name

Example: Advanced reporting

managedExternally

boolean · required

True when the entitlement is maintained by an external system rather than created by an operator in the app. Only rows with externalSource "api" can be modified through this API.

Example: false

externalSource

string | null · enum · required

Which system maintains the entitlement: "api" (created via this API), "platform" (managed by LedgerBee, read-only here), or null for operator-created rows.

Enum values:

api

platform

Example: api

createdAt

string · date-time · required

When the entitlement was created

updatedAt

string · date-time · required

When the entitlement was last updated

key

string | null

Stable integration key

Example: advanced_reporting

Draft Journal Entries (v2)Invoices

LedgerBee Public API

Entitlements

Download schema

List entitlements

GET

https://api.ledgerbee.com/api

/v1/entitlements

x-api-key (header)

OAuth 2.0

Credential: a company's API key or OAuth token.

List entitlements › query Parameters

page

number · min: 1

Page number

Default: 1

limit

number · min: 1 · max: 100

Maximum items per page

Default: 25

search

string · maxLength: 255

Search by name or key

sortOrder

string · enum

Sort direction

Enum values:

ASC

DESC

Default: ASC

List entitlements › Responses

ListEntitlementsResponse

EntitlementResponse[] · required

total

number · required

page

number · required

limit

number · required

totalPages

number · required

Create an entitlement

POST

https://api.ledgerbee.com/api

/v1/entitlements

x-api-key (header)

OAuth 2.0

Credential: a company's API key or OAuth token.

Create an entitlement › Headers

x-api-idempotency-key

string · maxLength: 255

Optional idempotency key for safely retrying mutating requests.

Create an entitlement › Request Body

CreateEntitlementRequest

name

string · required

Entitlement name

Example: Advanced reporting

key

string | null

Stable integration key

Example: advanced_reporting

Create an entitlement › Responses

Entitlement created

EntitlementResponse

id

string · required

Entitlement ID

name

string · required

Entitlement name

Example: Advanced reporting

managedExternally

boolean · required

True when the entitlement is maintained by an external system rather than created by an operator in the app. Only rows with externalSource "api" can be modified through this API.

Example: false

externalSource

string | null · enum · required

Which system maintains the entitlement: "api" (created via this API), "platform" (managed by LedgerBee, read-only here), or null for operator-created rows.

Enum values:

api

platform

Example: api

createdAt

string · date-time · required

When the entitlement was created

updatedAt

string · date-time · required

When the entitlement was last updated

key

string | null

Stable integration key

Example: advanced_reporting

Get an entitlement

GET

https://api.ledgerbee.com/api

/v1/entitlements/{id}

x-api-key (header)

OAuth 2.0

Credential: a company's API key or OAuth token.

Get an entitlement › path Parameters

id

string · required

Get an entitlement › Responses

EntitlementResponse

id

string · required

Entitlement ID

name

string · required

Entitlement name

Example: Advanced reporting

managedExternally

boolean · required

True when the entitlement is maintained by an external system rather than created by an operator in the app. Only rows with externalSource "api" can be modified through this API.

Example: false

externalSource

string | null · enum · required

Which system maintains the entitlement: "api" (created via this API), "platform" (managed by LedgerBee, read-only here), or null for operator-created rows.

Enum values:

api

platform

Example: api

createdAt

string · date-time · required

When the entitlement was created

updatedAt

string · date-time · required

When the entitlement was last updated

key

string | null

Stable integration key

Example: advanced_reporting

Delete an entitlement

DELETE

https://api.ledgerbee.com/api

/v1/entitlements/{id}

x-api-key (header)

OAuth 2.0

Credential: a company's API key or OAuth token.

Delete an entitlement › path Parameters

id

string · required

Delete an entitlement › Headers

x-api-idempotency-key

string · maxLength: 255

Optional idempotency key for safely retrying mutating requests.

Delete an entitlement › Responses

No data returned

Update an entitlement

PATCH

https://api.ledgerbee.com/api

/v1/entitlements/{id}

x-api-key (header)

OAuth 2.0

Credential: a company's API key or OAuth token.

Update an entitlement › path Parameters

id

string · required

Update an entitlement › Headers

x-api-idempotency-key

string · maxLength: 255

Optional idempotency key for safely retrying mutating requests.

Update an entitlement › Request Body

UpdateEntitlementRequest

name

string

Entitlement name

key

string | null

Stable integration key

Update an entitlement › Responses

EntitlementResponse

id

string · required

Entitlement ID

name

string · required

Entitlement name

Example: Advanced reporting

managedExternally

boolean · required

True when the entitlement is maintained by an external system rather than created by an operator in the app. Only rows with externalSource "api" can be modified through this API.

Example: false

externalSource

string | null · enum · required

Which system maintains the entitlement: "api" (created via this API), "platform" (managed by LedgerBee, read-only here), or null for operator-created rows.

Enum values:

api

platform

Example: api

createdAt

string · date-time · required

When the entitlement was created

updatedAt

string · date-time · required

When the entitlement was last updated

key

string | null

Stable integration key

Example: advanced_reporting

Draft Journal Entries (v2)Invoices