---
title: "🔒 Update credit note line item V3"
method: PATCH
path: "/api/v3/creditNotes/{id}/lineItems/{lineItemId}"
tags: ["CreditNote"]
---

# 🔒 Update credit note line item V3

`PATCH /api/v3/creditNotes/{id}/lineItems/{lineItemId}`

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: `creditNote:update`.

Update a line item in a credit note.

## Path parameters

- `id` string, required
- `lineItemId` string, required

## Request body

- object
  - `name` string — Name of the line item.
  - `description` string — Description of the line item.
  - `deliveryDate` string, date — Delivery date of the line item.
  - `deliveryDateAsCalendarWeek` boolean — Whether to show the delivery date as calendar week or explicit.
  - `internalComment` string — Internal comment for the line item.
  - `sort` integer — Sort order of the line item.
  - `unit` string — Unit of the line item (e.g., "kg", "pcs").
  - `discount` number, float — Discount percentage
  - `price` object — Price information
    - `net` object — Net price
      - `amount` number, float — Net amount
      - `currency` string — Currency code
  - `taxLegalNotice` string — Legal notice regarding tax for this line item
  - `printSettings` object — Print settings for this line item
    - `withoutPrice` boolean — Whether to hide the price for this line item when printing
    - `hidden` boolean — Whether to hide this line item when printing the document

## Response `200`

Update a line item in a credit note.

- object
  - `data` object — Credit Note Line Item
    - `type` 'product'
    - `id` string — ID of the line item.
    - `number` string — The Number of the line item. Usually the product SKU, but can be adjusted if required.
    - `name` string — The name of the line item. Usually the product name, but can be adjusted if required.
    - `description` string — The description of the line item. Usually the product description, but can be adjusted if required.
    - `quantity` number, float — The quantity of the line item.
    - `product` union — The product of the line item.
      - object
        - `id` string, required
        - `number` unknown, required
        - `createdAt` string, date-time — Creation timestamp
        - `updatedAt` string, date-time — Last update timestamp
      - object
        - `id` string
    - `countryOfOrigin` unknown
    - `hsCode` unknown
    - `customFields` object[] — Custom fields with their values and metadata.
      - `key` string
      - `value` string
      - `label` string
    - `unit` string — The unit of the line item.
    - `deliveryDate` string, date — The delivery date of the line item.
    - `deliveryDateAsCalendarWeek` boolean — Whether to show the delivery date as calendar week or explicit.
    - `packagingUnit` string — The unit of packaging for the line item.
    - `internalComment` string — Internal comment, does not show up on the document. Intended to be used for company-internal notes.
    - `customerProductNumber` string — Customer product number for the line item.
    - `order` integer — The ordering sequence of the line item.
    - `updatedAt` string, date-time — The date and time when the line item was last updated.
    - `createdAt` string, date-time — The date and time when the line item was created.
    - `taxRate` union — Tax rate type applied to this line item
      - 'standard' | 'reduced' | 'exempt'
      - number, float
    - `effectiveTaxRate` number, float — Effective tax rate for this line item
    - `price` object — Price information for this line item
      - `net` object — Money
        - `amount` union
          - string
          - number
        - `currency` string — Currency
      - `gross` object — Money
        - `amount` union
          - string
          - number
        - `currency` string — Currency
    - `discount` number, float — Discount percentage applied to this line item
    - `itemRevenue` object — Total revenue for all quantities of this line item
      - `net` object — Money
        - `amount` union
          - string
          - number
        - `currency` string — Currency
      - `gross` object — Money
        - `amount` union
          - string
          - number
        - `currency` string — Currency
    - `lineItemRevenue` object — Revenue for a single unit of this line item
      - `net` object — Money
        - `amount` union
          - string
          - number
        - `currency` string — Currency
      - `gross` object — Money
        - `amount` union
          - string
          - number
        - `currency` string — Currency
    - `purchasePrice` object — Purchase price information for this line item
      - `net` object — Money
        - `amount` union
          - string
          - number
        - `currency` string — Currency
    - `contributionMargin` number, float — Contribution margin for this line item
    - `taxLegalNotice` string — Legal notice regarding tax for this line item
    - `printSettings` object — Print settings for this line item.
      - `withoutPrice` boolean — Hide the prices for this line item when printing.
      - `hidden` boolean — Hide this line item when printing.
    - `salesOrderLineItem` object — sales order line item reference.
      - `id` string — ID of the line item

## Other responses

- `400` — Failed validation
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `409` — Problem occurred
- `429` — Too Many Requests

---

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