vendorPayment resource type

Represents a vendor 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 vendorPayment	vendorPayment	Gets a vendor payment object.
DELETE vendorPayment	none	Deletes a vendor payment object.
POST vendorPayment	vendorPayment	Creates a vendor payment object.
PATCH vendorPayment	vendorPayment	Updates a vendor payment object.

Navigation

Navigation	Return Type	Description
customerPaymentJournal	customerPaymentJournal	Gets the customerpaymentjournal of the vendorPayment.
vendor	vendor	Gets the vendor of the vendorPayment.
dimensionSetLines	dimensionSetLines	Gets the dimensionsetlines of the vendorPayment.
applyVendorEntries	applyVendorEntries	Gets the applyvendorentries of the vendorPayment.
vendorPaymentJournal	vendorPaymentJournal	Gets the vendorpaymentjournal of the vendorPayment.

Properties

Property	Type	Description
id	GUID	The unique ID of the vendor 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 vendor payment item line number.
vendorId	GUID	The unique ID of vendor.
vendorNumber	string	Specifies vendor's number.
postingDate	date	The date that the vendor payment is posted.
documentNumber	string	Specifies a document number for the vendor payment.
externalDocumentNumber	string	Specifies an external document number for the vendor payment.
amount	decimal	Specifies the total amount (including VAT) that the vendor payment consists of.
appliesToInvoiceId	GUID	The unique ID of the invoice that the vendor payment is related to.
appliesToInvoiceNumber	string	The number of the invoice that the vendor payment is related to.
description	string	Specifies the description of the vendor payment.
comment	string	A user specified comment on the vendor payment.
lastModifiedDateTime	datetime	The last datetime the vendor payment was modified. Read-Only.

JSON representation

Here is a JSON representation of the vendorPayment resource.

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

Related information

GET vendorPayment
DELETE vendorPayment
POST vendorPayment
PATCH vendorPayment