---
title: "Replaces the CreditNote resource."
method: PUT
path: "/credit_notes/{id}"
tags: ["CreditNote"]
---

# Replaces the CreditNote resource.

`PUT /credit_notes/{id}`

Replaces the CreditNote resource.

## Path parameters

- `id` string, required

## Request body

- CreditNote
  - `id` string
  - `integration` string — The key of the integration source e.g. "quickbooks", or "xero"
  - `srcId` string, nullable — Unique identifier of the source 3rd party integration
  - `creditnoteNumber` string, nullable — Unique number generated (starts with CN) which will be displayed in the interface and credit notes eg. CN-29
  - `date` string, nullable — The date on which credit note is raised. Format [yyyy-mm-dd] eg. "2016-06-05"
  - `status` string, nullable — Status of the credit note. This can be open, closed or void eg. "open"
  - `customerId` string, nullable — Customer ID of the customer for whom the credit note is raised eg. 903000000000099
  - `customerName` string, nullable — Name of the customer to whom the credit note is raised. Max-Length [100] eg. "Bowman Furniture"
  - `referenceNumber` string, nullable — Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100] eg. "INV-384"
  - `totalAmount` string, nullable — Total of credit note eg. "400"
  - `balance` integer, nullable — Unapplied credits eg. 10
  - `currency` string, nullable — Customers currency code eg. "USD"
  - `notes` string, nullable — Notes on the credit notes eg. "Offer for the referral"
  - `created` string, date-time, nullable — Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z"
  - `modified` string, date-time, nullable — Time at which the recurring invoice was last updated eg. "2013-11-18T02:17:40.080Z"

## Response `200`

CreditNote resource updated

- CreditNote
  - `id` string
  - `integration` string — The key of the integration source e.g. "quickbooks", or "xero"
  - `srcId` string, nullable — Unique identifier of the source 3rd party integration
  - `creditnoteNumber` string, nullable — Unique number generated (starts with CN) which will be displayed in the interface and credit notes eg. CN-29
  - `date` string, nullable — The date on which credit note is raised. Format [yyyy-mm-dd] eg. "2016-06-05"
  - `status` string, nullable — Status of the credit note. This can be open, closed or void eg. "open"
  - `customerId` string, nullable — Customer ID of the customer for whom the credit note is raised eg. 903000000000099
  - `customerName` string, nullable — Name of the customer to whom the credit note is raised. Max-Length [100] eg. "Bowman Furniture"
  - `referenceNumber` string, nullable — Reference number generated for the payment. A string of your choice can also be used as the reference number. Max-Length [100] eg. "INV-384"
  - `totalAmount` string, nullable — Total of credit note eg. "400"
  - `balance` integer, nullable — Unapplied credits eg. 10
  - `currency` string, nullable — Customers currency code eg. "USD"
  - `notes` string, nullable — Notes on the credit notes eg. "Offer for the referral"
  - `created` string, date-time, nullable — Time at which the recurring invoice was created eg. "2013-11-18T02:17:40.080Z"
  - `modified` string, date-time, nullable — Time at which the recurring invoice was last updated eg. "2013-11-18T02:17:40.080Z"

## Other responses

- `400` — Invalid input
- `404` — Resource not found
- `422` — Unprocessable entity

---

[API](https://skmtc.net/bossinsights/apis/boss-insights.md) · [All operations](https://skmtc.net/bossinsights/apis/boss-insights/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bossinsights/boss-insights/versions/d08a107895ad/schema)