{"title":"customerPayment resource type","url":"https://jonas-paprotka.de/docs/dev-itpro/api-reference/v2.0/resources/dynamics_customerpayment/","by":"JOP-AL","license":"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.","credit":"Microsoft Corporation, CC BY 4.0","origin":"https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/resources/dynamics_customerpayment","source":{"name":"Business Central developer and IT pro docs","repo":"https://github.com/MicrosoftDocs/dynamics365smb-devitpro-pb","commit":"828b6ee72fcd75755627cd6011f3d20899217ab2","date":"2026-11-19"},"checked":"2026-11-19","description":"A customer payment object in Dynamics 365 Business Central.","date":"2026-08-21","meta":{"topic":"reference"},"outline":[{"level":1,"title":"customerPayment resource type","slug":"customerpayment-resource-type","at":0,"chars":2904},{"level":2,"title":"Methods","slug":"methods","at":241,"chars":430},{"level":2,"title":"Navigation","slug":"navigation","at":671,"chars":324},{"level":2,"title":"Properties","slug":"properties","at":995,"chars":1131},{"level":2,"title":"JSON representation","slug":"json-representation","at":2126,"chars":558},{"level":2,"title":"Related information","slug":"related-information","at":2684,"chars":220}],"text":"# customerPayment resource type\nRepresents a customer payment in Business Central.\n> NOTE\n> For information about enabling APIs for Business Central see Enabling the APIs for Dynamics 365 Business Central<../enabling-apis-for-dynamics-nav>.\n## Methods\nMethod|Return Type|Description\n../api/dynamics_customerpayment_get|customerPayment|Gets a customer payment object.\n../api/dynamics_customerpayment_delete|none|Deletes a customer payment object.\nPOST customerPayment<../api/dynamics_customerpayment_create>|customerPayment|Creates a customer payment object.\nPATCH customerPayment<../api/dynamics_customerpayment_update>|customerPayment|Updates a customer payment object.\n## Navigation\nNavigation|Return Type|Description\ndynamics_customerpaymentjournal|customerPaymentJournal|Gets the customerpaymentjournal of the customerPayment.\ndynamics_customer|customer|Gets the customer of the customerPayment.\ndynamics_dimensionsetline|dimensionSetLines|Gets the dimensionsetlines of the customerPayment.\n## Properties\nProperty|Type|Description\nid|GUID|The unique ID of the customer payment. Non-editable.\njournalId|GUID|The ID of the journal.\njournalDisplayName|string|The display name of the journal that this line belongs to. Read-Only.\nlineNumber|integer|The customer payment item line number.\ncustomerId|GUID|The unique ID of customer.\ncustomerNumber|string|The customer's number.\npostingDate|date|The date that the customer payment is posted.\ndocumentNumber|string|Specifies a document number for the customer payment.\nexternalDocumentNumber|string|Specifies an external document number for the customer payment.\namount|decimal|Specifies the total amount (including VAT) that the customer payment consists of.\nappliesToInvoiceId|GUID|The unique ID of the invoice that the customer payment is related to.\nappliesToInvoiceNumber|string|The number of the invoice that the customer payment is related to.\ndescription|string|Specifies the description of the customer payment.\ncomment|string|A user specified comment on the customer payment.\nlastModifiedDateTime|datetime|The last datetime the customer payment was modified. Read-Only.\n## JSON representation\nHere's a JSON representation of the customerPayment resource.\n```json\n{\n    \"id\": \"GUID\",\n    \"journalId\": \"GUID\",\n    \"journalDisplayName\": \"string\",\n    \"lineNumber\": \"integer\",\n    \"customerId\": \"GUID\",\n    \"customerNumber\": \"string\",\n    \"postingDate\": \"date\",\n    \"documentNumber\": \"string\",\n    \"externalDocumentNumber\": \"string\",\n    \"amount\": \"decimal\",\n    \"appliesToInvoiceId\": \"GUID\",\n    \"appliesToInvoiceNumber\": \"string\",\n    \"description\": \"string\",\n    \"comment\": \"string\",\n    \"lastModifiedDateTime\": \"datetime\"\n}\n```\n## Related information\n../api/dynamics_customerpayment_get\n../api/dynamics_customerpayment_delete\nPOST customerPayment<../api/dynamics_customerpayment_create>\nPATCH customerPayment<../api/dynamics_customerpayment_update>"}