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

# Retrieves the collection of VendorCredit resources.

`GET /vendor_credits`

## Request

- Base URL: `https://example.myintranetapps.com/api`
- URL: `https://example.myintranetapps.com/api/vendor_credits`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/bossinsights/apis/boss-insights/docs/vendor_credits/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the collection of VendorCredit resources.

## Query parameters

- `page` integer
- `itemsPerPage` integer

## Response `200`

VendorCredit collection

- VendorCredit[]
  - `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. "3000000002075"
  - `date` string, nullable: The date the vendor credit was created e.g. "2014-08-28"
  - `status` string, nullable: Status of recurring expense e.g. "open"
  - `vendorId` string, nullable: ID of the vendor the vendor credit is associated with e.g. "460000000020029"
  - `vendorName` string, nullable: Name of the vendor the vendor credit is associated with e.g. "Bowman and Co"
  - `currency` string, nullable: Currency code e.g. "USD"
  - `subtotal` integer, nullable: Subtotal of the vendor credits in cents e.g. 3000
  - `totalAmount` integer, nullable, required: Total amount of the vendor credits in cents e.g. 3500
  - `balance` integer, nullable: Balance in the vendor credit in cents e.g. 2150
  - `created` string, date-time, nullable: Time of the vendor credit creation e.g. "2014-08-28T22:53:31-0700"
  - `modified` string, date-time, nullable: Last modified time of vendor credit e.g. "2014-08-28T22:53:31-0700"

---

[API](https://skmtc.dev/bossinsights/apis/boss-insights.md) - [All operations](https://skmtc.dev/bossinsights/apis/boss-insights/llms.txt) - [OpenAPI document](https://skmtc.dev/bossinsights/apis/boss-insights/revisions/d08a107895ad?raw)
