Servers Playground How we check Add a server Log in

Invoiced MCP by usefulapi

Working · 449 ms

io.usefulapi/invoicedv1.8.0 Domain verified

Read Invoiced customers, invoices, payments, subscriptions; create customers, draft invoices, notes.

Finance & Payments

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://invoiced.usefulapi.io/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

invoiced_add_note

WRITE: add an internal note to a customer or an invoice (give exactly one). Notes are internal; nothing is sent. POST /notes.

notesstring, required

The note text.

invoice_idinteger

Invoice to attach the note to.

customer_idinteger

Customer to attach the note to.

This tool isn't marked read-only, so it may change something on the server or in an account you connected.

I understand, run it anyway

Invoiced MCP by usefulapi MCP server | mcptry

Tools (27)

invoiced_add_note

WRITE: add an internal note to a customer or an invoice (give exactly one). Notes are internal; nothing is sent. POST /notes.

Argument	Type	Description
notes*	string	The note text.
invoice_id	integer	Invoice to attach the note to.
customer_id	integer	Customer to attach the note to.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "notes"
  ],
  "properties": {
    "notes": {
      "type": "string",
      "maxLength": 5000,
      "minLength": 1,
      "description": "The note text."
    },
    "invoice_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Invoice to attach the note to.",
      "exclusiveMinimum": 0
    },
    "customer_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Customer to attach the note to.",
      "exclusiveMinimum": 0
    }
  }
}

invoiced_create_customer

WRITE: create a customer in Invoiced. Nothing is sent to anyone and no money moves. Name is required; Invoiced generates the customer number unless given. POST /customers.

Argument	Type	Description
city	string
name*	string	Customer name.
type	string	Default company.
email	string
notes	string	Private notes.
phone	string
state	string
number	string	Customer number (default: generated).
tax_id	string
country	string
address1	string
address2	string
currency	string
metadata	object	Metadata key/values (max 10 keys, names up to 40 characters, values up to 255).
postal_code

invoiced_create_draft_invoice

WRITE: create a DRAFT invoice for a customer. It is always created as a draft: it is not issued, not emailed, not charged and cannot trigger AutoPay until a person finalizes it in Invoiced. At least one line item is required. POST /invoices with draft=true.

Argument	Type	Description
date	string	Invoice date (default now).
name	string	Document title (default "Invoice").
items*	array	Line items.
notes	string	Notes printed on the invoice.
number	string	Invoice number (default: next in sequence).
currency	string
due_date	string	Due date (default: computed from the payment terms).
metadata	object	Metadata key/values (max 10 keys, names up to 40 characters, values up to 255).
customer_id*	integer	Invoiced customer id (invoiced_list_customers).

invoiced_create_task

WRITE: create a collection task for a customer (a reminder to call, write, email or review). Nothing is sent to the customer. POST /tasks.

Argument	Type	Description
name*	string	Task name, e.g. "Call about overdue invoice".
action*	string	Kind of task.
user_id	integer	Invoiced user to assign it to.
due_date	string	When it is due.
customer_id*	integer	Customer the task is about.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "name",
    "action",
    "customer_id"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 300,
      "minLength": 1,
      "description": "Task name, e.g. \"Call about overdue invoice\"."
    },
    "action": {
      "enum": [
        "phone",
        "letter",
        "email",
        "review"
      ],
      "type": "string",
      "description": "Kind of task."
    },
    "user_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Invoiced user to assign it to.",
      "exclusiveMinimum": 0
    },
    "due_date": {
      "type": "string",
      "description": "When it is due."
    },
    "customer_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Customer the task is about.",
      "exclusiveMinimum": 0
    }
  }
}

invoiced_get_credit_note

One credit note by id with line items, totals and balance. GET /credit_notes/{id}.

read-only

Argument	Type	Description
credit_note_id*	integer	Invoiced credit note id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "credit_note_id"
  ],
  "properties": {
    "credit_note_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Invoiced credit note id.",
      "exclusiveMinimum": 0
    }
  }
}

invoiced_get_customer

One customer by id: contact details, address, terms, currency, autopay, chasing cadence, credit hold/limit, parent customer, metadata. GET /customers/{id}.

read-only

Argument	Type	Description
customer_id*	integer	Invoiced customer id (numeric; not the customer number).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id"
  ],
  "properties": {
    "customer_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Invoiced customer id (numeric; not the customer number).",
      "exclusiveMinimum": 0
    }
  }
}

invoiced_get_customer_balance

A customer's current balance: total outstanding, past due, and available credit, in the customer's currency (or `currency`). GET /customers/{id}/balance.

read-only

Argument	Type	Description
currency	string	3-letter currency code (default: the customer's currency).
customer_id*	integer	Invoiced customer id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id"
  ],
  "properties": {
    "currency": {
      "type": "string",
      "pattern": "^[A-Za-z]{3}$",
      "description": "3-letter currency code (default: the customer's currency)."
    },
    "customer_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Invoiced customer id.",
      "exclusiveMinimum": 0
    }
  }
}

invoiced_get_estimate

One estimate by id with line items, totals, deposit and approval state. GET /estimates/{id}.

read-only

Argument	Type	Description
estimate_id*	integer	Invoiced estimate id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "estimate_id"
  ],
  "properties": {
    "estimate_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Invoiced estimate id.",
      "exclusiveMinimum": 0
    }
  }
}

invoiced_get_invoice

One invoice by id: status, dates, payment terms, totals, balance, line items, discounts, taxes, ship-to, payment and PDF links. `expand` replaces ids with full objects (e.g. customer). GET /invoices/{id}.

read-only

Argument	Type	Description
expand	array	Relations to expand into full objects.
invoice_id*	integer	Invoiced invoice id (numeric; find it with invoiced_list_invoices).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "invoice_id"
  ],
  "properties": {
    "expand": {
      "type": "array",
      "items": {
        "enum": [
          "customer",
          "subscription",
          "payment_plan"
        ],
        "type": "string"
      },
      "maxItems": 3,
      "description": "Relations to expand into full objects."
    },
    "invoice_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Invoiced invoice id (numeric; find it with invoiced_list_invoices).",
      "exclusiveMinimum": 0
    }
  }
}

invoiced_get_invoice_payment_plan

The payment plan (installments with dates, amounts and balances, and approval status) attached to an invoice. Errors with 404 when the invoice has none. GET /invoices/{id}/payment_plan.

read-only

Argument	Type	Description
invoice_id*	integer	Invoiced invoice id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "invoice_id"
  ],
  "properties": {
    "invoice_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Invoiced invoice id.",
      "exclusiveMinimum": 0
    }
  }
}

invoiced_get_item

One catalog item by its id (a string such as "delivery"). GET /items/{id}.

read-only

Argument	Type	Description
item_id*	string	Catalog item id (from invoiced_list_items).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "item_id"
  ],
  "properties": {
    "item_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Catalog item id (from invoiced_list_items)."
    }
  }
}

invoiced_get_payment

One payment by id, including which invoices and credit notes it was applied to (`applied_to`). GET /payments/{id}?include=applied_to.

read-only

Argument	Type	Description
payment_id*	integer	Invoiced payment id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "payment_id"
  ],
  "properties": {
    "payment_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Invoiced payment id.",
      "exclusiveMinimum": 0
    }
  }
}

invoiced_get_plan

One subscription plan by its id (a string). GET /plans/{id}.

read-only

Argument	Type	Description
plan_id*	string	Plan id (from invoiced_list_plans).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "plan_id"
  ],
  "properties": {
    "plan_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Plan id (from invoiced_list_plans)."
    }
  }
}

invoiced_get_subscription

One subscription by id with plan, add-ons, billing period, contract terms, recurring total and MRR. GET /subscriptions/{id}.

read-only

Argument	Type	Description
subscription_id*	integer	Invoiced subscription id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "subscription_id"
  ],
  "properties": {
    "subscription_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Invoiced subscription id.",
      "exclusiveMinimum": 0
    }
  }
}

invoiced_list_contacts

List the contacts of one customer: name, title, email, phone, whether primary (copied on communications) and SMS-enabled. GET /customers/{id}/contacts.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
sort	string	Sort, "<column> asc\|desc", e.g. "date desc".
per_page	integer	Results per page, 1-100 (default 25).
customer_id*	integer	Invoiced customer id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "sort": {
      "type": "string",
      "pattern": "^[a-z_][a-z0-9_]{0,63}(\\s+(asc|desc))?$",
      "description": "Sort, \"<column> asc|desc\", e.g. \"date desc\"."
    },
    "per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "customer_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Invoiced customer id.",
      "exclusiveMinimum": 0
    }
  }
}

invoiced_list_credit_notes

List credit notes: customer, status (draft, open, paid, closed, voided), totals, remaining balance, line items. GET /credit_notes.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
sort	string	Sort, "<column> asc\|desc", e.g. "date desc".
filter	object	Exact-match filters on object columns, e.g. {"paid": false, "currency": "usd"}. Booleans are sent as 1/0.
end_date	string	Credit notes dated on or before this date (a bare date includes the whole day).
metadata	object	Exact-match filters on metadata keys, e.g. {"account-rep": "Jan"}.
per_page	integer	Results per page, 1-100 (default 25).
start_date	string	Credit notes dated on or after this date or date-time.
customer_id	integer	Only this customer's credit notes.
updated_after

invoiced_list_customers

List customers (accounts receivable debtors): name, number, email, payment terms, currency, autopay and chasing settings, owner. Filter by open balance, saved payment method, update time or any exact-match column. GET /customers.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
sort	string	Sort, "<column> asc\|desc", e.g. "date desc".
filter	object	Exact-match filters on object columns, e.g. {"paid": false, "currency": "usd"}. Booleans are sent as 1/0.
metadata	object	Exact-match filters on metadata keys, e.g. {"account-rep": "Jan"}.
per_page	integer	Results per page, 1-100 (default 25).
open_balance	boolean	true = only customers with an open balance; false = only those without.
updated_after	string	Only records updated after this date or date-time.
payment_source	boolean	true = only customers with a saved payment method.

invoiced_list_estimates

List estimates (quotes): customer, status (draft, not_sent, sent, approved, invoiced, declined, voided), expiration date, deposit, totals, resulting invoice. GET /estimates.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
sort	string	Sort, "<column> asc\|desc", e.g. "date desc".
filter	object	Exact-match filters on object columns, e.g. {"paid": false, "currency": "usd"}. Booleans are sent as 1/0.
end_date	string	Estimates dated on or before this date (a bare date includes the whole day).
metadata	object	Exact-match filters on metadata keys, e.g. {"account-rep": "Jan"}.
per_page	integer	Results per page, 1-100 (default 25).
start_date	string	Estimates dated on or after this date or date-time.
customer_id	integer	Only this customer's estimates.

invoiced_list_events

The activity feed, newest first: event type (such as invoice.paid, customer.created), time, the object it concerns and who did it. Optionally only the events of one object. GET /events.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
per_page	integer	Results per page, 1-100 (default 25).
related_object_id	integer	Id of the object (needs related_object_type).
related_object_type	string	Object type such as customer or invoice; with related_object_id: only events about this object.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "related_object_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Id of the object (needs related_object_type).",
      "exclusiveMinimum": 0
    },
    "related_object_type": {
      "type": "string",
      "pattern": "^[a-z_]{1,40}$",
      "description": "Object type such as customer or invoice; with related_object_id: only events about this object."
    }
  }
}

invoiced_list_invoices

List invoices with number, customer, status (draft, not_sent, sent, viewed, past_due, pending, paid, voided), dates, totals, balance and line items. Filter by customer, paid flag, invoice date range, update time or any exact-match column. GET /invoices.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
paid	boolean	true = only paid invoices; false = only unpaid.
sort	string	Sort, "<column> asc\|desc", e.g. "date desc".
filter	object	Exact-match filters on object columns, e.g. {"paid": false, "currency": "usd"}. Booleans are sent as 1/0.
end_date	string	Invoices dated on or before this date (a bare date includes the whole day).
metadata	object	Exact-match filters on metadata keys, e.g. {"account-rep": "Jan"}.
per_page	integer	Results per page, 1-100 (default 25).
start_date	string	Invoices dated on or after this date or date-time.

invoiced_list_items

List the item catalog (products and services): id, name, currency, unit cost, type, taxable. Use item ids as `catalog_item` when creating a draft invoice. GET /items.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
sort	string	Sort, "<column> asc\|desc", e.g. "date desc".
filter	object	Exact-match filters on object columns, e.g. {"paid": false, "currency": "usd"}. Booleans are sent as 1/0.
per_page	integer	Results per page, 1-100 (default 25).
updated_after	string	Only records updated after this date or date-time.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "sort": {
      "type": "string",
      "pattern": "^[a-z_][a-z0-9_]{0,63}(\\s+(asc|desc))?$",
      "description": "Sort, \"<column> asc|desc\", e.g. \"date desc\"."
    },
    "filter": {
      "type": "object",
      "description": "Exact-match filters on object columns, e.g. {\"paid\": false, \"currency\": \"usd\"}. Booleans are sent as 1/0.",
      "propertyNames": {
        "type": "string",
        "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 200
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          }
        ]
      }
    },
    "per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "updated_after": {
      "type": "string",
      "description": "Only records updated after this date or date-time."
    }
  }
}

invoiced_list_notes

List collection notes, newest first, for one customer or one invoice (give exactly one), or all notes when neither is given. GET /customers/{id}/notes, /invoices/{id}/notes or /notes.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
per_page	integer	Results per page, 1-100 (default 25).
invoice_id	integer	Only this invoice's notes.
customer_id	integer	Only this customer's notes.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "invoice_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only this invoice's notes.",
      "exclusiveMinimum": 0
    },
    "customer_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only this customer's notes.",
      "exclusiveMinimum": 0
    }
  }
}

invoiced_list_payments

List payments received: customer, date, amount, unapplied balance, method (check, wire, ACH, card, ...), reference, whether matched or voided. Read only. GET /payments.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
sort	string	Sort, "<column> asc\|desc", e.g. "date desc".
filter	object	Exact-match filters on object columns, e.g. {"paid": false, "currency": "usd"}. Booleans are sent as 1/0.
end_date	string	Payments dated on or before this date (a bare date includes the whole day).
per_page	integer	Results per page, 1-100 (default 25).
start_date	string	Payments dated on or after this date or date-time.
customer_id	integer	Only this customer's payments.
updated_after	string	Only records updated after this date or date-time.

Input schema (JSON)

invoiced_list_plans

List subscription plans: id, name, currency, amount, pricing mode, billing interval, tiers. GET /plans.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
sort	string	Sort, "<column> asc\|desc", e.g. "date desc".
filter	object	Exact-match filters on object columns, e.g. {"paid": false, "currency": "usd"}. Booleans are sent as 1/0.
per_page	integer	Results per page, 1-100 (default 25).
updated_after	string	Only records updated after this date or date-time.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "sort": {
      "type": "string",
      "pattern": "^[a-z_][a-z0-9_]{0,63}(\\s+(asc|desc))?$",
      "description": "Sort, \"<column> asc|desc\", e.g. \"date desc\"."
    },
    "filter": {
      "type": "object",
      "description": "Exact-match filters on object columns, e.g. {\"paid\": false, \"currency\": \"usd\"}. Booleans are sent as 1/0.",
      "propertyNames": {
        "type": "string",
        "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 200
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          }
        ]
      }
    },
    "per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "updated_after": {
      "type": "string",
      "description": "Only records updated after this date or date-time."
    }
  }
}

invoiced_list_subscriptions

List recurring subscriptions: customer, plan, quantity, billing period, status (not_started, active, past_due, finished, canceled), recurring total and MRR, contract renewal. GET /subscriptions.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
sort	string	Sort, "<column> asc\|desc", e.g. "date desc".
filter	object	Exact-match filters on object columns, e.g. {"paid": false, "currency": "usd"}. Booleans are sent as 1/0.
canceled	boolean	true = only canceled subscriptions; false = only not canceled.
finished	boolean	true = only finished subscriptions; false = only unfinished.
metadata	object	Exact-match filters on metadata keys, e.g. {"account-rep": "Jan"}.
per_page	integer	Results per page, 1-100 (default 25).
customer_id	integer	Only this customer's subscriptions.

invoiced_list_tasks

List collection tasks (call, letter, email, review): name, action, customer, assignee, due date, whether complete. GET /tasks.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
sort	string	Sort, "<column> asc\|desc", e.g. "date desc".
complete	boolean	true = only completed tasks; false = only open tasks.
per_page	integer	Results per page, 1-100 (default 25).
customer_id	integer	Only this customer's tasks.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "sort": {
      "type": "string",
      "pattern": "^[a-z_][a-z0-9_]{0,63}(\\s+(asc|desc))?$",
      "description": "Sort, \"<column> asc|desc\", e.g. \"date desc\"."
    },
    "complete": {
      "type": "boolean",
      "description": "true = only completed tasks; false = only open tasks."
    },
    "per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "customer_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only this customer's tasks.",
      "exclusiveMinimum": 0
    }
  }
}

invoiced_list_tax_rates

List tax rates: id, name, value, whether a percentage, whether inclusive, currency. GET /tax_rates.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
sort	string	Sort, "<column> asc\|desc", e.g. "date desc".
filter	object	Exact-match filters on object columns, e.g. {"paid": false, "currency": "usd"}. Booleans are sent as 1/0.
per_page	integer	Results per page, 1-100 (default 25).
updated_after	string	Only records updated after this date or date-time.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "sort": {
      "type": "string",
      "pattern": "^[a-z_][a-z0-9_]{0,63}(\\s+(asc|desc))?$",
      "description": "Sort, \"<column> asc|desc\", e.g. \"date desc\"."
    },
    "filter": {
      "type": "object",
      "description": "Exact-match filters on object columns, e.g. {\"paid\": false, \"currency\": \"usd\"}. Booleans are sent as 1/0.",
      "propertyNames": {
        "type": "string",
        "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 200
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          }
        ]
      }
    },
    "per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "updated_after": {
      "type": "string",
      "description": "Only records updated after this date or date-time."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "name"
  ],
  "properties": {
    "city": {
      "type": "string",
      "maxLength": 200
    },
    "name": {
      "type": "string",
      "maxLength": 300,
      "minLength": 1,
      "description": "Customer name."
    },
    "type": {
      "enum": [
        "company",
        "person"
      ],
      "type": "string",
      "description": "Default company."
    },
    "email": {
      "type": "string",
      "format": "email",
      "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
      "maxLength": 254
    },
    "notes": {
      "type": "string",
      "maxLength": 5000,
      "description": "Private notes."
    },
    "phone": {
      "type": "string",
      "maxLength": 50
    },
    "state": {
      "type": "string",
      "maxLength": 200
    },
    "number": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Customer number (default: generated)."
    },
    "tax_id": {
      "type": "string",
      "maxLength": 100
    },
    "country": {
      "type": "string",
      "pattern": "^[A-Za-z]{2}$"
    },
    "address1": {
      "type": "string",
      "maxLength": 300
    },
    "address2": {
      "type": "string",
      "maxLength": 300
    },
    "currency": {
      "type": "string",
      "pattern": "^[A-Za-z]{3}$"
    },
    "metadata": {
      "type": "object",
      "description": "Metadata key/values (max 10 keys, names up to 40 characters, values up to 255).",
      "propertyNames": {
        "type": "string",
        "pattern": "^[A-Za-z0-9_.-]{1,40}$"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 255
      }
    },
    "postal_code": {
      "type": "string",
      "maxLength": 50
    },
    "attention_to": {
      "type": "string",
      "maxLength": 300
    },
    "payment_terms": {
      "type": "string",
      "maxLength": 100,
      "description": "e.g. \"NET 30\"."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id",
    "items"
  ],
  "properties": {
    "date": {
      "type": "string",
      "description": "Invoice date (default now)."
    },
    "name": {
      "type": "string",
      "maxLength": 300,
      "description": "Document title (default \"Invoice\")."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 300,
            "minLength": 1,
            "description": "Line item name (required unless catalog_item is given)."
          },
          "type": {
            "type": "string",
            "maxLength": 100,
            "description": "Reporting type, e.g. \"product\" or \"service\"."
          },
          "quantity": {
            "type": "number",
            "maximum": 1000000000,
            "minimum": 0,
            "description": "Quantity (default 1)."
          },
          "unit_cost": {
            "type": "number",
            "maximum": 1000000000000,
            "minimum": -1000000000000,
            "description": "Price per unit, in the invoice currency."
          },
          "description": {
            "type": "string",
            "maxLength": 2000
          },
          "catalog_item": {
            "type": "string",
            "maxLength": 200,
            "minLength": 1,
            "description": "Id of an item in the catalog (invoiced_list_items); fills the name and price."
          }
        }
      },
      "maxItems": 100,
      "minItems": 1,
      "description": "Line items."
    },
    "notes": {
      "type": "string",
      "maxLength": 5000,
      "description": "Notes printed on the invoice."
    },
    "number": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Invoice number (default: next in sequence)."
    },
    "currency": {
      "type": "string",
      "pattern": "^[A-Za-z]{3}$"
    },
    "due_date": {
      "type": "string",
      "description": "Due date (default: computed from the payment terms)."
    },
    "metadata": {
      "type": "object",
      "description": "Metadata key/values (max 10 keys, names up to 40 characters, values up to 255).",
      "propertyNames": {
        "type": "string",
        "pattern": "^[A-Za-z0-9_.-]{1,40}$"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 255
      }
    },
    "customer_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Invoiced customer id (invoiced_list_customers).",
      "exclusiveMinimum": 0
    },
    "payment_terms": {
      "type": "string",
      "maxLength": 100,
      "description": "e.g. \"NET 30\"."
    },
    "purchase_order": {
      "type": "string",
      "maxLength": 200
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "sort": {
      "type": "string",
      "pattern": "^[a-z_][a-z0-9_]{0,63}(\\s+(asc|desc))?$",
      "description": "Sort, \"<column> asc|desc\", e.g. \"date desc\"."
    },
    "filter": {
      "type": "object",
      "description": "Exact-match filters on object columns, e.g. {\"paid\": false, \"currency\": \"usd\"}. Booleans are sent as 1/0.",
      "propertyNames": {
        "type": "string",
        "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 200
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          }
        ]
      }
    },
    "end_date": {
      "type": "string",
      "description": "Credit notes dated on or before this date (a bare date includes the whole day)."
    },
    "metadata": {
      "type": "object",
      "description": "Exact-match filters on metadata keys, e.g. {\"account-rep\": \"Jan\"}.",
      "propertyNames": {
        "type": "string",
        "pattern": "^[A-Za-z0-9_.-]{1,64}$"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 200
      }
    },
    "per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "start_date": {
      "type": "string",
      "description": "Credit notes dated on or after this date or date-time."
    },
    "customer_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only this customer's credit notes.",
      "exclusiveMinimum": 0
    },
    "updated_after": {
      "type": "string",
      "description": "Only records updated after this date or date-time."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "sort": {
      "type": "string",
      "pattern": "^[a-z_][a-z0-9_]{0,63}(\\s+(asc|desc))?$",
      "description": "Sort, \"<column> asc|desc\", e.g. \"date desc\"."
    },
    "filter": {
      "type": "object",
      "description": "Exact-match filters on object columns, e.g. {\"paid\": false, \"currency\": \"usd\"}. Booleans are sent as 1/0.",
      "propertyNames": {
        "type": "string",
        "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 200
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          }
        ]
      }
    },
    "end_date": {
      "type": "string",
      "description": "Estimates dated on or before this date (a bare date includes the whole day)."
    },
    "metadata": {
      "type": "object",
      "description": "Exact-match filters on metadata keys, e.g. {\"account-rep\": \"Jan\"}.",
      "propertyNames": {
        "type": "string",
        "pattern": "^[A-Za-z0-9_.-]{1,64}$"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 200
      }
    },
    "per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "start_date": {
      "type": "string",
      "description": "Estimates dated on or after this date or date-time."
    },
    "customer_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only this customer's estimates.",
      "exclusiveMinimum": 0
    },
    "updated_after": {
      "type": "string",
      "description": "Only records updated after this date or date-time."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "paid": {
      "type": "boolean",
      "description": "true = only paid invoices; false = only unpaid."
    },
    "sort": {
      "type": "string",
      "pattern": "^[a-z_][a-z0-9_]{0,63}(\\s+(asc|desc))?$",
      "description": "Sort, \"<column> asc|desc\", e.g. \"date desc\"."
    },
    "filter": {
      "type": "object",
      "description": "Exact-match filters on object columns, e.g. {\"paid\": false, \"currency\": \"usd\"}. Booleans are sent as 1/0.",
      "propertyNames": {
        "type": "string",
        "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 200
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          }
        ]
      }
    },
    "end_date": {
      "type": "string",
      "description": "Invoices dated on or before this date (a bare date includes the whole day)."
    },
    "metadata": {
      "type": "object",
      "description": "Exact-match filters on metadata keys, e.g. {\"account-rep\": \"Jan\"}.",
      "propertyNames": {
        "type": "string",
        "pattern": "^[A-Za-z0-9_.-]{1,64}$"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 200
      }
    },
    "per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "start_date": {
      "type": "string",
      "description": "Invoices dated on or after this date or date-time."
    },
    "customer_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only this customer's invoices.",
      "exclusiveMinimum": 0
    },
    "updated_after": {
      "type": "string",
      "description": "Only records updated after this date or date-time."
    }
  }
}

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "sort": {
      "type": "string",
      "pattern": "^[a-z_][a-z0-9_]{0,63}(\\s+(asc|desc))?$",
      "description": "Sort, \"<column> asc|desc\", e.g. \"date desc\"."
    },
    "filter": {
      "type": "object",
      "description": "Exact-match filters on object columns, e.g. {\"paid\": false, \"currency\": \"usd\"}. Booleans are sent as 1/0.",
      "propertyNames": {
        "type": "string",
        "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 200
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          }
        ]
      }
    },
    "end_date": {
      "type": "string",
      "description": "Payments dated on or before this date (a bare date includes the whole day)."
    },
    "per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "start_date": {
      "type": "string",
      "description": "Payments dated on or after this date or date-time."
    },
    "customer_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only this customer's payments.",
      "exclusiveMinimum": 0
    },
    "updated_after": {
      "type": "string",
      "description": "Only records updated after this date or date-time."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "sort": {
      "type": "string",
      "pattern": "^[a-z_][a-z0-9_]{0,63}(\\s+(asc|desc))?$",
      "description": "Sort, \"<column> asc|desc\", e.g. \"date desc\"."
    },
    "filter": {
      "type": "object",
      "description": "Exact-match filters on object columns, e.g. {\"paid\": false, \"currency\": \"usd\"}. Booleans are sent as 1/0.",
      "propertyNames": {
        "type": "string",
        "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 200
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          }
        ]
      }
    },
    "canceled": {
      "type": "boolean",
      "description": "true = only canceled subscriptions; false = only not canceled."
    },
    "finished": {
      "type": "boolean",
      "description": "true = only finished subscriptions; false = only unfinished."
    },
    "metadata": {
      "type": "object",
      "description": "Exact-match filters on metadata keys, e.g. {\"account-rep\": \"Jan\"}.",
      "propertyNames": {
        "type": "string",
        "pattern": "^[A-Za-z0-9_.-]{1,64}$"
      },
      "additionalProperties": {
        "type": "string",
        "maxLength": 200
      }
    },
    "per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "customer_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Only this customer's subscriptions.",
      "exclusiveMinimum": 0
    },
    "updated_after": {
      "type": "string",
      "description": "Only records updated after this date or date-time."
    }
  }
}