---
title: "Retrieves a single credit note by its Transaction ID, including line items and invoice allocations."
method: GET
path: "/api/CreditNote/{id}"
tags: ["CreditNote"]
---

# Retrieves a single credit note by its Transaction ID, including line items and invoice allocations.

`GET /api/CreditNote/{id}`

## Path parameters

- `id` integer, required

## Response `200`

Returns the credit note details with line items and allocations.

- CreditNote — A customer credit note with line items and allocations to invoices.
  - `TransactionID` integer — Unique identifier for the credit note transaction.
  - `TransactionPrefix` string — Prefix used in the credit note number.
  - `CreditNoteNumber` string — The full credit note number including prefix.
  - `CustomerIDFK` integer — The customer company ID this credit note is issued to.
  - `DateIssued` string, date-time — The date the credit note was issued.
  - `TransactionStatusCode` string — Current status of the credit note.
  - `Balance` number, double — Unallocated balance remaining on the credit note.
  - `CurrencyCode` string — ISO 3-character currency code for the credit note.
  - `TotalAmount` number, double — Total credit note amount.
  - `Notes` string — Additional notes on the credit note.
  - `DateCreated` string, date-time — Date and time the record was created.
  - `DateUpdated` string, date-time — Date and time the record was last updated.
  - `CreditNoteAllocations` CreditNoteAllocation[] — List of allocations applying this credit note against invoices.
    - `TransactionAllocationID` integer — Unique identifier for this allocation.
    - `InvoiceTransactionIDFK` integer — The invoice Transaction ID this credit note is allocated against.
    - `CreditNoteTransactionIDFK` integer — The credit note Transaction ID this allocation belongs to.
    - `AllocationDate` string, date-time — The date this allocation was applied.
    - `AllocationAmount` number, double — The amount allocated from the credit note to the invoice.
  - `CreditNoteLineItems` CreditNoteLineItem[] — Line items on this credit note.
    - `TransactionLineItemID` integer — Unique identifier for the line item.
    - `Description` string — Text description for the line item.
    - `Quantity` number, double — Quantity of items on this line.
    - `UnitPrice` number, double — Price per unit for this line item.
    - `TaxAmount` number, double — Calculated tax amount on this line item.
    - `TaxIDFK` integer — The tax rate ID applied to this line item.
    - `Amount` number, double — Calculated line total (Quantity x UnitPrice less Discount).
    - `Discount` number, double — Discount percentage applied to this line item.
  - `ViewCreditNoteURL` string — URL to view this credit note in the Avaza web application.

## Other responses

- `401` — Unauthorized
- `404` — Not Found

---

[API](https://skmtc.net/avaza/apis/avaza-api-documentation.md) · [All operations](https://skmtc.net/avaza/apis/avaza-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/avaza/avaza-api-documentation/versions/1eeadf750514/schema)