---
title: "Replace credit note (draft only)"
method: PUT
path: "/creditnotes/{id}/"
tags: ["Billing"]
---

# Replace credit note (draft only)

`PUT /creditnotes/{id}/`

## Request body

- CreditNote
  - `id` integer
  - `invoice` string, required — Invoice ID this credit note adjusts.
  - `document` integer, nullable — Credit-note document type. Optional; the biller may assign one at finalize.
  - `number` integer
  - `date` string, date, required
  - `note` string, nullable
  - `internal_note` string, nullable
  - `amount` number, nullable
  - `exempt` number, nullable
  - `tax` number, nullable
  - `tax_percent` number, nullable
  - `subtotal` number, nullable
  - `total` number, nullable
  - `retention` number, nullable
  - `discount` number, nullable
  - `discount_scheme` '%' | '$', nullable
  - `status` 'draft' | 'finalized' | 'cancelled'
  - `biller_status` string
  - `tax_agency` object
  - `local_file` string, uri, nullable
  - `imported` boolean
  - `test_mode` boolean
  - `lines` CreditNoteLine[]
    - `id` integer
    - `name` string, required
    - `description` string, nullable
    - `amount` number, required
    - `quantity` number, required
    - `exempt` boolean, required
    - `tax` number, nullable
    - `tax_percent` number, nullable
    - `total` number
    - `discount` number, nullable
    - `discount_scheme` '%' | '$', nullable
    - `code` string, nullable
    - `code_scheme` string, nullable
    - `retention` number, nullable
    - `retention_percent` number
    - `retention_scheme` 'subtotal' | 'tax'
  - `created` string, date-time
  - `updated` string, date-time

## Response `200`

Updated credit note.

- CreditNote
  - `id` integer
  - `invoice` string, required — Invoice ID this credit note adjusts.
  - `document` integer, nullable — Credit-note document type. Optional; the biller may assign one at finalize.
  - `number` integer
  - `date` string, date, required
  - `note` string, nullable
  - `internal_note` string, nullable
  - `amount` number, nullable
  - `exempt` number, nullable
  - `tax` number, nullable
  - `tax_percent` number, nullable
  - `subtotal` number, nullable
  - `total` number, nullable
  - `retention` number, nullable
  - `discount` number, nullable
  - `discount_scheme` '%' | '$', nullable
  - `status` 'draft' | 'finalized' | 'cancelled'
  - `biller_status` string
  - `tax_agency` object
  - `local_file` string, uri, nullable
  - `imported` boolean
  - `test_mode` boolean
  - `lines` CreditNoteLine[]
    - `id` integer
    - `name` string, required
    - `description` string, nullable
    - `amount` number, required
    - `quantity` number, required
    - `exempt` boolean, required
    - `tax` number, nullable
    - `tax_percent` number, nullable
    - `total` number
    - `discount` number, nullable
    - `discount_scheme` '%' | '$', nullable
    - `code` string, nullable
    - `code_scheme` string, nullable
    - `retention` number, nullable
    - `retention_percent` number
    - `retention_scheme` 'subtotal' | 'tax'
  - `created` string, date-time
  - `updated` string, date-time

---

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