v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB

VendorPayment

Replaces the VendorPayment resource.

put/vendor_payments/{id}

Path parameters

idstring required

Resource identifier

Request body

idstring

integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring

the unique identifier of the source 3rd party integration e.g. "460000000053219"

vendorIdstring nullable

Unique identifier for the vendor e.g. "460000000026049"

vendorNamestring nullable

Name of the vendor e.g. "Bowman and Co"

paymentModestring nullable

Mode of vendor payment e.g. "Stripe"

txnDatestring date-time nullable

Date the payment is made e.g. "2013-10-07"

referenceNumberstring nullable

Reference number for the vendor payment recorded e.g. REF#912300

amountinteger nullable required

Total amount of the vendor payment in cents e.g. 12500

balanceinteger nullable

Balance due for the bill in cents e.g. 3500

currencystring nullable

Currency code e.g. "USD"

createdstring date-time nullable

Creation time of the vendor payment e.g. 2016-12-16T00:18:42-0500

modifiedstring date-time nullable

Last modified time of the vendor payment e.g. 2016-12-16T00:18:42-0500

Example request

{
  "id": "quickbooks-321",
  "integration": "quickbooks",
  "srcId": "460000000053219",
  "vendorId": "460000000026049",
  "vendorName": "Bowman and Co",
  "paymentMode": "Stripe",
  "txnDate": "2013-10-07",
  "referenceNumber": "REF#912300",
  "amount": 12500,
  "balance": 3500,
  "currency": "USD",
  "created": "2016-12-16T00:18:42-0500",
  "modified": "2016-12-16T00:18:42-0500"
}

Response

VendorPayment resource updated