`invoices.list`

List invoices with number, customer, project, dates, totals, balance due, and status. Filter by status (including open, unpaid, upcoming and needs_action: awaiting approval, ready to send by hand, or late), overdue, customer, project (or none), currency, source (manual, duplicate, recurring, plan, import), schedule, issue or due date range, or search text. Archived invoices are left out unless archived is only or include. Sort by issued, due, amount, number, updated or created. Overdue is derived from the due date and remaining balance.

GETPOST/api/v1/accounting/invoices.list

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_invoices_list

Fields

statusenum
Only include records with this status.
draftscheduledawaiting_approvalapprovedsentpartially_paidpaidoverduevoiduncollectibleopenupcomingunpaidneeds_action
partyIdstring (ID)
The ID of a customer or vendor account, from parties.list.
scheduleIdstring (ID)
The ID of the related record.
projectIdstring (ID) or "none"
none
currencystring
Three-letter currency code, such as CAD or USD.
sourceenum
Where the record came from.
manualduplicaterecurringplanimport
archivedenum
Whether the record is archived.
excludeonlyinclude
Default "exclude"
fromstring
The first date to include, as YYYY-MM-DD.
tostring
The last date to include, as YYYY-MM-DD.
dueFromstring
dueTostring
searchstring
Text to search for.
at most 200 characters
overdueboolean
sortenum
issueddueamountnumberupdatedcreated
directionenum
ascdesc
limitinteger
How many results to return at most.
1 to 200 · Default 50
offsetinteger
How many results to skip, for the next page of a list.
0 to 100000 · Default 0

curl https://app.getoatmilk.com/api/v1/accounting/invoices.list \
  -H "Authorization: Bearer $OATMILK_API_KEY"

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/invoices.list", {
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
  },
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os

import requests

response = requests.get(
    "https://app.getoatmilk.com/api/v1/accounting/invoices.list",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Response

{
  "data": { … }
}

Try it

Checks your input with this action’s real schema and answers like the API, with synthetic data. No key needed, and nothing changes.

Input

GET/api/v1/accounting/invoices.list

curl https://app.getoatmilk.com/api/v1/accounting/invoices.list \
  -H "Authorization: Bearer $OATMILK_API_KEY"

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/invoices.list", {
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
  },
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os

import requests

response = requests.get(
    "https://app.getoatmilk.com/api/v1/accounting/invoices.list",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Fields

Example

Try it