---
title: "List all vendorcredits"
method: GET
path: "/accounting/{connection_id}/vendorcredit"
tags: ["accounting", "vendorcredit"]
---

# List all vendorcredits

`GET /accounting/{connection_id}/vendorcredit`

## Request

- Base URL: `http://api.unified.to`
- URL: `http://api.unified.to/accounting/{connection_id}/vendorcredit`
- Auth: API key in header `authorization`

## Path parameters

- `connection_id` string, required

## Query parameters

- `limit` number
- `offset` number
- `updated_gte` string, date-time
- `sort` 'name' | 'updated_at' | 'created_at'
- `order` 'asc' | 'desc'
- `query` string
- `contact_id` string
- `org_id` string
- `fields` string[]
- `raw` string

## Response `200`

Successful

- AccountingVendorcredit[]
  - `id` string
  - `created_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `updated_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `due_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `posted_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `total_amount` number
  - `balance_amount` number
  - `account_id` string: (reference to AccountingAccount)
  - `currency` string
  - `contact_id` string: (reference to AccountingContact)
  - `bill_id` string
  - `notes` string
  - `lineitems` AccountingLineitem[]
    - `id` string
    - `created_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `updated_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `refunded_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `total_amount` number: unit_quantity * unit_amount + tax_amount
    - `refund_amount` number
    - `discount_amount` number
    - `tax_amount` number
    - `item_id` string: (reference to CommerceItem)
    - `unit_amount` number
    - `unit_quantity` number
    - `item_sku` string
    - `item_name` string
    - `item_description` string
    - `notes` string
    - `taxrate_id` string
    - `account_id` string: (reference to AccountingAccount)
    - `category_ids` string[]
    - `locations` AccountingReference[]
      - `id` string
      - `name` string
    - `item_variants` AccountingReference[]
      - `id` string
      - `name` string
    - `fees` AccountingFee[]
      - `type` 'TAX' | 'DISCOUNT' | 'PROMOTION' | 'SHIPPING' | 'GIFT_WRAP' | 'COD' | 'SURCHARGE' | 'TIP' | 'SERVICE_CHARGE' | 'OTHER', required: Unified fee category
      - `original_type` string: The provider's original fee label, e.g. "VAT" or a shipping carrier name
      - `amount` number, required
      - `currency` string: ISO 4217 currency code, e.g. USD
    - `contact_id` string: (reference to AccountingContact)
    - `project_id` string: ref -> AccountingProject; the project this line is coded to (reference to TaskProject)
    - `exchange_rate` number: The exchange rate applied to this line, for multi-currency documents
    - `is_billable` boolean: True when the line is rebillable to a customer
  - `status` 'DRAFT' | 'VOIDED' | 'AUTHORIZED' | 'PAID' | 'PARTIALLY_PAID' | 'PARTIALLY_REFUNDED' | 'REFUNDED' | 'SUBMITTED' | 'DELETED' | 'OVERDUE'
  - `organization_id` string
  - `apply_amount` number
  - `applications` AccountingCreditApplication[]: What this vendor credit was applied to (invoices/bills). Writable inline on create/update.
    - `object_type` 'INVOICE' | 'BILL': The type of object this credit was applied to
    - `object_id` string: The id of the object this credit was applied to
    - `amount` number: The amount of credit applied to this object
    - `applied_at` string, date-time: Date and time when the credit was applied, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `metadata` AccountingMetadata[]
    - `id` string
    - `slug` string
    - `value` unknown
    - `namespace` string
    - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
    - `extra_data` unknown
  - `raw` unknown

---

[API](https://skmtc.dev/unified/apis/unified-to-api-2.md) · [All operations](https://skmtc.dev/unified/apis/unified-to-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/unified/apis/unified-to-api-2/revisions/7a38bdd7f089?raw)