customerPayment resource type

Represents a customer payment in Business Central.

Note

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

Methods

MethodReturn TypeDescription
GET customerPaymentcustomerPaymentGets a customer payment object.
DELETE customerPaymentnoneDeletes a customer payment object.
POST customerPaymentcustomerPaymentCreates a customer payment object.
PATCH customerPaymentcustomerPaymentUpdates a customer payment object.
NavigationReturn TypeDescription
customerPaymentJournalcustomerPaymentJournalGets the customerpaymentjournal of the customerPayment.
customercustomerGets the customer of the customerPayment.
dimensionSetLinesdimensionSetLinesGets the dimensionsetlines of the customerPayment.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the customer payment. Non-editable.
journalIdGUIDThe ID of the journal.
journalDisplayNamestringThe display name of the journal that this line belongs to. Read-Only.
lineNumberintegerThe customer payment item line number.
customerIdGUIDThe unique ID of customer.
customerNumberstringThe customer's number.
postingDatedateThe date that the customer payment is posted.
documentNumberstringSpecifies a document number for the customer payment.
externalDocumentNumberstringSpecifies an external document number for the customer payment.
amountdecimalSpecifies the total amount (including VAT) that the customer payment consists of.
appliesToInvoiceIdGUIDThe unique ID of the invoice that the customer payment is related to.
appliesToInvoiceNumberstringThe number of the invoice that the customer payment is related to.
descriptionstringSpecifies the description of the customer payment.
commentstringA user specified comment on the customer payment.
lastModifiedDateTimedatetimeThe last datetime the customer payment was modified. Read-Only.

JSON representation

Here's a JSON representation of the customerPayment resource.

{
    "id": "GUID",
    "journalId": "GUID",
    "journalDisplayName": "string",
    "lineNumber": "integer",
    "customerId": "GUID",
    "customerNumber": "string",
    "postingDate": "date",
    "documentNumber": "string",
    "externalDocumentNumber": "string",
    "amount": "decimal",
    "appliesToInvoiceId": "GUID",
    "appliesToInvoiceNumber": "string",
    "description": "string",
    "comment": "string",
    "lastModifiedDateTime": "datetime"
}

GET customerPayment DELETE customerPayment POST customerPayment PATCH customerPayment