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

MethodReturn TypeDescription
GET vendorPaymentvendorPaymentGets a vendor payment object.
DELETE vendorPaymentnoneDeletes a vendor payment object.
POST vendorPaymentvendorPaymentCreates a vendor payment object.
PATCH vendorPaymentvendorPaymentUpdates a vendor payment object.
GET vendorPaymentvendorPaymentGets a vendor payment object.
NavigationReturn TypeDescription
customerPaymentJournalcustomerPaymentJournalGets the customerpaymentjournal of the vendorPayment.
vendorvendorGets the vendor of the vendorPayment.
dimensionSetLinesdimensionSetLinesGets the dimensionsetlines of the vendorPayment.
applyVendorEntriesapplyVendorEntriesGets the applyvendorentries of the vendorPayment.
vendorPaymentJournalvendorPaymentJournalGets the vendorpaymentjournal of the vendorPayment.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the vendor payment. Non-editable.
journalIdGUIDThe ID of the journal.
journalDisplayNamestringThe display name of the journal that this line belongs to. Read-Only.
lineNumberintegerThe vendor payment item line number.
vendorIdGUIDThe unique ID of vendor.
vendorNumberstringSpecifies vendor's number.
postingDatedateThe date that the vendor payment is posted.
documentNumberstringSpecifies a document number for the vendor payment.
externalDocumentNumberstringSpecifies an external document number for the vendor payment.
amountdecimalSpecifies the total amount (including VAT) that the vendor payment consists of.
appliesToInvoiceIdGUIDThe unique ID of the invoice that the vendor payment is related to.
appliesToInvoiceNumberstringThe number of the invoice that the vendor payment is related to.
descriptionstringSpecifies the description of the vendor payment.
commentstringA user specified comment on the vendor payment.
lastModifiedDateTimedatetimeThe last datetime the vendor payment was modified. Read-Only.

JSON representation

Here's 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"
}

GET vendorPayment
DELETE vendorPayment
POST vendorPayment
PATCH vendorPayment