Change an invoice number (v1)

PUT/v1/api/store/{team_slug}/invoice/{hash_id}

v1Legacy · deprecatedOperation ID v1_public_invoice_update_put

Sets only the invoice number (scoped_id); nothing else on the invoice can change here. PUT and PATCH behave the same. Returns the invoice.

Prefer Update an invoice: it checks your sales order permission, can change the rest of the header in the same call, and lets the QuickBooks Online sync pick up the change. This route does none of that.

Permission

Any member of the team; no sales order permission is checked.

Side effects

Saves the number only: no recalculation, no QuickBooks Online sync trigger, no refresh of open web app pages.

Path parameters

team_slugstringrequired
Your team slug, shown as Team ID next to your API key in Profile.
- Example your-team
hash_idstringrequired
The invoice's hash id. Hash ids only: a unique key or a document number gives 404.
- Example cBRpSf5nw6upt5

Request body

application/json, required.

scoped_idstringrequired
The new invoice number, as a string. Not checked for duplicates.

Response

200Successful response.

dataobjectrequired
An invoice. Amounts are decimal pairs at the stored scale (4 decimal places for invoice totals), except paid_amount and calc_deposit_total (thousandths). The calc_* totals are deprecated copies of the decimal-pair ones.
Child fields (42)
- auto_invoice_managedboolean
  YoPrint keeps this invoice in step with the order (Auto Invoice).
- bill_to_statusstring
  How Bill To compares with the order's.
  - One of: "okay", "empty", "diff_from_order", "diff_from_customer"
- billing_addressobject | null
  An address.
  Child fields (10)
  - address1string | null
  - address2string | null
  - citystring | null
  - countrystring | null
  - country_codestring | null
  - idstring
    The address.
  - labelstring | null
  - postcodestring | null
  - statestring | null
  - state_codestring | null
- billing_address_idstring | null
  Bill To.
- calc_deposit_totalinteger | number | string | null
  The order's deposit amount. Thousandths, an older encoding: 12500 is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities.
- cart_item_subtotaldecimal pair
  Billed sales order lines and shipping fees (price × quantity); shipment_subtotal is the shipping part of it. total = cart_item_subtotal − discount_subtotal + tax_subtotal (+ credit_card_surcharge). At the stored scale (4 decimal places). 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 Money and quantities.
- created_atstring (date-time)
- credit_card_surchargedecimal pair
  A card surcharge added by a card payment; zero when there is none. Always sent. 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 Money and quantities.
- customerobject | null
  The customer (the full customer record).
  Child fields (2)
  - idstring
    The customer.
  - namestring
- deposit_duestring (date-time) | null
  From the order. ISO 8601 with offset, or null.
- deposit_requiredboolean | integer | null
  From the order.
- discount_subtotaldecimal pair
  Discounts. 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 Money and quantities.
- external_typestring | null
- from_legacyboolean
- full_amount_duestring (date-time) | null
  From the order. ISO 8601 with offset, or null.
- idstring
  The invoice.
- is_externalboolean
- is_paidboolean
  Paid amount covers the total (also true for a zero total).
- is_validboolean
  False when the invoice needs fixing: no lines, lines without a tax line, or a customer that differs from the order's.
- issue_datestring (date-time) | null
  Issue date. ISO 8601 with offset, or null.
- lock_versioninteger
- orderobject
  The sales order or quote in the v2 order shape: its header fields, with status and assigned_users, but no items.
  Child fields (2)
  - idstring
    The order.
  - scoped_idstring | null
- order_idstring
  The sales order or quote it bills.
- order_object_typestring | null
  sales_order or quote.
- order_quoteboolean
  The order is a quote.
- order_scoped_idstring | null
  The order number.
- paid_amountinteger | number | string | null
  Allocated payments. Thousandths, an older encoding: 12500 is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities.
- pdf_urlarray of objects
  PDF links.
  Fields of each item (3)
  - labelstring
  - object_typestring
  - urlstring
    A download link with its own long-lived access token: don't publish it.
- scoped_idstring | null
  The invoice number.
- ship_to_statusstring
  - One of: "okay", "empty", "diff_from_order", "diff_from_customer"
- shipment_subtotaldecimal pair
  Shipping fees (already in cart_item_subtotal). 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 Money and quantities.
- shipment_tax_subtotaldecimal pair
  The tax on shipping (included in tax_subtotal). 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 Money and quantities.
- shipping_addressobject | null
  An address.
  - Same fields as data.billing_address.
- shipping_address_idstring | null
  Ship To.
- tax_subtotaldecimal pair
  Tax. 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 Money and quantities.
- totaldecimal pair
  The invoice total. 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 Money and quantities.
- versioninteger
- calc_delivery_totalinteger | number | string | nulldeprecated
  Deprecated: use shipment_subtotal, the same amount. Thousandths, an older encoding: 12500 is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities.
- calc_discountinteger | number | string | nulldeprecated
  Deprecated: use discount_subtotal, the same amount. Thousandths, an older encoding: 12500 is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities.
- calc_subtotalinteger | number | string | nulldeprecated
  Deprecated: use cart_item_subtotal, the same amount. Thousandths, an older encoding: 12500 is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities.
- calc_taxinteger | number | string | nulldeprecated
  Deprecated: use tax_subtotal, the same amount. Thousandths, an older encoding: 12500 is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities.
- calc_totalinteger | number | string | nulldeprecated
  Deprecated: use total, the same amount. Thousandths, an older encoding: 12500 is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities.
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.
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 invoice isn't your team's.
Fix
Check the hash 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
scoped_id is missing or not a string.
Fix
Send the number as a JSON string.

PUTUpdate an invoice/v2/api/store/{team_slug}/v2/invoice/{unique_key}

Example request

curl

curl -X PUT 'https://secure.yoprint.com/v1/api/store/your-team/invoice/cBRpSf5nw6upt5' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "scoped_id": "1001"  }'

Example response 200

{
  "data": {
    "auto_invoice_managed": false,
    "bill_to_status": "okay",
    "billing_address": {
      "address1": "100 Example Street",
      "address2": null,
      "city": "Austin",
      "country": "United States",
      "country_code": "US",
      "id": "117KfwwfreX15N",
      "label": "Main office",
      "postcode": "78701",
      "state": "Texas",
      "state_code": "TX"
    },
    "billing_address_id": "117KfwwfreX15N",
    "calc_deposit_total": 169880,
    "cart_item_subtotal": {
      "dp": 4,
      "value": 3150000
    },
    "created_at": "2026-11-03T15:00:00+00:00",
    "credit_card_surcharge": {
      "dp": 4,
      "value": 0
    },
    "customer": {
      "id": "ifAHmADekGZ6id",
      "name": "Northwind Apparel"
    },
    "deposit_due": "2026-11-05T00:00:00+00:00",
    "deposit_required": true,
    "discount_subtotal": {
      "dp": 4,
      "value": 0
    },
    "external_type": null,
    "from_legacy": false,
    "full_amount_due": "2026-11-20T00:00:00+00:00",
    "id": "cBRpSf5nw6upt5",
    "is_external": false,
    "is_paid": false,
    "is_valid": true,
    "issue_date": "2026-11-03T00:00:00+00:00",
    "lock_version": 1730000000000000,
    "order": {
      "id": "sFbALVSYD55eXe",
      "scoped_id": "SO1001"
    },
    "order_id": "sFbALVSYD55eXe",
    "order_object_type": "sales_order",
    "order_quote": false,
    "order_scoped_id": "SO1001",
    "paid_amount": 100000,
    "pdf_url": [
      {
        "description": "Invoice pdf",
        "label": "Invoice",
        "object_type": "invoice",
        "url": "https://example.com/pdf/invoice.pdf"
      }
    ],
    "scoped_id": "1001",
    "ship_to_status": "okay",
    "shipment_subtotal": {
      "dp": 4,
      "value": 150000
    },
    "shipment_tax_subtotal": {
      "dp": 4,
      "value": 0
    },
    "shipping_address": {
      "address1": "100 Example Street",
      "address2": null,
      "city": "Austin",
      "country": "United States",
      "country_code": "US",
      "id": "117KfwwfreX15N",
      "label": "Main office",
      "postcode": "78701",
      "state": "Texas",
      "state_code": "TX"
    },
    "shipping_address_id": "117KfwwfreX15N",
    "tax_subtotal": {
      "dp": 4,
      "value": 247500
    },
    "total": {
      "dp": 4,
      "value": 3397500
    },
    "version": 2
  },
  "status": 200,
  "success": true
}

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 spec Support: support@yoprint.com yoprint.com