Skip to main content
GET
/
v2
/
invoices
Get Invoices
curl --request GET \
  --url https://api.example.com/v2/invoices \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "number": "<string>",
      "amount_due": "<string>",
      "amount_paid": "<string>",
      "amount_remaining": "<string>",
      "pending_amount_remaining": "<string>",
      "total_amount": "<string>",
      "due_date": "2023-11-07T05:31:56Z",
      "issued_at": "2023-11-07T05:31:56Z",
      "paid_at": "2023-11-07T05:31:56Z",
      "promised_to_pay_date": "2023-12-25",
      "remote_created_at": "2023-11-07T05:31:56Z",
      "purchase_order_number": "<string>",
      "order_number": "<string>",
      "partner": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "account_number": "<string>",
        "assignee_id": "<string>",
        "business_unit_id": "<string>",
        "email": "<string>",
        "name": "<string>",
        "legal_name": "<string>",
        "phone": "<string>",
        "parent_id": "<string>",
        "remote_id": "<string>",
        "object": "<string>"
      },
      "assignee": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "email": "<string>",
        "name": "<string>",
        "given_name": "<string>",
        "family_name": "<string>",
        "profile_picture": "<string>",
        "object": "<string>"
      },
      "last_outreach_at": "2023-11-07T05:31:56Z",
      "last_outreach_to": "<string>",
      "in_dispute": true,
      "unresolved_dispute_id": "<string>",
      "object": "<string>",
      "days_overdue": 123,
      "days_until_due": 123,
      "payment_url": "<string>"
    }
  ],
  "current_page": 0,
  "total_records": 1,
  "next_page": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.api.stuut.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
page
integer
default:0

Page number, 0 indexed.

Required range: x >= 0
​
limit
integer
default:100

Number of records per page.

Required range: 1 <= x <= 500
​
sort_by
enum<string> | null
Available options:
default,
due_date,
issued_at,
paid_at,
amount_due,
amount_remaining,
pending_amount_remaining,
total_amount,
number,
last_outreach_at,
promised_to_pay_date
​
sort_order
enum<string>
default:desc
Available options:
asc,
desc
​
status__in
enum<string>[] | null

Filter by invoice status. Includes virtual statuses: 'processing' (open with payment), 'partially_paid', 'overdue' (open and past due), 'promised' (open with an upcoming or current promise-to-pay date), 'broken_promise' (open with a promise-to-pay date that has passed).

Available options:
draft,
open,
uncollectible,
paid,
void,
processing,
overdue,
partially_paid,
promised,
broken_promise
​
partner_id
string | null

Filter by partner ID

​
assignee_id
string | null

Filter by assignee ID

​
number__in
string[] | null

Filter by invoice numbers

​
amount_remaining_lte
string<decimal>
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
amount_remaining_gte
string<decimal>
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
in_dispute
boolean

Filter by whether invoice is in dispute

​
due_date__eq
string<date> | null

Due date exactly on

​
due_date__gte
string<date> | null

Due date on or after

​
due_date__lte
string<date> | null

Due date on or before

​
issued_at__eq
string<date> | null

Issued at exactly on

​
issued_at__gte
string<date-time> | null

Issued at on or after

​
issued_at__lte
string<date-time> | null

Issued at on or before

​
promised_to_pay_date__eq
string<date> | null

Promised to pay exactly on

​
promised_to_pay_date__lte
string<date-time> | null

Promised to pay on or before

​
promised_to_pay_date__gte
string<date-time> | null

Promised to pay on or after

​
search
string | null

Search in invoice number, partner name, account number, PO number, order number

​
business_unit_id__in
string[] | null

Filter by business unit IDs (via partner)

​
has_outreach
boolean

Filter by whether invoice has had outreach

​
customer_outreach_paused
boolean

Filter by whether customer outreach is paused

​
currency__in
enum<string>[] | null

Filter by currency codes (ISO 4217, e.g., ['usd', 'eur'])

The 3 character ISO 4217 currency code.

Available options:
ADP,
AED,
AFA,
AFN,
ALK,
ALL,
AMD,
ANG,
AOA,
AOK,
AON,
AOR,
ARA,
ARL,
ARM,
ARP,
ARS,
ATS,
AUD,
AWG,
AZM,
AZN,
BAD,
BAM,
BAN,
BBD,
BDT,
BEC,
BEF,
BEL,
BGL,
BGM,
BGN,
BGO,
BHD,
BIF,
BMD,
BND,
BOB,
BOL,
BOP,
BOV,
BRB,
BRC,
BRE,
BRL,
BRN,
BRR,
BRZ,
BSD,
BTN,
BUK,
BWP,
BYB,
BYN,
BYR,
BZD,
CAD,
CDF,
CHE,
CHF,
CHW,
CLE,
CLF,
CLP,
CNH,
CNX,
CNY,
COP,
COU,
CRC,
CSD,
CSK,
CUC,
CUP,
CVE,
CYP,
CZK,
DDM,
DEM,
DJF,
DKK,
DOP,
DZD,
ECS,
ECV,
EEK,
EGP,
ERN,
ESA,
ESB,
ESP,
ETB,
EUR,
FIM,
FJD,
FKP,
FRF,
GBP,
GEK,
GEL,
GHC,
GHS,
GIP,
GMD,
GNF,
GNS,
GQE,
GRD,
GTQ,
GWE,
GWP,
GYD,
HKD,
HNL,
HRD,
HRK,
HTG,
HUF,
IDR,
IEP,
ILP,
ILR,
ILS,
INR,
IQD,
IRR,
ISJ,
ISK,
ITL,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KPW,
KRH,
KRO,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
LTL,
LTT,
LUC,
LUF,
LUL,
LVL,
LVR,
LYD,
MAD,
MAF,
MCF,
MDC,
MDL,
MGA,
MGF,
MKD,
MKN,
MLF,
MMK,
MNT,
MOP,
MRO,
MRU,
MTL,
MTP,
MUR,
MVP,
MVR,
MWK,
MXN,
MXP,
MXV,
MYR,
MZE,
MZM,
MZN,
NAD,
NGN,
NIC,
NIO,
NLG,
NOK,
NPR,
NZD,
OMR,
PAB,
PEI,
PEN,
PES,
PGK,
PHP,
PKR,
PLN,
PLZ,
PTE,
PYG,
QAR,
RHD,
ROL,
RON,
RSD,
RUB,
RUR,
RWF,
SAR,
SBD,
SCR,
SDD,
SDG,
SDP,
SEK,
SGD,
SHP,
SIT,
SKK,
SLE,
SLL,
SOS,
SRD,
SRG,
SSP,
STD,
STN,
SUR,
SVC,
SYP,
SZL,
THB,
TJR,
TJS,
TMM,
TMT,
TND,
TOP,
TPE,
TRL,
TRY,
TTD,
TWD,
TZS,
UAH,
UAK,
UGS,
UGX,
USD,
USN,
USS,
UYI,
UYP,
UYU,
UYW,
UZS,
VEB,
VED,
VEF,
VES,
VND,
VNN,
VUV,
WST,
XAF,
XAG,
XAU,
XBA,
XBB,
XBC,
XBD,
XCD,
XCG,
XDR,
XEU,
XFO,
XFU,
XOF,
XPD,
XPF,
XPT,
XRE,
XSU,
XTS,
XUA,
XXX,
YDD,
YER,
YUD,
YUM,
YUN,
YUR,
ZAL,
ZAR,
ZMK,
ZMW,
ZRN,
ZRZ,
ZWD,
ZWL,
ZWR
​
custom_fields
string | null

Response

Successful Response

​
data
InvoiceList · object[]
required

The list of records.

​
current_page
integer
default:0
required

The current page.

​
total_records
integer | null
required

Total number of records.

Required range: x >= 0
​
next_page
integer | null
required

The next page number, if one exists.