Skip to content
YoPrintDevelopers

Update an invoice line

Open .md

PUT/v2/api/store/{team_slug}/v2/invoice/item/{unique_key}

v2Operation ID v2_public_invoice_item_update

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_slugstringrequired

    Your team slug, shown as Team ID next to your API key in Profile.

    • Example your-team
  • unique_keystringrequired

    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

application/json, required.

  • lock_versioninteger

    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.

  • positioninteger

    Where the line sits on the invoice; lower comes first. Not checked against other lines.

  • pricingobject
    Child fields (2)
    • typestringrequired
      • Always "fee"
    • productobjectrequired
      Child fields (1)
      • totaldecimal pairrequired

        The fee. Rounded half-up to 6 decimal places.

        • { "value": 1250, "dp": 2 } is 12.50: value holds the digits, dp the decimal places. See Money and quantities.
  • productobject
    Child fields (2)
    • typestringrequired
      • One of: "order_item", "shipment_fee", "invoice_discount", "user_tax", "override_tax", "auto_tax"
    • propertiesobject

      The fields of that kind you change, as on create. Fields you leave out keep their values.

  • quantityobject

    How many to bill. Not negative; you may bill more than was ordered.

    Child fields (2)
    • typestringrequired
      • Always "unit"
    • totaldecimal pairrequired

      The quantity, up to 8 decimal places.

      • { "value": 1250, "dp": 2 } is 12.50: value holds the digits, dp the decimal places. See Money and quantities.
  • taxobject

    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.

    Child fields (1)
    • typestringrequired
      • One of: "taxable", "non_taxable"
More examples (2)

Bill 12 instead

curl
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"    }  }'

Reload a tax preset's current rate

curl
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

200Successful response.

  • dataobjectrequired

    What happened, and the line.

    Child fields (5)
    • object_typestring
      • Always "invoice_item"
    • action_performedstring

      NONE when nothing changed.

      • One of: "CREATED", "UPDATED", "DELETED", "NONE"
    • has_changesboolean
    • itemobject

      An invoice line.

      Child fields (15)
      • _metaobject

        Read-only: id, type, invoice_id, lock_version, from_legacy, position_hash.

      • auto_invoice_managedboolean

        YoPrint manages this line (Auto Invoice).

      • external_idsarray of objects

        Links to external systems; empty for lines made in YoPrint.

      • external_typestring | null
      • from_legacyboolean
      • idstring

        The invoice line.

      • invoice_idstring

        The invoice.

      • is_externalboolean
      • lock_versioninteger

        Send it back on Update an invoice line to detect a concurrent change.

      • positioninteger
      • pricingobject

        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.

        Child fields (1)
        • typestring
          • One of: "system", "fee"
      • productobject
        Child fields (3)
        • _metaobject

          Read-only details, always an object (with editable_fields_on_update); for order_item, parent describes the sales order line.

        • propertiesobject

          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).

        • typestring
          • One of: "order_item", "shipment_fee", "invoice_discount", "user_tax", "override_tax", "auto_tax", "invoice_surcharge"
      • quantityobject

        Absent on tax and discount lines.

        Child fields (2)
        • typestring
          • Always "unit"
        • totaldecimal pair

          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.

      • taxobject

        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.

        Child fields (1)
        • typestring
          • One of: "taxable", "non_taxable"
      • typestring

        Same as product.type.

    • lock_versionobject

      Lock versions after the change.

      Child fields (2)
      • invoiceobject

        The invoice's lock versions: invoice_item_lock_version, invoice_lock_version.

      • orderobject

        The order's lock versions: job_lock_version, invoice_lock_version, order_item_lock_version, shipment_lock_version, payment_lock_version, order_lock_version.

  • statusintegerrequired
  • successbooleanrequired

Errors

  • 401The API key is missing or wrong (unauthenticated).

  • 403You 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.

  • 404Not 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.

  • 422The 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.

AI agents: read /llms.txt; add .md to any page URL for its Markdown. Guides and concepts in one file: /llms-full.txt.

Download the OpenAPI specSupport: support@yoprint.comyoprint.com