---
title: "Get Credit Note List"
method: GET
path: "/api/v1/CreditNotes/list"
tags: ["CreditNotes"]
---

# Get Credit Note List

`GET /api/v1/CreditNotes/list`

## Query parameters

- `dateStart` string — The date from which the document listings are displayed, starting from the specified date
- `dateEnd` string — The date from which the document listings are displayed, ending from the specified date
- `status` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11
- `searchText` string — Related keyword used for searching data entries
- `limit` integer — Maximum number of entries to retrieve
- `page` integer — Page number for displaying data, where each page will show 10 entries

## Headers

- `Time-Stamp` string, required
- `Time-Signature` string, required
- `User-Token` string, required
- `Client-Token` string, required

## Response `200`

Success

- PeakWCFModelsAPIResponseResponseCreditNoteListModel
  - `peakCreditNotes` PeakWCFModelsAPIBodyAPIBodyCreditNoteList
    - `creditNotes` PeakWCFModelsAPIAPITransactionsAPITransactionsModel[]
      - `resCode` string
      - `resDesc` string
      - `id` string
      - `code` string
      - `issuedDate` string
      - `dueDate` string
      - `contactId` string
      - `contactCode` string
      - `reference` string
      - `status` string
      - `isTaxInvoice` integer
      - `isVoid` integer
      - `preTaxAmount` number, double
      - `vatAmount` number, double
      - `netAmount` number, double
      - `whtAmount` number, double
      - `paymentAmount` number, double
      - `remainAmount` number, double
      - `remainWhtAmount` number, double
      - `documentLink` string
      - `onlineViewLink` string
      - `isPartialReceipt` integer
      - `remark` string
      - `taxStatus` integer
      - `discountTotal` string
      - `tags` string[]
      - `products` PeakWCFModelsAPIAPITransactionsAPITransactionProducts[]
        - `id` string
        - `productId` string
        - `productCode` string
        - `accountCode` string
        - `accountSubId` string
        - `accountSubCode` string
        - `description` string
        - `quantity` number, double
        - `price` number, double
        - `discount` string
        - `vatType` integer
        - `isDescription` integer
        - `withHoldingTaxAmount` string
      - `paidPayments` PeakWCFModelsAPIAPITransactionsAPITransactionPayments[]
        - `id` string
        - `paymentDate` string
        - `withHoldingTaxAmount` string
        - `paymentGroupId` integer
        - `paymentTotal` number, double
        - `payments` PeakWCFModelsAPIAPITransactionsAPITransactionPaymentLists[]
          - `paymentMethodId` string
          - `paymentMethodCode` string
          - `accountCode` string
          - `accountSubId` string
          - `accountSubCode` string
          - `amount` number, double
          - `note` string
          - `isCheque` integer
          - `cheque` PeakWCFModelsAPIAPITransactionsAPITransactionChequePayment
            - `chequeDate` string
            - `paymentMethodId` string
            - `paymentMethodCode` string
            - `bankId` integer
            - `bankName` string
            - `amount` number, double
            - `chequeNo` string
            - `branchNo` string
            - `accountNo` string
            - `isDeposited` integer
        - `journals` PeakWCFModelsAPIAPITransactionsAPITransactionJournals[]
          - `id` string
          - `code` string
        - `referenceCode` string
        - `referenceId` string
        - `referenceType` string
      - `billingNotes` PeakWCFModelsAPIAPITransactionsAPITransactionBillingNotes[]
        - `id` string
        - `code` string
        - `amount` number, double
        - `isPaid` integer
      - `creditNotes` PeakWCFModelsAPIAPITransactionsAPITransactionCreditNotes[]
        - `id` string
        - `code` string
        - `creditAmount` number, double
        - `deductedAmount` number, double
        - `refundedAmount` number, double
      - `journals` PeakWCFModelsAPIAPITransactionsAPITransactionJournals[]
        - `id` string
        - `code` string
      - `referenceCode` string
      - `referenceId` string
      - `referenceType` string
      - `statusId` integer
      - `currency` PeakWCFModelsAPIAPITransactionsAPITransactionCurrency
        - `currencyId` integer
        - `exchangeRate` number, double
      - `receivedTaxInvoice` PeakWCFModelsAPIAPITransactionsAPITransactionReceivedTaxInvoice
        - `taxInvoiceNumber` string
        - `taxInvoiceDate` string
        - `journalDate` string
        - `periodDate` string
    - `totalCreditNote` integer
    - `resDesc` string
    - `resCode` string
  - `eventType` string
  - `apiType` string

---

[API](https://skmtc.net/peakaccount/apis/peakapis-core.md) · [All operations](https://skmtc.net/peakaccount/apis/peakapis-core/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/peakaccount/peakapis-core/versions/516e79534d77/schema)