# 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<../enabling-apis-for-dynamics-nav>.
## Methods
Method|Return Type|Description
../api/dynamics_customerpayment_get|customerPayment|Gets a customer payment object.
../api/dynamics_customerpayment_delete|none|Deletes a customer payment object.
POST customerPayment<../api/dynamics_customerpayment_create>|customerPayment|Creates a customer payment object.
PATCH customerPayment<../api/dynamics_customerpayment_update>|customerPayment|Updates a customer payment object.
## Navigation
Navigation|Return Type|Description
dynamics_customerpaymentjournal|customerPaymentJournal|Gets the customerpaymentjournal of the customerPayment.
dynamics_customer|customer|Gets the customer of the customerPayment.
dynamics_dimensionsetline|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's a JSON representation of the customerPayment resource.
```json
{
    "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"
}
```
## Related information
../api/dynamics_customerpayment_get
../api/dynamics_customerpayment_delete
POST customerPayment<../api/dynamics_customerpayment_create>
PATCH customerPayment<../api/dynamics_customerpayment_update>

Copyright (c) Microsoft Corporation. CC BY 4.0, https://creativecommons.org/licenses/by/4.0/; code samples MIT. From https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/resources/dynamics_customerpayment, MicrosoftDocs/dynamics365smb-devitpro-pb at 828b6ee (2026-11-19). Changed: includes filled in, links to this site, and for agents shortened without dropping a fact. https://jonas-paprotka.de/docs/dev-itpro/api-reference/v2.0/resources/dynamics_customerpayment/
