# Update an invoice line

```http
PUT https://secure.yoprint.com/v2/api/store/{team_slug}/v2/invoice/item/{unique_key}
```

- API version: v2
- Operation ID: `v2_public_invoice_item_update`
- Section: Invoices and payments › [Invoice line items](https://developer.yoprint.com/reference/invoice-line-items.md)
- Web page: https://developer.yoprint.com/reference/invoice-line-items/v2-invoice-item-update/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Changes one invoice line and recalculates the invoice. Send only what you change; returns the line in an action envelope (`action_performed` `UPDATED`, or `NONE` with `has_changes` false when nothing changed).

What you can change:

| Kind | Changeable |
| --- | --- |
| `order_item` | `quantity`, `tax.type`, `position`. Not which sales order line it bills. |
| `shipment_fee` | `name`, `description`, `shipping_taxable`, the `pricing` fee, `position`. |
| `invoice_discount` | `name`, `description`, `type`, `rate`, `applies_to_shipping`, `position`. |
| `user_tax` | `id` (switch preset), `description`, `shipping_taxable`, `apply_before_discount`, `refresh_tax_rate`. Always send `properties.id`. When you switch preset or send `refresh_tax_rate`, `shipping_taxable` and `apply_before_discount` are taken from the preset and the values you send are ignored. |
| `override_tax` | `mode`, `total`, `description`, `shipping_taxable`, `apply_before_discount`. |
| `auto_tax` | Send the full `properties` again; the rate is fetched again from the provider. |

Updating an `order_item` line also copies the sales order line's current unit price again. Numbers are `{ value, dp }` pairs: `value` is the number without its decimal point and `dp` the count of decimal places, so 12.50 is `{ "value": 1250, "dp": 2 }` (or `{ "value": 125, "dp": 1 }`). `value` is a JSON integer or a digit string, never a float. Quantities take up to 8 decimal places, a discount `rate` 4 and a manual tax `total` 6; more decimals are a 422 `validation_failed`. A shipping fee price is rounded half-up to 6 decimal places (a float `value` there is 422 `amount_out_of_range`). Send very large numbers as strings. Answers send prices at the stored scale (6 decimal places), quantities without trailing zeros, and `_meta.subtotal` (price × quantity) at the combined scale, compacted when it would exceed a safe integer: always read `dp`.

## Permission

Needs permission to edit the invoice's sales order: the team owner, a role whose Manage Sales Orders permission is "update all", or "update assigned" when you created the order or are assigned to it, or, on a draft order, its creator when their role can create sales orders. Otherwise 403 `user_is_not_authorized`. Reading needs only team membership.

## Business rules

- A line's kind can't change: 422 "Cannot update the product type...".
- On an Auto Invoice invoice (`auto_invoice_managed: true`), YoPrint automatically updates invoice lines to match the sales order's product lines and shipping fees. You cannot add, edit, or delete its order lines, or edit or delete the shipping fees and discounts created by YoPrint. You can still add your own custom discounts and shipping fees; YoPrint always places them after the managed lines regardless of the `position` you send.
- Updating a tax line makes it yours: YoPrint stops managing it, even when nothing else changes.
- Lines synced from an external system accept only `position`.

## Side effects

- Recalculates the invoice: line totals, subtotal, shipping, discounts, tax and total.
- Updates the sales order's invoiced totals and each line's invoiced status (not invoiced, partly, fully, or over-invoiced), and automatically redistributes (reallocates) recorded payments across the order's invoices to match updated totals (funds frozen by an open dispute or review stay where they are).
- When the team syncs to QuickBooks Online automatically and the order is published, the order is synced again about 3 minutes later (not after a change of `position` only).
- Open Admin Portal pages refresh, and so do Customer Portal pages the order's customer has open. No webhook or email is sent.
- Updating an `auto_tax` line calls the tax provider while you wait.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.
- `unique_key` (string, required): The invoice line's `id` (a hash id), as its answers show it. Its unique key (`ordinvitm_...`) also works, but API answers don't include it. Example `nhsGsn84PyJBvK`.

## Request body

Content type `application/json`, required.

Fields:

- `lock_version` (integer, optional): The line's `lock_version` when you read it. If someone saved the line since, the update is refused with 422 `optimistic_lock_conflict`. Omit (or send 0) to skip the check.
- `position` (integer, optional): Where the line sits on the invoice; lower comes first. Not checked against other lines.
- `pricing` (object, optional)
  - `type` (string, required): Always `"fee"`.
  - `product` (object, required)
    - `total` (decimal pair, required): The fee. Rounded half-up to 6 decimal places. `{ "value": 1250, "dp": 2 }` is 12.50 (see https://developer.yoprint.com/concepts/money-and-quantities.md).
- `product` (object, optional)
  - `type` (string, required): One of: `"order_item"`, `"shipment_fee"`, `"invoice_discount"`, `"user_tax"`, `"override_tax"`, `"auto_tax"`.
  - `properties` (object, optional): The fields of that kind you change, as on create. Fields you leave out keep their values.
- `quantity` (object, optional): How many to bill. Not negative; you may bill more than was ordered.
  - `type` (string, required): Always `"unit"`.
  - `total` (decimal pair, required): The quantity, up to 8 decimal places. `{ "value": 1250, "dp": 2 }` is 12.50 (see https://developer.yoprint.com/concepts/money-and-quantities.md).
- `tax` (object, optional): Sales order lines (`order_item`) only: whether the line is taxed (default `taxable`). Ignored on other kinds: shipping is taxed by the tax line's `shipping_taxable`.
  - `type` (string, required): One of: `"taxable"`, `"non_taxable"`.

### Example request

```bash
curl -X PUT 'https://secure.yoprint.com/v2/api/store/your-team/v2/invoice/item/nhsGsn84PyJBvK' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1' \
  -H 'Content-Type: application/json' \
  -d '{
    "product": {
      "properties": {
        "rate": {
          "dp": 0,
          "value": 15
        }
      },
      "type": "invoice_discount"
    }
  }'
```

Another example: Bill 12 instead:

```bash
curl -X PUT 'https://secure.yoprint.com/v2/api/store/your-team/v2/invoice/item/nhsGsn84PyJBvK' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1' \
  -H 'Content-Type: application/json' \
  -d '{
    "lock_version": 1730000000000000,
    "quantity": {
      "total": {
        "dp": 0,
        "value": 12
      },
      "type": "unit"
    }
  }'
```

Another example: Reload a tax preset's current rate:

```bash
curl -X PUT 'https://secure.yoprint.com/v2/api/store/your-team/v2/invoice/item/nhsGsn84PyJBvK' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1' \
  -H 'Content-Type: application/json' \
  -d '{
    "product": {
      "properties": {
        "id": "KC48n7qAAfGYMM",
        "refresh_tax_rate": true
      },
      "type": "user_tax"
    }
  }'
```

## Response

`200` Successful response.

Fields:

- `data` (object, required): What happened, and the line.
  - `object_type` (string, optional): Always `"invoice_item"`.
  - `action_performed` (string, optional): `NONE` when nothing changed. One of: `"CREATED"`, `"UPDATED"`, `"DELETED"`, `"NONE"`.
  - `has_changes` (boolean, optional)
  - `item` (object, optional): An invoice line.
    - `_meta` (object, optional): Read-only: `id`, `type`, `invoice_id`, `lock_version`, `from_legacy`, `position_hash`.
    - `auto_invoice_managed` (boolean, optional): YoPrint manages this line (Auto Invoice).
    - `external_ids` (array of objects, optional): Links to external systems; empty for lines made in YoPrint.
    - `external_type` (string | null, optional)
    - `from_legacy` (boolean, optional)
    - `id` (string, optional): The invoice line.
    - `invoice_id` (string, optional): The invoice.
    - `is_external` (boolean, optional)
    - `lock_version` (integer, optional): Send it back on Update an invoice line to detect a concurrent change.
    - `position` (integer, optional)
    - `pricing` (object, optional): Absent on tax and discount lines. `system` (sales order lines): `_meta.unit_price` is the price copied from the sales order line and `_meta.subtotal` is that price × this line's quantity. `fee` (shipping fees): `product.total` is the fee. Prices come at the stored scale (6 decimal places); `_meta.subtotal` at the combined scale of price × quantity (compacted when large). Always read `dp`.
      - `type` (string, optional): One of: `"system"`, `"fee"`.
    - `product` (object, optional)
      - `_meta` (object, optional): Read-only details, always an object (with `editable_fields_on_update`); for `order_item`, `parent` describes the sales order line.
      - `properties` (object, optional): The kind's fields; for `order_item`, `id` is the sales order line. A discount's percentage or amount comes back as `total` (you send it as `rate`).
      - `type` (string, optional): One of: `"order_item"`, `"shipment_fee"`, `"invoice_discount"`, `"user_tax"`, `"override_tax"`, `"auto_tax"`, `"invoice_surcharge"`.
    - `quantity` (object, optional): Absent on tax and discount lines.
      - `type` (string, optional): Always `"unit"`.
      - `total` (decimal pair, optional): The quantity. A decimal pair: the amount is `value` ÷ 10^`dp` (`{ "value": 1250, "dp": 2 }` is 12.50). Read `dp` every time: it can differ between fields and records. See https://developer.yoprint.com/concepts/money-and-quantities.md.
    - `tax` (object, optional): Absent on tax and discount lines. YoPrint adds it by default only to sales order lines (`taxable`); other lines have it only when it was sent.
      - `type` (string, optional): One of: `"taxable"`, `"non_taxable"`.
    - `type` (string, optional): Same as `product.type`.
  - `lock_version` (object, optional): Lock versions after the change.
    - `invoice` (object, optional): The invoice's lock versions: `invoice_item_lock_version`, `invoice_lock_version`.
    - `order` (object, optional): The order's lock versions: `job_lock_version`, `invoice_lock_version`, `order_item_lock_version`, `shipment_lock_version`, `payment_lock_version`, `order_lock_version`.
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": {
    "action_performed": "UPDATED",
    "has_changes": true,
    "item": {
      "_meta": {
        "from_legacy": false,
        "id": "nhsGsn84PyJBvK",
        "invoice_id": "cBRpSf5nw6upt5",
        "lock_version": 1730000000000002,
        "position_hash": "EXAMPLEpositionHash",
        "type": "order_item"
      },
      "auto_invoice_managed": false,
      "external_ids": [],
      "external_type": null,
      "from_legacy": false,
      "id": "nhsGsn84PyJBvK",
      "invoice_id": "cBRpSf5nw6upt5",
      "is_external": false,
      "lock_version": 1730000000000002,
      "position": 100,
      "position_hash": "EXAMPLEpositionHash",
      "pricing": {
        "_meta": {
          "subtotal": {
            "dp": 0,
            "value": 150
          },
          "unit_price": {
            "dp": 6,
            "value": 12500000
          }
        },
        "type": "system"
      },
      "product": {
        "_meta": {
          "parent": {
            "product_name": "Gildan 5000 T-shirt"
          }
        },
        "properties": {
          "id": "ZJTJ2uF5dMiArL"
        },
        "type": "order_item"
      },
      "quantity": {
        "total": {
          "dp": 0,
          "value": 12
        },
        "type": "unit"
      },
      "tax": {
        "type": "taxable"
      },
      "type": "order_item"
    },
    "lock_version": {
      "invoice": {
        "invoice_item_lock_version": 1730000000000000,
        "invoice_lock_version": 1730000000000000
      },
      "order": {
        "invoice_lock_version": 1730000000000000,
        "job_lock_version": 1730000000000000,
        "order_item_lock_version": 1730000000000000,
        "order_lock_version": 1730000000000000,
        "payment_lock_version": 1730000000000000,
        "shipment_lock_version": 1730000000000000
      }
    },
    "object_type": "invoice_item"
  },
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
  - When: Your role can't edit this order. Fix: Ask the team owner to adjust your role or assign you to the order.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.
  - When: The line isn't your team's. Fix: Check the line id.
- `422` The request was refused and changed nothing. `validation_failed` lists what to fix in `error.fields`; other codes name a business rule, explained in `error.message`. A few checks answer with only `{"message": "..."}`. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer `connect_timeout` ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.
  - When: Someone saved the line since you read it (`optimistic_lock_conflict`, "Invoice item was modified in another window. Reload and retry."). Fix: Read the line again and resend with its new `lock_version`.
  - When: Validation or a business rule fails (see Add a line to an invoice). Fix: Read `error.message` and `error.fields`.

## Related

- [Get an invoice line](https://developer.yoprint.com/reference/invoice-line-items/v2-invoice-item-show.md): `GET /v2/api/store/{team_slug}/v2/invoice/item/{unique_key}`
- [Add, change and remove invoice lines at once](https://developer.yoprint.com/reference/invoice-line-items/v2-invoice-item-bulk.md): `POST /v2/api/store/{team_slug}/v2/invoice/{unique_key}/item/bulk`