List invoice lines for export

POST/v1/api/store/{team_slug}/sales_order/invoices/export_all_sales_order_invoice_item

v1Operation ID v1_public_sales_order_invoices_export_all_invoice_items

Returns the invoice lines that come from order lines, one row per line, as JSON in data, for a date range. Tax, shipping, discount and fee lines of an invoice are not listed, and the rows' tax, discount and tax_percent are always null. order_id and invoice_id here are hash ids; the numbers are order_scoped_id and invoice_scoped_id. Amounts are thousandths as strings, an older encoding: "12500" is 12.50. See Money and quantities.

Invoices are picked by their sales order's issue date, not the invoice date, and only for published, non-deleted sales orders.

Here the range covers whole days: start_date from midnight, end_date to the end of its day (UTC). Send ISO 8601 dates, such as 2026-11-01 and 2026-11-30.

Permission

Needs the view_report permission.

Path parameters

• team_slugstringrequired

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

  • Example your-team

Request body

application/json, required.

• end_datestring (date-time)required

  End of the issue date range (ISO 8601).

• start_datestring (date-time)required

  Start of the issue date range (ISO 8601).

Response

200Successful response.

• dataarray of objectsrequired

  One row per invoice line that comes from an order line; [] when none is in the range.

  Fields of each item (25)

  • discountnull

    Always null.

  • has_empty_product_costboolean
  • invoice_idstring

    The invoice's id (a hash id).

  • invoice_scoped_idstring

    The invoice number.

  • job_namestring

    The line's job name, or an empty string.

  • order_creatorstring

    Created By's name, or an empty string.

  • order_creator_idstring

    Created By's user id, or an empty string.

  • order_datestring

    The order's issue date, YYYY-MM-DD in the team's time zone.

  • order_idstring

    The order's id (a hash id).

  • order_namestring | null
  • order_scoped_idstring

    The order number.

  • order_statusstring | null

    The order's status label.

  • order_warehousestring

    The order's warehouse label.

  • product_coststring

    Cost of one unit. Thousandths as a string, an older encoding: "12500" is 12.50. See Money and quantities.

  • product_namestring | null
  • product_totalstring

    Product price of one unit. Thousandths as a string, an older encoding: "12500" is 12.50. See Money and quantities.

  • product_typestring

    The line's kind.

  • quantityinteger | string

    The quantity: a whole number, or a decimal string.

  • service_totalstring

    Decoration price of one unit. Thousandths as a string, an older encoding: "12500" is 12.50. See Money and quantities.

  • servicesstring

    The job's decoration services, comma-separated.

  • statusobject | null

    The order's status record, as stored (not the status answer shape).

  • subtotalstring

    The invoice line's subtotal. Thousandths as a string, an older encoding: "12500" is 12.50. See Money and quantities.

  • taxnull

    Always null: this export has no tax per line.

  • tax_percentnull

    Always null.

  • totalstring

    The same as subtotal. Thousandths as a string, an older encoding: "12500" is 12.50. 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.

  When

  The role lacks view_report. This error has no envelope: the body is {"message": "Insufficient Permission"}.

  Fix

  Ask the team owner for report permission.

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

• 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

  A date is missing or not ISO 8601.

  Fix

  Send both dates.

Related

• POSTList invoices for export/v1/api/store/{team_slug}/sales_order/invoices/export_list
• POSTExport invoice line items in a date range to CSV/v1/api/store/{team_slug}/data_export/export_invoice_item

Example request

curl

curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/sales_order/invoices/export_all_sales_order_invoice_item' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "end_date": "2026-11-30",    "start_date": "2026-11-01"  }'

Example response 200

Response

{
  "data": [
    {
      "discount": null,
      "has_empty_product_cost": false,
      "invoice_id": "QRbvVd2ZKcvSTB",
      "invoice_scoped_id": "1001",
      "job_name": "Front logo",
      "order_creator": "Alex Rivera",
      "order_creator_id": "PydH0WtBhSeiNU",
      "order_date": "2026-11-03",
      "order_id": "V4keXwwxMQyXw7",
      "order_name": "Spring team shirts",
      "order_scoped_id": "SO1001",
      "order_status": "In production",
      "order_warehouse": "Main",
      "product_cost": "6000",
      "product_name": "Team shirt",
      "product_total": "12500",
      "product_type": "user_simple",
      "quantity": 10,
      "service_total": "0",
      "services": "Screen print",
      "subtotal": "125000",
      "tax": null,
      "tax_percent": null,
      "total": "125000"
    }
  ],
  "status": 200,
  "success": true
}