customerPayment resource type

Important: Currently all requests to API v2.0 must append $schemaversion=2.0 to the request URL to work properly. This is to uptake the new improved $metadata model avaliable from Business Central 17. An update will be applied shortly to apply the schemaversion automatically to API v2.0. For all other APIs $schemaversion=1.0 will be the default, unless specified in the request URL with $schemaversion=2.0. A solution is being worked on, where the schemaversion will be defined in the extension.

Represents a customer payment in Dynamics 365 Business Central.


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


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 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.


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