List the lines of an invoice

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

v2Operation ID v2_public_invoice_item_index

Returns every line of an invoice: billed sales order lines, shipping fees, discounts and the tax line. Not paged, and in no set order: sort by position.

product.type	What it is
order_item	Bills a line of the sales order (any kind of product line). Name and unit price come from that line.
shipment_fee	A shipping charge with its own price.
invoice_discount	A discount, as a percentage or a fixed amount.
user_tax	Tax from one of your tax presets.
override_tax	A tax you set by hand: a fixed amount, a percentage, or tax exempt.
auto_tax	US Auto Tax, calculated by YoPrint's tax provider.

The sales order line kinds (db_catalog, user_simple, db_variant, custom, fee) are not invoice kinds: to bill one, add an order_item line that points at it.

Permission

Any member of the team.

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's id (a hash id), as its answers show it. Its unique key (ordinv_...) also works, but API answers don't include it.

  • Example cBRpSf5nw6upt5

Request body

This operation takes no request body.

Response

200Successful response.

• dataarray of objectsrequired
  Fields of each item (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.

      • See Money and quantities.
  • 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.

• 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 invoice id.

Related

• POSTAdd a line to an invoice/v2/api/store/{team_slug}/v2/invoice/{unique_key}/item
• POSTAdd, change and remove invoice lines at once/v2/api/store/{team_slug}/v2/invoice/{unique_key}/item/bulk
• GETGet an invoice/v2/api/store/{team_slug}/v2/invoice/{unique_key}

Example request

curl

curl 'https://secure.yoprint.com/v2/api/store/your-team/v2/invoice/cBRpSf5nw6upt5/item' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": [
    {
      "_meta": {
        "from_legacy": false,
        "id": "nhsGsn84PyJBvK",
        "invoice_id": "cBRpSf5nw6upt5",
        "lock_version": 1730000000000000,
        "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": 1730000000000000,
      "position": 100,
      "position_hash": "EXAMPLEpositionHash",
      "pricing": {
        "_meta": {
          "subtotal": {
            "dp": 0,
            "value": 300
          },
          "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": 24
        },
        "type": "unit"
      },
      "tax": {
        "type": "taxable"
      },
      "type": "order_item"
    }
  ],
  "status": 200,
  "success": true
}