---
title: "GET /bills/creditNotes"
method: GET
path: "/bills/creditNotes"
tags: ["Bill Credit Notes"]
---

# GET /bills/creditNotes

`GET /bills/creditNotes`

Gets the latest bill (vendor) credit notes for a business.

## Query parameters

- `businessName` string, required
- `serviceName` 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'zohoBooks', required
- `startDate` string
- `endDate` string
- `offset` number
- `limit` number
- `orderBy` string
- `totalAmount` number, float
- `remainingCredit` number, float
- `status` 'open' | 'paid' | 'partiallyPaid' | 'void' | 'unknown' | 'draft'

## Response `200`

- GetBillCreditNoteResponseDto
  - `pagination` PaginationMetaData, required
    - `offset` number, required
    - `limit` number, required
    - `count` number, required
  - `meta` BasicStartEndDateReportMetaData, required
    - `reportId` string[], required
    - `serviceName` 'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'myob' | 'zohoBooks' | 'byod', required
    - `businessName` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `startDate` string, date-time, required
    - `endDate` string, date-time, required
  - `count` number, required
  - `data` GetBillCreditNoteDataV1[], required
    - `id` string, required
    - `postedDate` string, date-time, required
    - `allocatedOnDate` string, date-time
    - `currencyRef` CurrencyRef
      - `id` string, required
      - `name` string
      - `symbol` string
    - `currencyRate` number, float
    - `totalDiscount` number, float
    - `discountPercentage` number, float
    - `subTotal` number, float
    - `taxAmount` number, float
    - `totalAmount` number, float, required
    - `remainingCredit` number, float
    - `status` 'open' | 'paid' | 'partiallyPaid' | 'void' | 'unknown' | 'draft', required
    - `memo` string
    - `payments` Payments[]
      - `amount` number, float
      - `paymentId` string
      - `date` string, date-time
    - `sourceModifiedDate` string, date-time
    - `locationRef` LocationRef
      - `id` string
      - `name` string
    - `vendorRef` VendorRef
      - `id` string, required
      - `name` string
    - `lines` InvoiceBillLineItemsV1[]
      - `description` string
      - `unitAmount` number, float
      - `quantity` number, float
      - `discountAmount` number, float
      - `taxAmount` number, float
      - `taxRateRef` TaxRateRef
        - `id` string, required
        - `name` string
        - `effectiveTaxRate` number, float
      - `inventoryRef` InventoryRef
        - `id` string, required
        - `name` string
      - `discountPercentage` number, float
      - `id` string
      - `accountRef` AccountRef
        - `id` string, required
        - `name` string
      - `totalAmount` number, float
      - `subTotal` number, float
      - `trackingCategoryRef` TrackingCategoryRef
        - `id` string, required
        - `name` string
        - `option` string
        - `optionId` string

## Other responses

- `202` — Data in pending state
- `204` — No data available
- `400` — Bad Request Error - Thrown if fields sent via query does not follow specifications
- `401` — Unauthorized - Not logged in or log in expired
- `403` — Forbidden - Not enough permission
- `500` — Server Error

---

[API](https://skmtc.net/railz/apis/fis-accounting-data-as-a-service-api.md) · [All operations](https://skmtc.net/railz/apis/fis-accounting-data-as-a-service-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/railz/fis-accounting-data-as-a-service-api/revisions/5cdfae3fa1fa/schema)