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

Method	Return Type	Description
GET customerPayment	customerPayment	Gets a customer payment object.
DELETE customerPayment	none	Deletes a customer payment object.
POST customerPayment	customerPayment	Creates a customer payment object.
PATCH customerPayment	customerPayment	Updates a customer payment object.

Navigation

Navigation	Return Type	Description
customerPaymentJournal	customerPaymentJournal	Gets the customerpaymentjournal of the customerPayment.
customer	customer	Gets the customer of the customerPayment.
dimensionSetLines	dimensionSetLines	Gets the dimensionsetlines of the customerPayment.

Properties

Property	Type	Description
id	GUID	The unique ID of the customer payment. Non-editable.
journalId	GUID	The ID of the journal.
journalDisplayName	string	The display name of the journal that this line belongs to. Read-Only.
lineNumber	integer	The customer payment item line number.
customerId	GUID	The unique ID of customer.
customerNumber	string	The customer's number.
postingDate	date	The date that the customer payment is posted.
documentNumber	string	Specifies a document number for the customer payment.
externalDocumentNumber	string	Specifies an external document number for the customer payment.
amount	decimal	Specifies the total amount (including VAT) that the customer payment consists of.
appliesToInvoiceId	GUID	The unique ID of the invoice that the customer payment is related to.
appliesToInvoiceNumber	string	The number of the invoice that the customer payment is related to.
description	string	Specifies the description of the customer payment.
comment	string	A user specified comment on the customer payment.
lastModifiedDateTime	datetime	The last datetime the customer payment was modified. Read-Only.

JSON representation

Here is 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"
}

See Also

GET customerPayment DELETE customerPayment POST customerPayment PATCH customerPayment