Ferrule

QuickBooks Online

67 tools • OpenAPI spec ↗

MCPREST
GETfind_accounts/accounts

Search for chart-of-accounts entries.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_accounts"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_accounts",
      "params": {}
    }
  }
}
GETfind_attachables/attachables

Search for file attachments.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_attachables"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_attachables",
      "params": {}
    }
  }
}
GETfind_bills/bills

Search for bills (vendor invoices).

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_bills"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_bills",
      "params": {}
    }
  }
}
GETfind_bill_payments/bill-payments

Search for bill payments.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_bill_payments"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_bill_payments",
      "params": {}
    }
  }
}
GETfind_budgets/budgets

Search for budgets.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_budgets"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_budgets",
      "params": {}
    }
  }
}
GETfind_classes/classes

Search for classes (for categorizing transactions).

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_classes"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_classes",
      "params": {}
    }
  }
}
GETfind_company_infos/company-infos

Search for company information records.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_company_infos"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_company_infos",
      "params": {}
    }
  }
}
GETfind_credit_memos/credit-memos

Search for credit memos.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_credit_memos"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_credit_memos",
      "params": {}
    }
  }
}
GETfind_customers/customers

Search for customers.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_customers"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_customers",
      "params": {}
    }
  }
}
GETfind_departments/departments

Search for departments.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_departments"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_departments",
      "params": {}
    }
  }
}
GETfind_deposits/deposits

Search for deposits.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_deposits"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_deposits",
      "params": {}
    }
  }
}
GETfind_employees/employees

Search for employees.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_employees"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_employees",
      "params": {}
    }
  }
}
GETfind_estimates/estimates

Search for estimates (quotes).

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_estimates"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_estimates",
      "params": {}
    }
  }
}
GETfind_invoices/invoices

Search for invoices.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_invoices"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_invoices",
      "params": {}
    }
  }
}
GETfind_items/items

Search for products and services.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_items"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_items",
      "params": {}
    }
  }
}
GETfind_journal_codes/journal-codes

Search for journal codes (France localization).

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_journal_codes"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_journal_codes",
      "params": {}
    }
  }
}
GETfind_journal_entries/journal-entries

Search for journal entries.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_journal_entries"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_journal_entries",
      "params": {}
    }
  }
}
GETfind_payments/payments

Search for customer payments.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_payments"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_payments",
      "params": {}
    }
  }
}
GETfind_payment_methods/payment-methods

Search for payment methods.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_payment_methods"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_payment_methods",
      "params": {}
    }
  }
}
GETfind_preferences/preferences

Search for company preferences.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_preferences"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_preferences",
      "params": {}
    }
  }
}
GETfind_purchases/purchases

Search for purchases.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_purchases"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_purchases",
      "params": {}
    }
  }
}
GETfind_purchase_orders/purchase-orders

Search for purchase orders.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_purchase_orders"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_purchase_orders",
      "params": {}
    }
  }
}
GETfind_refund_receipts/refund-receipts

Search for refund receipts.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_refund_receipts"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_refund_receipts",
      "params": {}
    }
  }
}
GETfind_sales_receipts/sales-receipts

Search for sales receipts.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_sales_receipts"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_sales_receipts",
      "params": {}
    }
  }
}
GETfind_tax_agencies/tax-agencies

Search for tax agencies.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_tax_agencies"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_tax_agencies",
      "params": {}
    }
  }
}
GETfind_tax_codes/tax-codes

Search for tax codes.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_tax_codes"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_tax_codes",
      "params": {}
    }
  }
}
GETfind_tax_rates/tax-rates

Search for tax rates.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_tax_rates"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_tax_rates",
      "params": {}
    }
  }
}
GETfind_terms/terms

Search for payment terms.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_terms"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_terms",
      "params": {}
    }
  }
}
GETfind_time_activities/time-activities

Search for time tracking entries.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_time_activities"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_time_activities",
      "params": {}
    }
  }
}
GETfind_vendors/vendors

Search for vendors.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_vendors"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_vendors",
      "params": {}
    }
  }
}
GETfind_vendor_credits/vendor-credits

Search for vendor credits.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_vendor_credits"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_vendor_credits",
      "params": {}
    }
  }
}
GETfind_exchange_rates/exchange-rates

Search for currency exchange rates.

Request

Query Parameters

NameTypeRequiredDescription
wherestringNoSQL-like WHERE clause (e.g. "TotalAmt > '100.00'" or "DisplayName LIKE '%Smith%'")
limitstringNoMaximum number of results to return (default: 1000)
offsetstringNoStarting position for results (for pagination)
fetchAllstringNoSet to 'true' to automatically fetch all pages of results

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "find_exchange_rates"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "find_exchange_rates",
      "params": {}
    }
  }
}
GETget_invoice/invoices/:invoiceId

Get an invoice by ID.

Request

Path Parameters

NameTypeRequiredDescription
invoiceIdstringYesInvoice ID

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "get_invoice"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "get_invoice",
      "params": {
        "invoiceId": "<invoiceId>"
      }
    }
  }
}
GETget_customer/customers/:customerId

Get a customer by ID.

Request

Path Parameters

NameTypeRequiredDescription
customerIdstringYesCustomer ID

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "get_customer"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "get_customer",
      "params": {
        "customerId": "<customerId>"
      }
    }
  }
}
GETget_vendor/vendors/:vendorId

Get a vendor by ID.

Request

Path Parameters

NameTypeRequiredDescription
vendorIdstringYesVendor ID

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "get_vendor"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "get_vendor",
      "params": {
        "vendorId": "<vendorId>"
      }
    }
  }
}
GETget_payment/payments/:paymentId

Get a payment by ID.

Request

Path Parameters

NameTypeRequiredDescription
paymentIdstringYesPayment ID

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "get_payment"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "get_payment",
      "params": {
        "paymentId": "<paymentId>"
      }
    }
  }
}
GETget_bill/bills/:billId

Get a bill by ID.

Request

Path Parameters

NameTypeRequiredDescription
billIdstringYesBill ID

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "get_bill"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "get_bill",
      "params": {
        "billId": "<billId>"
      }
    }
  }
}
GETget_estimate/estimates/:estimateId

Get an estimate by ID.

Request

Path Parameters

NameTypeRequiredDescription
estimateIdstringYesEstimate ID

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "get_estimate"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "get_estimate",
      "params": {
        "estimateId": "<estimateId>"
      }
    }
  }
}
GETget_account/accounts/:accountId

Get a chart-of-accounts entry by ID.

Request

Path Parameters

NameTypeRequiredDescription
accountIdstringYesAccount ID

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "get_account"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "get_account",
      "params": {
        "accountId": "<accountId>"
      }
    }
  }
}
GETget_item/items/:itemId

Get a product or service item by ID.

Request

Path Parameters

NameTypeRequiredDescription
itemIdstringYesItem ID

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "get_item"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "get_item",
      "params": {
        "itemId": "<itemId>"
      }
    }
  }
}
GETget_employee/employees/:employeeId

Get an employee by ID.

Request

Path Parameters

NameTypeRequiredDescription
employeeIdstringYesEmployee ID

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "get_employee"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "get_employee",
      "params": {
        "employeeId": "<employeeId>"
      }
    }
  }
}
GETget_credit_memo/credit-memos/:creditMemoId

Get a credit memo by ID.

Request

Path Parameters

NameTypeRequiredDescription
creditMemoIdstringYesCredit Memo ID

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "get_credit_memo"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "get_credit_memo",
      "params": {
        "creditMemoId": "<creditMemoId>"
      }
    }
  }
}
GETget_sales_receipt/sales-receipts/:salesReceiptId

Get a sales receipt by ID.

Request

Path Parameters

NameTypeRequiredDescription
salesReceiptIdstringYesSales Receipt ID

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "get_sales_receipt"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "get_sales_receipt",
      "params": {
        "salesReceiptId": "<salesReceiptId>"
      }
    }
  }
}
GETget_purchase/purchases/:purchaseId

Get a purchase by ID.

Request

Path Parameters

NameTypeRequiredDescription
purchaseIdstringYesPurchase ID

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "get_purchase"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "get_purchase",
      "params": {
        "purchaseId": "<purchaseId>"
      }
    }
  }
}
GETget_purchase_order/purchase-orders/:purchaseOrderId

Get a purchase order by ID.

Request

Path Parameters

NameTypeRequiredDescription
purchaseOrderIdstringYesPurchase Order ID

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "get_purchase_order"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "get_purchase_order",
      "params": {
        "purchaseOrderId": "<purchaseOrderId>"
      }
    }
  }
}
GETget_deposit/deposits/:depositId

Get a deposit by ID.

Request

Path Parameters

NameTypeRequiredDescription
depositIdstringYesDeposit ID

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "get_deposit"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "get_deposit",
      "params": {
        "depositId": "<depositId>"
      }
    }
  }
}
GETget_journal_entry/journal-entries/:journalEntryId

Get a journal entry by ID.

Request

Path Parameters

NameTypeRequiredDescription
journalEntryIdstringYesJournal Entry ID

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "get_journal_entry"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "get_journal_entry",
      "params": {
        "journalEntryId": "<journalEntryId>"
      }
    }
  }
}
GETget_time_activity/time-activities/:timeActivityId

Get a time tracking entry by ID.

Request

Path Parameters

NameTypeRequiredDescription
timeActivityIdstringYesTime Activity ID

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "get_time_activity"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "get_time_activity",
      "params": {
        "timeActivityId": "<timeActivityId>"
      }
    }
  }
}
GETget_refund_receipt/refund-receipts/:refundReceiptId

Get a refund receipt by ID.

Request

Path Parameters

NameTypeRequiredDescription
refundReceiptIdstringYesRefund Receipt ID

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "get_refund_receipt"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "get_refund_receipt",
      "params": {
        "refundReceiptId": "<refundReceiptId>"
      }
    }
  }
}
GETget_bill_payment/bill-payments/:billPaymentId

Get a bill payment by ID.

Request

Path Parameters

NameTypeRequiredDescription
billPaymentIdstringYesBill Payment ID

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "get_bill_payment"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "get_bill_payment",
      "params": {
        "billPaymentId": "<billPaymentId>"
      }
    }
  }
}
GETget_vendor_credit/vendor-credits/:vendorCreditId

Get a vendor credit by ID.

Request

Path Parameters

NameTypeRequiredDescription
vendorCreditIdstringYesVendor Credit ID

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "get_vendor_credit"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "get_vendor_credit",
      "params": {
        "vendorCreditId": "<vendorCreditId>"
      }
    }
  }
}
GETget_tax_code/tax-codes/:taxCodeId

Get a tax code by ID.

Request

Path Parameters

NameTypeRequiredDescription
taxCodeIdstringYesTax Code ID

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "get_tax_code"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "get_tax_code",
      "params": {
        "taxCodeId": "<taxCodeId>"
      }
    }
  }
}
GETget_tax_rate/tax-rates/:taxRateId

Get a tax rate by ID.

Request

Path Parameters

NameTypeRequiredDescription
taxRateIdstringYesTax Rate ID

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "get_tax_rate"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "get_tax_rate",
      "params": {
        "taxRateId": "<taxRateId>"
      }
    }
  }
}
GETget_company_info/company-info

Get company information.

Request

No input parameters.

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "get_company_info"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "get_company_info",
      "params": {}
    }
  }
}
GETget_preferences/preferences/:preferencesId

Get company preferences.

Request

Path Parameters

NameTypeRequiredDescription
preferencesIdstringYesPreferences ID (usually '1')

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "get_preferences"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "get_preferences",
      "params": {
        "preferencesId": "<preferencesId>"
      }
    }
  }
}
GETreport_balance_sheet/reports/balance-sheet

Generate a Balance Sheet report showing assets, liabilities, and equity.

Request

Query Parameters

NameTypeRequiredDescription
start_datestringNoStart date for report period (YYYY-MM-DD)
end_datestringNoEnd date for report period (YYYY-MM-DD)
accounting_methodstringNoAccounting method: Cash or Accrual

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "report_balance_sheet"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "report_balance_sheet",
      "params": {}
    }
  }
}
GETreport_profit_and_loss/reports/profit-and-loss

Generate a Profit and Loss (Income Statement) report.

Request

Query Parameters

NameTypeRequiredDescription
start_datestringNoStart date for report period (YYYY-MM-DD)
end_datestringNoEnd date for report period (YYYY-MM-DD)
accounting_methodstringNoAccounting method: Cash or Accrual

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "report_profit_and_loss"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "report_profit_and_loss",
      "params": {}
    }
  }
}
GETreport_profit_and_loss_detail/reports/profit-and-loss-detail

Generate a detailed Profit and Loss report with transaction details.

Request

Query Parameters

NameTypeRequiredDescription
start_datestringNoStart date for report period (YYYY-MM-DD)
end_datestringNoEnd date for report period (YYYY-MM-DD)
accounting_methodstringNoAccounting method: Cash or Accrual

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "report_profit_and_loss_detail"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "report_profit_and_loss_detail",
      "params": {}
    }
  }
}
GETreport_trial_balance/reports/trial-balance

Generate a Trial Balance report.

Request

Query Parameters

NameTypeRequiredDescription
start_datestringNoStart date for report period (YYYY-MM-DD)
end_datestringNoEnd date for report period (YYYY-MM-DD)
accounting_methodstringNoAccounting method: Cash or Accrual

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "report_trial_balance"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "report_trial_balance",
      "params": {}
    }
  }
}
GETreport_cash_flow/reports/cash-flow

Generate a Statement of Cash Flows report.

Request

Query Parameters

NameTypeRequiredDescription
start_datestringNoStart date for report period (YYYY-MM-DD)
end_datestringNoEnd date for report period (YYYY-MM-DD)
accounting_methodstringNoAccounting method: Cash or Accrual

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "report_cash_flow"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "report_cash_flow",
      "params": {}
    }
  }
}
GETreport_inventory_valuation_summary/reports/inventory-valuation-summary

Generate an Inventory Valuation Summary report.

Request

Query Parameters

NameTypeRequiredDescription
start_datestringNoStart date for report period (YYYY-MM-DD)
end_datestringNoEnd date for report period (YYYY-MM-DD)
accounting_methodstringNoAccounting method: Cash or Accrual

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "report_inventory_valuation_summary"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "report_inventory_valuation_summary",
      "params": {}
    }
  }
}
GETreport_customer_sales/reports/customer-sales

Generate a Sales by Customer report.

Request

Query Parameters

NameTypeRequiredDescription
start_datestringNoStart date for report period (YYYY-MM-DD)
end_datestringNoEnd date for report period (YYYY-MM-DD)
accounting_methodstringNoAccounting method: Cash or Accrual

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "report_customer_sales"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "report_customer_sales",
      "params": {}
    }
  }
}
GETreport_item_sales/reports/item-sales

Generate a Sales by Product/Service report.

Request

Query Parameters

NameTypeRequiredDescription
start_datestringNoStart date for report period (YYYY-MM-DD)
end_datestringNoEnd date for report period (YYYY-MM-DD)
accounting_methodstringNoAccounting method: Cash or Accrual

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "report_item_sales"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "report_item_sales",
      "params": {}
    }
  }
}
GETreport_customer_income/reports/customer-income

Generate a Customer Income report.

Request

Query Parameters

NameTypeRequiredDescription
start_datestringNoStart date for report period (YYYY-MM-DD)
end_datestringNoEnd date for report period (YYYY-MM-DD)
accounting_methodstringNoAccounting method: Cash or Accrual

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "report_customer_income"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "report_customer_income",
      "params": {}
    }
  }
}
GETreport_customer_balance/reports/customer-balance

Generate a Customer Balance Summary report.

Request

Query Parameters

NameTypeRequiredDescription
start_datestringNoStart date for report period (YYYY-MM-DD)
end_datestringNoEnd date for report period (YYYY-MM-DD)
accounting_methodstringNoAccounting method: Cash or Accrual

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "report_customer_balance"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "report_customer_balance",
      "params": {}
    }
  }
}
GETreport_customer_balance_detail/reports/customer-balance-detail

Generate a Customer Balance Detail report.

Request

Query Parameters

NameTypeRequiredDescription
start_datestringNoStart date for report period (YYYY-MM-DD)
end_datestringNoEnd date for report period (YYYY-MM-DD)
accounting_methodstringNoAccounting method: Cash or Accrual

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "report_customer_balance_detail"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "report_customer_balance_detail",
      "params": {}
    }
  }
}
GETreport_aged_receivables/reports/aged-receivables

Generate an Accounts Receivable Aging report.

Request

Query Parameters

NameTypeRequiredDescription
start_datestringNoStart date for report period (YYYY-MM-DD)
end_datestringNoEnd date for report period (YYYY-MM-DD)
accounting_methodstringNoAccounting method: Cash or Accrual

Response

Returns raw JSON from the upstream API. No structured schema is available.

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "quickbooks",
      "method": "report_aged_receivables"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_quickbooks",
    "arguments": {
      "method": "report_aged_receivables",
      "params": {}
    }
  }
}