list_tax_rates — Tax rates available for invoices

The list_tax_rates tool returns the tax rates an organization can apply to invoice line items. Every request must include intent and organizationId, and the token must carry the invoices.read scope.

Receivables tools require the organization to have invoicing set up in Relay. If it does not, the tool returns an error instead of data.

Scope

Required OAuth scope: invoices.read

Input

string

required

The organization to query. Must be one of the organizations the token can access.

string

Opaque pagination cursor from a previous response. Keep the same pageSize and filters when following cursors. Never parse, edit, or reuse a cursor across different filter sets.

integer

Number of results per page. Must be between 1 and 100. Defaults to 50.

string

required

What the user asked for and why this call serves it, in 1 to 500 characters. Required on every tool call. See Common tool arguments.

Output

TaxRate[]

required

Array of tax rates.

Show TaxRate

string

required

Unique tax rate identifier.

string

required

Display name of the tax rate.

number

required

Tax rate as a percentage, for example 8.875.

string | null

required

Accounting integration the tax rate comes from, if any.

object

required

Cursor-based pagination metadata.

Show Pagination

boolean

required

Whether more results are available.

integer

required

Number of results in this page.

string

Opaque cursor to fetch the next page. Present only when hasNextPage is true.

Example

{
  "jsonrpc": "2.0",
  "id": 16,
  "method": "tools/call",
  "params": {
    "name": "list_tax_rates",
    "arguments": {
      "intent": "User asked which sales tax rates they have set up for invoicing.",
      "organizationId": "org_1"
    }
  }
}

{
  "jsonrpc": "2.0",
  "id": 16,
  "result": {
    "structuredContent": {
      "data": [
        {
          "id": "tax_1",
          "name": "NY Sales Tax",
          "percentage": 8.875,
          "integration": null
        }
      ],
      "pagination": {
        "hasNextPage": false,
        "pageSize": 50
      }
    }
  }
}

Notes

percentage is a percentage value. 8.875 means 8.875%.
Follow nextCursor until hasNextPage is false. Keep the same pageSize and filters on every page.

list_discounts

List discounts available for invoices.

list_invoices

Search and list invoices.

Organizations

Transactions

Accounts

Cards

Statements

Contacts

Catalog items

Invoices

list_tax_rates — Tax rates available for invoices

Scope

Input

Output

Example

Notes

list_discounts

list_invoices

​Scope

​Input

​Output

​Example

​Notes

list_discounts

list_invoices

Scope

Input

Output

Example

Notes