Skip to main content
POST
/
v1
/
invoices
/
export
Export Invoices
curl --request POST \
  --url http://api.stuut.ai/v1/invoices/export \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sort_order": "asc",
  "sort_by": "amount_due",
  "number": [
    "<string>"
  ],
  "task": "<string>",
  "search": "<string>",
  "assignee": "<unknown>",
  "partner": "<unknown>",
  "amount_remaining": "<string>",
  "status": [
    "draft"
  ],
  "istatus": "<string>",
  "issued_at": "<string>",
  "has_outreach": true,
  "customer_outreach_paused": true,
  "email": "[email protected]"
}
'
{
  "data": {},
  "error": "<string>",
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
accept
enum<string>
default:text/csv
Available options:
t,
e,
x,
/,
c,
s,
v

Body

application/json
​
sort_order
enum<string>
Available options:
asc,
desc
​
sort_by
enum<string>
Available options:
amount_due,
amount_remaining,
due_date,
issued_at,
paid_at,
number,
last_inbound_at,
last_outreach_at,
total_amount
​
number
string[]
​
task
string

The Task identifier, (e.g. tsk_abc123).

​
search
string
​
assignee
any
​
partner
any
​
amount_remaining
string
​
status
enum<string>[]
Available options:
draft,
open,
uncollectible,
paid,
void,
processing,
overdue
​
istatus
string
​
issued_at
string
​
has_outreach
boolean
​
customer_outreach_paused
boolean
​
email
string<email>

Response

Successful response