---
title: "Update credit note line"
method: PATCH
path: "/v1/credit-notes/{creditNoteId}/lines/{lineId}"
tags: ["v1 - Credit Notes"]
---

# Update credit note line

`PATCH /v1/credit-notes/{creditNoteId}/lines/{lineId}`

## Request

- Base URL: `https://light.inc` (the document declares no server; this is the origin it was published from)
- URL: `https://light.inc/v1/credit-notes/{creditNoteId}/lines/{lineId}`
- Auth: one of:
  - API key in header `Authorization`
  - HTTP bearer

Updates a line item on a credit note in draft status. Fields sent as `null` clear the value; omitted fields remain unchanged.

## Path parameters

- `creditNoteId` string, uuid, required
- `lineId` string, uuid, required

## Request body

- ExternalUpdateCreditNoteLineRequestV1Model
  - `customProperties` ExternalSetCustomPropertyRequestV1Model[], nullable: List of custom properties for this line
    - `groupId` string, uuid: ID of the custom property group.
    - `valueIds` string[]: IDs of the selected custom property values. It behaves as a PUT operation, so if empty the existing ones will be effectively deleted.
    - `inlineValues` string[], nullable: Inline custom property values (used for TEXT/NUMERIC/DATE/etc. groups). It behaves as a PUT operation, so if empty or null the existing ones will be effectively deleted.
  - `netTransactionAmount` DirectedAmount
    - `amount` integer
    - `dcSign` 'D' | 'C': ⚠️ This enum is not exhaustive; new values may be added in the future.
  - `grossTransactionAmount` DirectedAmount
    - `amount` integer
    - `dcSign` 'D' | 'C': ⚠️ This enum is not exhaustive; new values may be added in the future.
  - `taxTransactionAmount` DirectedAmount
    - `amount` integer
    - `dcSign` 'D' | 'C': ⚠️ This enum is not exhaustive; new values may be added in the future.
  - `description` string, nullable: Line description
  - `ledgerTaxId` string, uuid, nullable: ID of the tax code
  - `ledgerAccountId` string, uuid, nullable: ID of the ledger account
  - `accrualTemplateId` string, uuid, nullable: ID of the accrual template
  - `accrualStartDate` string, date, nullable: Start date for accrual
  - `accrualEndDate` string, date, nullable: End date for accrual

## Response `default`

default response

- ExternalCreditNoteLineV1Model
  - `id` string, uuid: Unique identifier for the object
  - `companyId` string, uuid: ID of the company
  - `creditNoteId` string, uuid: ID of the credit note this line belongs to
  - `grossTransactionAmount` DirectedAmount
    - `amount` integer
    - `dcSign` 'D' | 'C': ⚠️ This enum is not exhaustive; new values may be added in the future.
  - `netTransactionAmount` DirectedAmount
    - `amount` integer
    - `dcSign` 'D' | 'C': ⚠️ This enum is not exhaustive; new values may be added in the future.
  - `description` string, nullable: Description of the credit note line item
  - `ledgerTaxId` string, uuid, nullable: ID of the tax code
  - `taxTransactionAmount` DirectedAmount
    - `amount` integer
    - `dcSign` 'D' | 'C': ⚠️ This enum is not exhaustive; new values may be added in the future.
  - `ledgerAccountId` string, uuid, nullable: ID of the ledger account
  - `costCenterId` string, uuid, nullable: ID of the cost center
  - `createdAt` string, date-time: Timestamp when the credit note line item was created
  - `updatedAt` string, date-time: Timestamp when the credit note line item was last updated
  - `accrualTemplateId` string, uuid, nullable: ID of the accrual template
  - `accrualStartDate` string, date, nullable: Start date for accrual
  - `accrualEndDate` string, date, nullable: End date for accrual
  - `accrualDefaultDuration` integer, nullable: Default duration for accrual in months

---

[API](https://skmtc.dev/light/apis/light-api.md) - [All operations](https://skmtc.dev/light/apis/light-api/llms.txt) - [OpenAPI document](https://skmtc.dev/light/apis/light-api/revisions/84f51306f648?raw)