List invoices for export

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

v1Operation ID v1_public_sales_order_invoices_export_list

Returns invoice rows as JSON in data, one per invoice, for a date range: the invoice CSV export's columns plus a few more. order_id and invoice_id are the numbers people see, not ids. Amounts are decimal strings with 2 decimal places.

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

Send start_date and end_date as ISO 8601 date-times, for example 2026-11-01T00:00:00Z and 2026-11-30T23:59:59Z. They are compared as given, so a date alone means midnight UTC and an end date of 2026-11-30 leaves out most of that day.

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; [] when none is in the range.

  Fields of each item (25)

  • balance_duestring

    Total minus paid. A decimal string with 2 decimal places, such as "1250.00"; parse it as a decimal.

  • customer_contact_namestring | null
  • customer_emailstring | null
  • customer_namestring | null
  • customer_tax_exemptstring | null
    • One of: "TRUE", "FALSE"
  • deliverystring

    Shipping. A decimal string with 2 decimal places, such as "1250.00"; parse it as a decimal.

  • discountstring

    Discount. A decimal string with 2 decimal places, such as "1250.00"; parse it as a decimal.

  • invoice_idstring

    The invoice number (not the id).

  • issue_datestring | null

    The invoice date, YYYY-MM-DD, or null.

  • jobsstring | null

    The jobs, one per line.

  • last_payment_datestring | null

    The order's last payment, YYYY-MM-DD, or null.

  • order_creatorstring

    Created By's name, or an empty string.

  • order_customer_in_hand_datestring

    YYYY-MM-DD, or an empty string.

  • order_idstring

    The order number (not the id).

  • order_issue_datestring

    YYYY-MM-DD in the team's time zone.

  • order_namestring | null
  • order_statusstring | null

    The order's status label.

  • order_warehousestring | null
  • paidstring
    • One of: "TRUE", "FALSE"
  • paid_amountstring

    Paid on this invoice. A decimal string with 2 decimal places, such as "1250.00"; parse it as a decimal.

  • shipping_address1string | null

    The shipping address, in shipping_label, shipping_address1, shipping_address2, shipping_city, shipping_state, shipping_state_code, shipping_country, shipping_country_code and shipping_postcode.

  • subtotalstring

    Invoice subtotal. A decimal string with 2 decimal places, such as "1250.00"; parse it as a decimal.

  • taxstring

    Tax. A decimal string with 2 decimal places, such as "1250.00"; parse it as a decimal.

  • tax_percentagestring | null

    The tax rate in percent, such as "8.25", when the invoice has one rate; otherwise null.

  • totalstring

    Invoice total. A decimal string with 2 decimal places, such as "1250.00"; parse it as a decimal.

• 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

• POSTExport invoices as CSV/v1/api/store/{team_slug}/sales_order/invoices/export
• POSTList invoice lines for export/v1/api/store/{team_slug}/sales_order/invoices/export_all_sales_order_invoice_item

Example request

curl

curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/sales_order/invoices/export_list' \  -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-30T23:59:59Z",    "start_date": "2026-11-01T00:00:00Z"  }'

Example response 200

Response

{
  "data": [
    {
      "balance_due": "85.00",
      "customer_contact_name": "Alex Rivera",
      "customer_email": "alex@example.com",
      "customer_name": "Northwind Apparel",
      "customer_tax_exempt": "FALSE",
      "delivery": "0.00",
      "discount": "0.00",
      "invoice_id": "1001",
      "issue_date": "2026-11-03",
      "jobs": "JOB-1001 Front logo",
      "last_payment_date": "2026-11-03",
      "order_creator": "Alex Rivera",
      "order_customer_in_hand_date": "",
      "order_id": "SO1001",
      "order_issue_date": "2026-11-03",
      "order_name": "Spring team shirts",
      "order_status": "In production",
      "order_warehouse": "Main",
      "paid": "FALSE",
      "paid_amount": "50.00",
      "shipping_address1": "100 Example Street",
      "subtotal": "125.00",
      "tax": "10.00",
      "tax_percentage": "8",
      "total": "135.00"
    }
  ],
  "status": 200,
  "success": true
}