action codat_get_credit_note {
  label: "Get credit note"
  description: "Gets a single creditNote corresponding to the given ID."
  provider: codat
  method: GET
  path: "/companies/{companyId}/data/creditNotes/{creditNoteId}"
  encoding: json
  output: {
    type: "object"
    description: "> View the coverage for credit notes in the <a className=\"external\" href=\"https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=creditNotes\" target=\"_blank\">Data coverage explorer</a>.\n\n## Overview\n\nThink of a credit note as a voucher issued to a customer. It is a reduction that can be applied against one or multiple invoices. A credit note can either reduce the amount owed or cancel out an invoice entirely.\n\nIn the Codat system a credit note is issued to a [customer's](https://docs.codat.io/accounting-api#/schemas/Customer) accounts receivable. \n\nIt contains details of:\n* The amount of credit remaining and its status.\n* Payment allocations against the payments type, in this case an invoice.\n* Which customers the credit notes have been issued to."
    required: ["discountPercentage", "remainingCredit", "status", "subTotal", "totalAmount", "totalDiscount", "totalTaxAmount"]
  }
}