customerLedgerEntry resource type (Beta)

Important

The finance reports API is announced as deprecated starting with Business Central 2026 release wave 2 and will be removed in Business Central 2027 release wave 1. We recommend that you transition to the Analytics API instead. Learn more in Analytics API overview.

Represents a customer ledger entry in Business Central.

Note

For information about enabling APIs for Business Central see Enabling the APIs for Dynamics 365 Business Central.

Methods

Method	Return Type	Description
GET customerLedgerEntry	customerLedgerEntry	Gets a customer ledger entry object.

Properties

Property	Type	Description
entryNumber	integer	G/L Entry number.
documentType	string	Specifies the document type of the customer ledger entry.
description	string	Specifies the description of the customer ledger entry.
postingDate	date	The date that the customer ledger entry is posted.
documentNumber	string	Specifies a document number for the customer ledger entry.
externalDocumentNumber	string	Specifies an external document number for the customer ledger entry.
balancingAccountNumber	string	The balancing G/L Account number.
balancingAccountType	string
customerNumber	string	The customer's number.
open	boolean
dimensionSetID	integer
currencyCode	string	The default currency code for the customer ledger entry.
lastModifiedDateTime	datetime	The last datetime the customer ledger entry was modified. Read-Only.
amount	decimal	Specifies the total amount (including VAT) that the customer ledger entry consists of.
debitAmount	decimal	Specifies the debitAmount of the customer ledger entry.
creditAmount	decimal	Specifies the creditAmount of the customer ledger entry.
amountLocalCurrency	decimal
debitAmountLocalCurrency	decimal
creditAmountLocalCurrency	decimal

JSON representation

Here is a JSON representation of the customerLedgerEntry resource.

{
    "entryNumber": "integer",
    "documentType": "string",
    "description": "string",
    "postingDate": "date",
    "documentNumber": "string",
    "externalDocumentNumber": "string",
    "balancingAccountNumber": "string",
    "balancingAccountType": "string",
    "customerNumber": "string",
    "open": "boolean",
    "dimensionSetID": "integer",
    "currencyCode": "string",
    "lastModifiedDateTime": "datetime",
    "amount": "decimal",
    "debitAmount": "decimal",
    "creditAmount": "decimal",
    "amountLocalCurrency": "decimal",
    "debitAmountLocalCurrency": "decimal",
    "creditAmountLocalCurrency": "decimal"
}

Related information

GET customerLedgerEntry