LedgerBee Developer
  • Getting started
  • Conventions
  • Products
  • Advisor firms
  • Configuration
  • API Reference
Information
Accounts
    List accountsgetCreate an accountpostGet an accountgetDelete an accountdeleteUpdate an accountpatch
Advisor Authority Extracts
    Submit authority extract data for an advisor firm's clientspost
Advisor Clients
    List the advisor firm's clientsget
API Key
    Get current API keyget
Authority Extracts
    Submit authority extract datapost
Bank Reconciliations
    Reconcile bank lines against entriespostUndo a bank reconciliationpostCheck what undoing a reconciliation would dopostReconcile a batch of matchespostCheck what reconciling a batch of matches would dopostCheck what reconciling bank lines against entries would dopost
Bank Transactions
    List bank linesgetGet a bank linegetDismiss bank lines from reconciliationpostCheck which bank lines a dismiss would changepostRestore dismissed bank lines to reconciliationpostCheck which bank lines a restore would changepost
Billing Groups
    Form a billing grouppostGet a billing groupgetAdd members to a billing grouppostRemove a member from a billing groupdeleteCheck billing group eligibilitypost
Budgets
    List budgetsgetGet a budgetgetGet the budget vs actuals comparisongetExport a budget's Excel workbookgetOverwrite a budget's figures from an edited workbookpostList a budget's frozen baselinesgetGet a frozen baseline with its snapshot cellsgetList a budget's re-baseline proposalsgetList a budget's scenariosgetResolve a budget's grid under a scenariogetGet the variance report vs a frozen baselinegetGet the runway headlineget
Checkout
    Confirm the checkoutpostQuote a first periodpostIntegration readinessgetMint a checkout sessionpostRehydrate a sessiongetRelease the card hold (edit-after-card)postPoll card statusgetOpen the card windowpostOpen a card window for a live subscriptionpost
Company
    Get company detailsget
Connected app OAuth
    JSON Web Key Set used to verify OAuth access-token signaturesgetRFC 8414 authorization-server metadata for the connected-app OAuth servergetRFC 9728 protected-resource metadata for an MCP resourcegetRFC 9728 protected-resource metadata for an MCP resourcegetOpenID Connect discovery document for the connected-app OAuth serverget
Credit Note Links
    Link a credit note to the invoice it creditspostCheck a credit note’s links and the invoices it can be linked topostDetach a credit note from the invoices it is applied topost
Credit Notes
    List credit notesgetCreate a credit notepostGet a credit notegetGet the delivery status of a credit notegetDownload the credit note PDFgetSend a credit note to the customerpostCredit a whole invoicepost
Customers
    List customersgetCreate a customerpostGet a customergetDelete a customerdeleteUpdate a customerpatchList a customer's contactsgetList a customer's departmentsgetList customer groupsget
Dimensions
    List all dimensionsgetCreate a new dimension categorypostGet a dimensiongetUpdate a dimension categoryputDelete a dimension categorydeleteList distribution keys (paginated)getCreate a distribution keypostGet a distribution keygetList dimension values (paginated)getCreate a new dimension valuepostUpdate a dimension valueputDelete a dimension valuedelete
Discounts
    List discountsgetCreate a discountpostGet a discountgetDelete a discountdeleteUpdate a discountpatchSet a discount's amount in one currencyputRemove a discount's amount in one currencydeleteCheck whether a discount applies to a product for a customer on a daygetAssign a discountpostRemove an assignmentdeleteUpdate an assignmentpatchList a discount's codesgetAdd a code to a discountpostDelete a codedeleteUpdate a codepatchList the discounts that apply to a product for a customer on a daygetCheck a cartpostLook up a discount codeget
Document Templates
    List document templatesget
Document Upload Links
    Upload a file through a minted linkpost
Download Links
    Mint a download link for a document PDFgetDownload a minted linkget
Draft Journal Entries
    Create multiple draft journal entries in batchpostList draft journal entriesgetCreate a draft journal entrypostGet a draft journal entrygetDelete a draft journal entrydeleteBook a draft journal entrypost
Draft Journal Entries (v2)
    Create draft journal entries in batch (v2)postList draft journal entries (v2)getCreate a draft journal entry (v2)postGet a draft journal entry (v2)getDelete a draft journal entry (v2)deleteUpdate a draft journal entry (v2)patchGet attachments for a draft journal entry (v2)getAdd a document to a draft journal entry (v2)postRemove a document from a draft journal entry (v2)deleteBook a draft journal entry (v2)post
Entitlements
    List entitlementsgetCreate an entitlementpostGet an entitlementgetDelete an entitlementdeleteUpdate an entitlementpatch
Invoices
    List invoicesgetCreate a draft invoicepostGet an invoicegetDelete a draft invoicedeleteUpdate an unsent invoicepatchGet the delivery status of an invoicegetDownload the invoice PDFgetSend an invoice to the customerpost
Journal Categories
    List journal categoriesgetCreate a journal categorypostUpdate a journal categoryputDelete a journal categorydelete
Journal Entries
    List journal entriesgetGet a journal entrygetUpdate a journal entry — correct the reference and/or set your external system idpatchGet attachments for a journal entrygetAdd a document to a journal entrypostRemove a document from a journal entrydeletePreview a correction without posting itpostMove postings to different accounts, keeping the document intactpostRebuild the entry a reversal undid, as a draftpostPreview rebuilding the entry a reversal undidpostReverse a posted entry and open a draft to re-enter itpostReverse posted journal entries in batchpostPreview reversing posted journal entries in batchpostReverse a posted journal entrypostPreview reversing a posted journal entrypost
Journal Entries (v2)
    Create a journal entry (v2)postCreate journal entries in batch (v2)post
MCP
    LedgerBee Developer MCP Serverpost
Meters
    List meter subscriptions by IDgetReport usagepostList meter subscriptions by nameget
Open Entries
    List a counterparty’s open entriesget
Order Confirmations
    List order confirmationsgetCreate a draft order confirmationpostGet an order confirmationgetUpdate a draft order confirmationpatchConvert an order confirmation into an invoicepostDownload an order confirmation as PDFgetSend an order confirmationpost
Payment Methods
    List saved payment methods for a customergetCancel a saved card on the payment providerdeleteUnassign a payment method from a customerdeleteGenerate a link for the customer to save a card for future paymentspostSet a saved payment method as the customer defaultput
Portal Plans
    List the full plan cataloguegetGet a plangetResolve the gated pricing catalogue for an identified buyer (partner display)post
Portal SSO
    Get a tenant's SSO signing keys (JWKS)getMint a checkout-vouch token (partner-vouched anonymous checkout)postMint a customer-portal SSO handoff referencepostProvision a customer + grant portal access (partner JIT provisioning)postRevoke (force-refresh) a user's customer-portal sessionspost
Product Groups
    List product groupsgetCreate a product grouppostGet a product groupgetDelete a product groupdeleteUpdate a product grouppatch
Product Prices
    Create a product pricepostGet a product pricegetDelete a product pricedeleteUpdate a product pricepatchActivate a product pricepostArchive a product pricepostDisable a product pricepostSet a price as the product defaultpost
Products
    List productsgetCreate a productpostGet a productgetDelete a productdeleteUpdate a productpatchArchive a productpost
Projects
    List all projectsgetCreate or update a project by external referenceputCreate a projectpostGet a projectgetUpdate a projectputGet project profitgetAdd a subprojectpostUpdate a subprojectputDelete a subprojectdelete
Quotes
    List quotesgetCreate a draft quotepostGet a quotegetUpdate a draft quotepatchConvert a quotepostDownload a quote as PDFgetSend a quotepost
Settlements
    List a counterparty’s settlementsgetSettle open entries against each otherpostGet a settlementgetUndo a settlementpostCheck what undoing a settlement would dopostCheck what settling these entries would dopost
Shipments
    List shipmentsgetCreate a shipment from an orderpostGet a shipmentgetCancel a shipmentpostDispatch a shipmentpost
Stock
    List stock movementsgetList on-hand stockgetOn-hand for one productget
Subscriptions
    List customer subscriptionsgetAssign a subscription to a customerpostGet a customer subscription by its stable idgetUpdate a customer subscriptionpatchAdd an add-on to a customer subscriptionpostAttach existing subscriptions as add-onspostCheck whether subscriptions can become add-onspostChange the products on a customer subscriptionpostRetry a failed card paymentpostList a subscription's pending scheduled changesgetCancel a single pending scheduled changedeleteGet a subscription's unbilled usagegetCancel a customer subscriptionpostList subscription plansgetCreate a subscription planpostArchive a subscription planpost
Suppliers
    List suppliersgetCreate a supplierpostDelete a supplierdeleteList supplier contactsgetList supplier departmentsgetList supplier groupsget
VAT Codes
    List VAT codesgetCreate a VAT codepostGet a VAT codegetDelete a VAT codedeleteUpdate a VAT codepatch
VAT periods
    Record a VAT return filed outside LedgerBeepostPreview recording a VAT return filed outside LedgerBeepostSettle a filed VAT periodpostPreview a VAT period settlementpost
Vendors
    List vendorsgetCreate a vendorpostList vendor contactsgetList vendor departmentsgetList vendor groupsget
Webhook Endpoints
    List webhook endpointsgetCreate a webhook endpointpostRetrieve a webhook endpointgetUpdate a webhook endpointputDelete a webhook endpointdeleteRoll the signing secretpostSend a test eventpost
Schemas
LedgerBee Public API
LedgerBee Public API

Connected app OAuth

Download schema

JSON Web Key Set used to verify OAuth access-token signatures

GET
https://api.ledgerbee.com/api
/.well-known/jwks.json

JSON Web Key Set used to verify OAuth access-token signatures › Responses

200

RFC 7517 JWKS document

No data returned
GET/.well-known/jwks.json
curl https://api.ledgerbee.com/api/.well-known/jwks.json
Example Responses
No example specified for this content type

RFC 8414 authorization-server metadata for the connected-app OAuth server

GET
https://api.ledgerbee.com/api
/.well-known/oauth-authorization-server

RFC 8414 authorization-server metadata for the connected-app OAuth server › Responses

200

RFC 8414 authorization-server metadata document

issuer
​string
authorization_endpoint
​string
token_endpoint
​string
registration_endpoint
​string
revocation_endpoint
​string
jwks_uri
​string
grant_types_supported
​string[]
response_types_supported
​string[]
code_challenge_methods_supported
​string[]
token_endpoint_auth_methods_supported
​string[]
revocation_endpoint_auth_methods_supported
​string[]
scopes_supported
​string[]
authorization_response_iss_parameter_supported
​boolean
GET/.well-known/oauth-authorization-server
curl https://api.ledgerbee.com/api/.well-known/oauth-authorization-server
Example Responses
{ "issuer": "issuer", "authorization_endpoint": "authorization_endpoint", "token_endpoint": "token_endpoint", "registration_endpoint": "registration_endpoint", "revocation_endpoint": "revocation_endpoint", "jwks_uri": "jwks_uri", "grant_types_supported": [ "string" ], "response_types_supported": [ "string" ], "code_challenge_methods_supported": [ "string" ], "token_endpoint_auth_methods_supported": [ "string" ], "revocation_endpoint_auth_methods_supported": [ "string" ], "scopes_supported": [ "string" ], "authorization_response_iss_parameter_supported": true }
json
application/json

RFC 9728 protected-resource metadata for an MCP resource

GET
https://api.ledgerbee.com/api
/.well-known/oauth-protected-resource

RFC 9728 protected-resource metadata for an MCP resource › Responses

200

RFC 9728 protected-resource metadata document

resource
​string
authorization_servers
​string[]
scopes_supported
​string[]
bearer_methods_supported
​string[]
GET/.well-known/oauth-protected-resource
curl https://api.ledgerbee.com/api/.well-known/oauth-protected-resource
Example Responses
{ "resource": "resource", "authorization_servers": [ "string" ], "scopes_supported": [ "string" ], "bearer_methods_supported": [ "string" ] }
json
application/json

RFC 9728 protected-resource metadata for an MCP resource

GET
https://api.ledgerbee.com/api
/.well-known/oauth-protected-resource/{splat}

RFC 9728 protected-resource metadata for an MCP resource › Responses

200

RFC 9728 protected-resource metadata document

resource
​string
authorization_servers
​string[]
scopes_supported
​string[]
bearer_methods_supported
​string[]
GET/.well-known/oauth-protected-resource/{splat}
curl https://api.ledgerbee.com/api/.well-known/oauth-protected-resource/:splat
Example Responses
{ "resource": "resource", "authorization_servers": [ "string" ], "scopes_supported": [ "string" ], "bearer_methods_supported": [ "string" ] }
json
application/json

OpenID Connect discovery document for the connected-app OAuth server

GET
https://api.ledgerbee.com/api
/.well-known/openid-configuration

OpenID Connect discovery document for the connected-app OAuth server › Responses

200

OpenID Connect discovery document

issuer
​string
token_endpoint
​string
revocation_endpoint
​string
jwks_uri
​string
grant_types_supported
​string[]
token_endpoint_auth_methods_supported
​string[]
revocation_endpoint_auth_methods_supported
​string[]
scopes_supported
​string[]
authorization_response_iss_parameter_supported
​boolean
GET/.well-known/openid-configuration
curl https://api.ledgerbee.com/api/.well-known/openid-configuration
Example Responses
{ "issuer": "issuer", "token_endpoint": "token_endpoint", "revocation_endpoint": "revocation_endpoint", "jwks_uri": "jwks_uri", "grant_types_supported": [ "string" ], "token_endpoint_auth_methods_supported": [ "string" ], "revocation_endpoint_auth_methods_supported": [ "string" ], "scopes_supported": [ "string" ], "authorization_response_iss_parameter_supported": true }
json
application/json

CompanyCredit Note Links