Export invoices as CSV

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

v1Operation ID v1_public_sales_order_invoices_export

Downloads a CSV file of invoices.

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

200The CSV file.

The answer is a file (text/csv), not JSON. The example saves it with curl -o.

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

  No invoice is in the range: invoice_export_error "Invoices not found".

  Fix

  Widen the range.

Notes

• The answer is a file (text/csv), not JSON.

Related

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

Example request

curl

curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/sales_order/invoices/export' \  -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"  }' \  -o export.csv

Example response 200

A text/csv file.