v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB

VendorCredit

Retrieves the collection of VendorCredit resources.

get/vendor_credits

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

VendorCredit collection

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. "3000000002075"

datestring nullable

The date the vendor credit was created e.g. "2014-08-28"

statusstring nullable

Status of recurring expense e.g. "open"

vendorIdstring nullable

ID of the vendor the vendor credit is associated with e.g. "460000000020029"

vendorNamestring nullable

Name of the vendor the vendor credit is associated with e.g. "Bowman and Co"

currencystring nullable

Currency code e.g. "USD"

subtotalinteger nullable

Subtotal of the vendor credits in cents e.g. 3000

totalAmountinteger nullable required

Total amount of the vendor credits in cents e.g. 3500

balanceinteger nullable

Balance in the vendor credit in cents e.g. 2150

createdstring date-time nullable

Time of the vendor credit creation e.g. "2014-08-28T22:53:31-0700"

modifiedstring date-time nullable

Last modified time of vendor credit e.g. "2014-08-28T22:53:31-0700"

Example response

[
  {
    "id": "quickbooks-321",
    "integration": "quickbooks",
    "srcId": "3000000002075",
    "date": "2014-08-28",
    "status": "open",
    "vendorId": "460000000020029",
    "vendorName": "Bowman and Co",
    "currency": "USD",
    "subtotal": 3000,
    "totalAmount": 3500,
    "balance": 2150,
    "created": "2014-08-28T22:53:31-0700",
    "modified": "2014-08-28T22:53:31-0700"
  }
]