---
title: "Retrieves the collection of VendorPayment resources."
method: GET
path: "/vendor_payments"
tags: ["VendorPayment"]
---

# Retrieves the collection of VendorPayment resources.

`GET /vendor_payments`

Retrieves the collection of VendorPayment resources.

## Query parameters

- `page` integer
- `itemsPerPage` integer

## Response `200`

VendorPayment collection

- VendorPayment[]
  - `id` string
  - `integration` string — The key of the integration source e.g. "quickbooks", or "xero"
  - `srcId` string — the unique identifier of the source 3rd party integration e.g. "460000000053219"
  - `vendorId` string, nullable — Unique identifier for the vendor e.g. "460000000026049"
  - `vendorName` string, nullable — Name of the vendor e.g. "Bowman and Co"
  - `paymentMode` string, nullable — Mode of vendor payment e.g. "Stripe"
  - `txnDate` string, date-time, nullable — Date the payment is made e.g. "2013-10-07"
  - `referenceNumber` string, nullable — Reference number for the vendor payment recorded e.g. REF#912300
  - `amount` integer, nullable, required — Total amount of the vendor payment in cents e.g. 12500
  - `balance` integer, nullable — Balance due for the bill in cents e.g. 3500
  - `currency` string, nullable — Currency code e.g. "USD"
  - `created` string, date-time, nullable — Creation time of the vendor payment e.g. 2016-12-16T00:18:42-0500
  - `modified` string, date-time, nullable — Last modified time of the vendor payment e.g. 2016-12-16T00:18:42-0500

---

[API](https://skmtc.net/bossinsights/apis/boss-insights.md) · [All operations](https://skmtc.net/bossinsights/apis/boss-insights/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bossinsights/boss-insights/revisions/d08a107895ad/schema)