list_discounts — Discounts available for invoices

The list_discounts tool returns the discounts an organization can apply to invoices. Each discount is either a percentage or a fixed amount. 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

Discount[]

required

Array of discounts.

Show Discount

string

required

Discount type. Values: PERCENTAGE, FIXED.

number

Percentage off. Present when type is PERCENTAGE.

Money

Fixed amount off as a Money object. Present when type is FIXED.

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": 17,
  "method": "tools/call",
  "params": {
    "name": "list_discounts",
    "arguments": {
      "intent": "User asked what discounts they usually offer on invoices.",
      "organizationId": "org_1"
    }
  }
}

{
  "jsonrpc": "2.0",
  "id": 17,
  "result": {
    "structuredContent": {
      "data": [
        {
          "type": "PERCENTAGE",
          "percentage": 10
        },
        {
          "type": "FIXED",
          "amount": {
            "cents": 5000,
            "display": "50.00",
            "currency": "USD"
          }
        }
      ],
      "pagination": {
        "hasNextPage": false,
        "pageSize": 50
      }
    }
  }
}

Notes

A PERCENTAGE discount carries percentage. A FIXED discount carries amount as a Money object.
Follow nextCursor until hasNextPage is false. Keep the same pageSize and filters on every page.

list_tax_rates

List tax rates available for invoices.

list_invoices

Search and list invoices.

Organizations

Transactions

Accounts

Cards

Statements

Contacts

Catalog items

Invoices

list_discounts — Discounts available for invoices

Scope

Input

Output

Example

Notes

list_tax_rates

list_invoices

​Scope

​Input

​Output

​Example

​Notes

list_tax_rates

list_invoices

Scope

Input

Output

Example

Notes