QuickBooks Online
Canonical tools, triggers, auth, schemas, and mock behavior for QuickBooks Online.
Run a valid quickbooks.create_customer call through the same SDK surface used by every toolkit.
Minimal tool call
import { Eyeball } from "@eyeball/sdk";
const eyeball = new Eyeball({
apiKey: process.env.EYEBALL_API_KEY!,
baseUrl: process.env.EYEBALL_EXECUTOR_URL!,
});
const output = await eyeball.tools.run(
"quickbooks.create_customer",
{
"name": "example_name"
},
{ userId: "demo_user",
idempotencyKey: "docs:quickbooks.create_customer:demo-1" },
);
console.log(output);The model receives canonical output. Your application retains the execution envelope through tools.execute or the execution APIs when it needs IDs, status, versions, and latency.
Supported canonical tools
| Tool | Purpose | Execution | Effect | Version |
|---|---|---|---|---|
quickbooks.create_customer | Create an ERP customer or business partner. Check for duplicates first when the provider does not enforce unique identities. | sync or async | mutation | 1.0.0 |
quickbooks.create_invoice | Create a draft sales invoice with portable line items, currency, dates, and memo fields. This does not send the invoice. | sync or async | mutation | 1.0.0 |
quickbooks.get_invoice | Retrieve one sales invoice with normalized line items, totals, and status. | sync or async | read | 1.0.0 |
quickbooks.list_customers | List ERP customers or business partners using portable text filters and pagination. | sync or async | read | 1.0.0 |
quickbooks.list_invoices | List sales invoices by customer, state, date, and pagination. | sync or async | read | 1.0.0 |
quickbooks.record_payment | Record or apply a payment to an invoice or customer account. Verify amount, currency, and target before mutating the ledger. | sync or async | mutation | 1.0.0 |
quickbooks.send_invoice | Issue or email an existing invoice through the provider workflow. This may notify the customer or post the accounting document. | sync or async | mutation | 1.0.0 |
Only the rows above are implemented. A capability tool omitted by this manifest returns not_supported; eyeball never synthesizes provider parity.
Supported canonical triggers
This manifest does not implement a canonical trigger.
Input and output schemas
quickbooks.create_customer
Input schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "urn:eyeball:erp_accounting:create_customer:1.0.0:quickbooks",
"type": "object",
"description": "Identity, billing, and address fields for a new customer.",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Customer display name.",
"minLength": 1
},
"companyName": {
"type": "string",
"description": "Legal or trading company name."
},
"email": {
"type": "string",
"format": "email",
"description": "Customer billing email."
},
"phone": {
"type": "string",
"description": "Customer phone number."
},
"currency": {
"type": "string",
"description": "ISO 4217 currency code.",
"pattern": "^[A-Z]{3}$"
},
"billingAddress": {
"type": "object",
"description": "Portable postal address fields.",
"additionalProperties": false,
"properties": {
"line1": {
"type": "string",
"description": "First address line."
},
"line2": {
"type": "string",
"description": "Second address line."
},
"city": {
"type": "string",
"description": "City or locality."
},
"region": {
"type": "string",
"description": "State, province, or region."
},
"postalCode": {
"type": "string",
"description": "Postal code."
},
"country": {
"type": "string",
"description": "ISO 3166-1 alpha-2 country code.",
"pattern": "^[A-Z]{2}$"
}
}
},
"properties": {
"type": "object",
"description": "Additional canonical ERP customer fields.",
"additionalProperties": true
},
"x_provider": {
"type": "object",
"additionalProperties": false,
"properties": {
"quickbooks": {
"type": "object",
"description": "QuickBooks company context for the operation.",
"additionalProperties": false,
"required": [
"realmId"
],
"properties": {
"realmId": {
"type": "string",
"description": "QuickBooks Online company realm identifier.",
"minLength": 1
}
}
}
}
}
}
}Output schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "urn:eyeball:erp_accounting:create_customer:output:1.0.0:quickbooks",
"type": "object",
"description": "The newly created ERP customer.",
"additionalProperties": false,
"required": [
"customer"
],
"properties": {
"customer": {
"type": "object",
"description": "A normalized ERP customer or business partner.",
"additionalProperties": false,
"required": [
"customerId",
"name"
],
"properties": {
"customerId": {
"type": "string",
"description": "Provider identifier of the customer.",
"minLength": 1
},
"name": {
"type": "string",
"description": "Customer display name."
},
"companyName": {
"type": "string",
"description": "Legal or trading company name."
},
"email": {
"type": "string",
"format": "email",
"description": "Customer billing email."
},
"phone": {
"type": "string",
"description": "Customer phone number."
},
"currency": {
"type": "string",
"description": "ISO 4217 currency code.",
"pattern": "^[A-Z]{3}$"
},
"active": {
"type": "boolean",
"description": "Whether the customer is active."
},
"billingAddress": {
"type": "object",
"description": "Portable postal address fields.",
"additionalProperties": false,
"properties": {
"line1": {
"type": "string",
"description": "First address line."
},
"line2": {
"type": "string",
"description": "Second address line."
},
"city": {
"type": "string",
"description": "City or locality."
},
"region": {
"type": "string",
"description": "State, province, or region."
},
"postalCode": {
"type": "string",
"description": "Postal code."
},
"country": {
"type": "string",
"description": "ISO 3166-1 alpha-2 country code.",
"pattern": "^[A-Z]{2}$"
}
}
},
"properties": {
"type": "object",
"description": "Additional provider-neutral customer fields.",
"additionalProperties": true
}
}
}
}
}quickbooks.create_invoice
Input schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "urn:eyeball:erp_accounting:create_invoice:1.0.0:quickbooks",
"type": "object",
"description": "Customer, line items, and terms for a new sales invoice.",
"additionalProperties": false,
"required": [
"customerId",
"lineItems"
],
"properties": {
"customerId": {
"type": "string",
"description": "Provider identifier of the billed customer.",
"minLength": 1
},
"currency": {
"type": "string",
"description": "ISO 4217 currency code.",
"pattern": "^[A-Z]{3}$",
"default": "USD"
},
"issueDate": {
"type": "string",
"format": "date",
"description": "Invoice issue date."
},
"dueDate": {
"type": "string",
"format": "date",
"description": "Invoice due date."
},
"memo": {
"type": "string",
"description": "Customer-facing or internal invoice memo."
},
"lineItems": {
"type": "array",
"description": "One or more sales-invoice lines.",
"minItems": 1,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"description",
"unitAmount"
],
"properties": {
"itemId": {
"type": "string",
"description": "Provider product, service, or ledger-item identifier.",
"minLength": 1
},
"description": {
"type": "string",
"description": "Line description.",
"minLength": 1
},
"quantity": {
"type": "number",
"description": "Billed quantity.",
"minimum": 0,
"default": 1
},
"unitAmount": {
"type": "number",
"description": "Price per unit in major currency units."
},
"taxAmount": {
"type": "number",
"description": "Tax amount for the line in major currency units.",
"minimum": 0
}
}
}
},
"properties": {
"type": "object",
"description": "Additional canonical invoice fields.",
"additionalProperties": true
},
"x_provider": {
"type": "object",
"additionalProperties": false,
"properties": {
"quickbooks": {
"type": "object",
"description": "QuickBooks company context for the operation.",
"additionalProperties": false,
"required": [
"realmId"
],
"properties": {
"realmId": {
"type": "string",
"description": "QuickBooks Online company realm identifier.",
"minLength": 1
}
}
}
}
}
}
}Output schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "urn:eyeball:erp_accounting:create_invoice:output:1.0.0:quickbooks",
"type": "object",
"description": "The newly created draft sales invoice.",
"additionalProperties": false,
"required": [
"invoice"
],
"properties": {
"invoice": {
"type": "object",
"description": "A normalized sales invoice.",
"additionalProperties": false,
"required": [
"invoiceId",
"customerId",
"status",
"currency",
"total",
"balance",
"lineItems"
],
"properties": {
"invoiceId": {
"type": "string",
"description": "Provider identifier of the invoice.",
"minLength": 1
},
"number": {
"type": "string",
"description": "Human-readable invoice number."
},
"customerId": {
"type": "string",
"description": "Provider identifier of the billed customer.",
"minLength": 1
},
"status": {
"type": "string",
"description": "Normalized or provider invoice state."
},
"currency": {
"type": "string",
"description": "ISO 4217 currency code.",
"pattern": "^[A-Z]{3}$"
},
"total": {
"type": "number",
"description": "Invoice total in major currency units."
},
"balance": {
"type": "number",
"description": "Outstanding balance in major currency units."
},
"issueDate": {
"type": "string",
"format": "date",
"description": "Invoice issue date."
},
"dueDate": {
"type": "string",
"format": "date",
"description": "Invoice due date."
},
"sentAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the invoice was sent or issued."
},
"lineItems": {
"type": "array",
"description": "Normalized sales-invoice lines.",
"items": {
"type": "object",
"description": "One normalized sales-invoice line.",
"additionalProperties": false,
"required": [
"description",
"quantity",
"unitAmount",
"amount"
],
"properties": {
"lineId": {
"type": "string",
"description": "Provider identifier of the invoice line.",
"minLength": 1
},
"itemId": {
"type": "string",
"description": "Provider product, service, or ledger-item identifier.",
"minLength": 1
},
"description": {
"type": "string",
"description": "Line description."
},
"quantity": {
"type": "number",
"description": "Billed quantity.",
"minimum": 0
},
"unitAmount": {
"type": "number",
"description": "Price per unit in major currency units."
},
"amount": {
"type": "number",
"description": "Extended line amount in major currency units."
},
"taxAmount": {
"type": "number",
"description": "Tax amount for the line in major currency units.",
"minimum": 0
}
}
}
},
"properties": {
"type": "object",
"description": "Additional provider-neutral invoice fields.",
"additionalProperties": true
}
}
}
}
}quickbooks.get_invoice
Input schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "urn:eyeball:erp_accounting:get_invoice:1.0.0:quickbooks",
"type": "object",
"description": "Identifier of the invoice to retrieve.",
"additionalProperties": false,
"required": [
"invoiceId"
],
"properties": {
"invoiceId": {
"type": "string",
"description": "Provider identifier of the invoice.",
"minLength": 1
},
"x_provider": {
"type": "object",
"additionalProperties": false,
"properties": {
"quickbooks": {
"type": "object",
"description": "QuickBooks company context for the operation.",
"additionalProperties": false,
"required": [
"realmId"
],
"properties": {
"realmId": {
"type": "string",
"description": "QuickBooks Online company realm identifier.",
"minLength": 1
}
}
}
}
}
}
}Output schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "urn:eyeball:erp_accounting:get_invoice:output:1.0.0:quickbooks",
"type": "object",
"description": "The requested sales invoice.",
"additionalProperties": false,
"required": [
"invoice"
],
"properties": {
"invoice": {
"type": "object",
"description": "A normalized sales invoice.",
"additionalProperties": false,
"required": [
"invoiceId",
"customerId",
"status",
"currency",
"total",
"balance",
"lineItems"
],
"properties": {
"invoiceId": {
"type": "string",
"description": "Provider identifier of the invoice.",
"minLength": 1
},
"number": {
"type": "string",
"description": "Human-readable invoice number."
},
"customerId": {
"type": "string",
"description": "Provider identifier of the billed customer.",
"minLength": 1
},
"status": {
"type": "string",
"description": "Normalized or provider invoice state."
},
"currency": {
"type": "string",
"description": "ISO 4217 currency code.",
"pattern": "^[A-Z]{3}$"
},
"total": {
"type": "number",
"description": "Invoice total in major currency units."
},
"balance": {
"type": "number",
"description": "Outstanding balance in major currency units."
},
"issueDate": {
"type": "string",
"format": "date",
"description": "Invoice issue date."
},
"dueDate": {
"type": "string",
"format": "date",
"description": "Invoice due date."
},
"sentAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the invoice was sent or issued."
},
"lineItems": {
"type": "array",
"description": "Normalized sales-invoice lines.",
"items": {
"type": "object",
"description": "One normalized sales-invoice line.",
"additionalProperties": false,
"required": [
"description",
"quantity",
"unitAmount",
"amount"
],
"properties": {
"lineId": {
"type": "string",
"description": "Provider identifier of the invoice line.",
"minLength": 1
},
"itemId": {
"type": "string",
"description": "Provider product, service, or ledger-item identifier.",
"minLength": 1
},
"description": {
"type": "string",
"description": "Line description."
},
"quantity": {
"type": "number",
"description": "Billed quantity.",
"minimum": 0
},
"unitAmount": {
"type": "number",
"description": "Price per unit in major currency units."
},
"amount": {
"type": "number",
"description": "Extended line amount in major currency units."
},
"taxAmount": {
"type": "number",
"description": "Tax amount for the line in major currency units.",
"minimum": 0
}
}
}
},
"properties": {
"type": "object",
"description": "Additional provider-neutral invoice fields.",
"additionalProperties": true
}
}
}
}
}quickbooks.list_customers
Input schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "urn:eyeball:erp_accounting:list_customers:1.0.0:quickbooks",
"type": "object",
"description": "Customer filters and pagination.",
"additionalProperties": false,
"properties": {
"query": {
"type": "string",
"description": "Case-insensitive customer name or email query.",
"minLength": 1
},
"active": {
"type": "boolean",
"description": "Filter by active state."
},
"pageSize": {
"type": "integer",
"description": "Maximum number of customers to return in one page.",
"minimum": 1,
"maximum": 100,
"default": 50
},
"pageToken": {
"type": "string",
"description": "Opaque continuation token from a previous customer page.",
"minLength": 1
},
"x_provider": {
"type": "object",
"additionalProperties": false,
"properties": {
"quickbooks": {
"type": "object",
"description": "QuickBooks company context for the operation.",
"additionalProperties": false,
"required": [
"realmId"
],
"properties": {
"realmId": {
"type": "string",
"description": "QuickBooks Online company realm identifier.",
"minLength": 1
}
}
}
}
}
}
}Output schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "urn:eyeball:erp_accounting:list_customers:output:1.0.0:quickbooks",
"type": "object",
"description": "One page of ERP customers.",
"additionalProperties": false,
"required": [
"customers"
],
"properties": {
"customers": {
"type": "array",
"description": "Customer records in provider order.",
"items": {
"type": "object",
"description": "A normalized ERP customer or business partner.",
"additionalProperties": false,
"required": [
"customerId",
"name"
],
"properties": {
"customerId": {
"type": "string",
"description": "Provider identifier of the customer.",
"minLength": 1
},
"name": {
"type": "string",
"description": "Customer display name."
},
"companyName": {
"type": "string",
"description": "Legal or trading company name."
},
"email": {
"type": "string",
"format": "email",
"description": "Customer billing email."
},
"phone": {
"type": "string",
"description": "Customer phone number."
},
"currency": {
"type": "string",
"description": "ISO 4217 currency code.",
"pattern": "^[A-Z]{3}$"
},
"active": {
"type": "boolean",
"description": "Whether the customer is active."
},
"billingAddress": {
"type": "object",
"description": "Portable postal address fields.",
"additionalProperties": false,
"properties": {
"line1": {
"type": "string",
"description": "First address line."
},
"line2": {
"type": "string",
"description": "Second address line."
},
"city": {
"type": "string",
"description": "City or locality."
},
"region": {
"type": "string",
"description": "State, province, or region."
},
"postalCode": {
"type": "string",
"description": "Postal code."
},
"country": {
"type": "string",
"description": "ISO 3166-1 alpha-2 country code.",
"pattern": "^[A-Z]{2}$"
}
}
},
"properties": {
"type": "object",
"description": "Additional provider-neutral customer fields.",
"additionalProperties": true
}
}
}
},
"nextPageToken": {
"type": "string",
"description": "Opaque token to request the next page of customers; absent when the result is complete.",
"minLength": 1
}
}
}quickbooks.list_invoices
Input schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "urn:eyeball:erp_accounting:list_invoices:1.0.0:quickbooks",
"type": "object",
"description": "Invoice filters and pagination.",
"additionalProperties": false,
"properties": {
"customerId": {
"type": "string",
"description": "Provider identifier of the billed customer.",
"minLength": 1
},
"status": {
"type": "string",
"description": "Invoice state to match.",
"minLength": 1
},
"issuedAfter": {
"type": "string",
"format": "date",
"description": "Return invoices issued on or after this date."
},
"issuedBefore": {
"type": "string",
"format": "date",
"description": "Return invoices issued before this date."
},
"pageSize": {
"type": "integer",
"description": "Maximum number of invoices to return in one page.",
"minimum": 1,
"maximum": 100,
"default": 50
},
"pageToken": {
"type": "string",
"description": "Opaque continuation token from a previous invoice page.",
"minLength": 1
},
"x_provider": {
"type": "object",
"additionalProperties": false,
"properties": {
"quickbooks": {
"type": "object",
"description": "QuickBooks company context for the operation.",
"additionalProperties": false,
"required": [
"realmId"
],
"properties": {
"realmId": {
"type": "string",
"description": "QuickBooks Online company realm identifier.",
"minLength": 1
}
}
}
}
}
}
}Output schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "urn:eyeball:erp_accounting:list_invoices:output:1.0.0:quickbooks",
"type": "object",
"description": "One page of normalized sales invoices.",
"additionalProperties": false,
"required": [
"invoices"
],
"properties": {
"invoices": {
"type": "array",
"description": "Invoices in provider order.",
"items": {
"type": "object",
"description": "A normalized sales invoice.",
"additionalProperties": false,
"required": [
"invoiceId",
"customerId",
"status",
"currency",
"total",
"balance",
"lineItems"
],
"properties": {
"invoiceId": {
"type": "string",
"description": "Provider identifier of the invoice.",
"minLength": 1
},
"number": {
"type": "string",
"description": "Human-readable invoice number."
},
"customerId": {
"type": "string",
"description": "Provider identifier of the billed customer.",
"minLength": 1
},
"status": {
"type": "string",
"description": "Normalized or provider invoice state."
},
"currency": {
"type": "string",
"description": "ISO 4217 currency code.",
"pattern": "^[A-Z]{3}$"
},
"total": {
"type": "number",
"description": "Invoice total in major currency units."
},
"balance": {
"type": "number",
"description": "Outstanding balance in major currency units."
},
"issueDate": {
"type": "string",
"format": "date",
"description": "Invoice issue date."
},
"dueDate": {
"type": "string",
"format": "date",
"description": "Invoice due date."
},
"sentAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the invoice was sent or issued."
},
"lineItems": {
"type": "array",
"description": "Normalized sales-invoice lines.",
"items": {
"type": "object",
"description": "One normalized sales-invoice line.",
"additionalProperties": false,
"required": [
"description",
"quantity",
"unitAmount",
"amount"
],
"properties": {
"lineId": {
"type": "string",
"description": "Provider identifier of the invoice line.",
"minLength": 1
},
"itemId": {
"type": "string",
"description": "Provider product, service, or ledger-item identifier.",
"minLength": 1
},
"description": {
"type": "string",
"description": "Line description."
},
"quantity": {
"type": "number",
"description": "Billed quantity.",
"minimum": 0
},
"unitAmount": {
"type": "number",
"description": "Price per unit in major currency units."
},
"amount": {
"type": "number",
"description": "Extended line amount in major currency units."
},
"taxAmount": {
"type": "number",
"description": "Tax amount for the line in major currency units.",
"minimum": 0
}
}
}
},
"properties": {
"type": "object",
"description": "Additional provider-neutral invoice fields.",
"additionalProperties": true
}
}
}
},
"nextPageToken": {
"type": "string",
"description": "Opaque token to request the next page of invoices; absent when the result is complete.",
"minLength": 1
}
}
}quickbooks.record_payment
Input schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "urn:eyeball:erp_accounting:record_payment:1.0.0:quickbooks",
"type": "object",
"description": "Invoice or customer target, amount, and reference for a received payment.",
"additionalProperties": false,
"required": [
"amount"
],
"properties": {
"invoiceId": {
"type": "string",
"description": "Provider identifier of the invoice receiving payment.",
"minLength": 1
},
"customerId": {
"type": "string",
"description": "Provider identifier of the customer account receiving payment.",
"minLength": 1
},
"amount": {
"type": "number",
"description": "Payment amount in major currency units.",
"exclusiveMinimum": 0
},
"currency": {
"type": "string",
"description": "ISO 4217 currency code.",
"pattern": "^[A-Z]{3}$",
"default": "USD"
},
"paymentDate": {
"type": "string",
"format": "date",
"description": "Accounting date for the payment."
},
"reference": {
"type": "string",
"description": "External payment reference or memo."
},
"x_provider": {
"type": "object",
"additionalProperties": false,
"properties": {
"quickbooks": {
"type": "object",
"description": "QuickBooks company context for the operation.",
"additionalProperties": false,
"required": [
"realmId"
],
"properties": {
"realmId": {
"type": "string",
"description": "QuickBooks Online company realm identifier.",
"minLength": 1
}
}
}
}
}
},
"anyOf": [
{
"required": [
"invoiceId"
],
"properties": {
"invoiceId": {
"type": "string",
"description": "Provider identifier of the invoice receiving payment.",
"minLength": 1
}
}
},
{
"required": [
"customerId"
],
"properties": {
"customerId": {
"type": "string",
"description": "Provider identifier of the customer account receiving payment.",
"minLength": 1
}
}
}
]
}Output schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "urn:eyeball:erp_accounting:record_payment:output:1.0.0:quickbooks",
"type": "object",
"description": "The recorded payment and its application target.",
"additionalProperties": false,
"required": [
"paymentId",
"amount",
"currency",
"status",
"recordedAt"
],
"properties": {
"paymentId": {
"type": "string",
"description": "Provider identifier of the payment record.",
"minLength": 1
},
"invoiceId": {
"type": "string",
"description": "Provider identifier of the invoice receiving payment.",
"minLength": 1
},
"customerId": {
"type": "string",
"description": "Provider identifier of the customer account receiving payment.",
"minLength": 1
},
"amount": {
"type": "number",
"description": "Recorded payment amount in major currency units."
},
"currency": {
"type": "string",
"description": "ISO 4217 currency code.",
"pattern": "^[A-Z]{3}$"
},
"status": {
"type": "string",
"description": "Provider payment state."
},
"recordedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the payment was recorded."
}
}
}quickbooks.send_invoice
Input schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "urn:eyeball:erp_accounting:send_invoice:1.0.0:quickbooks",
"type": "object",
"description": "Invoice identifier and optional delivery address.",
"additionalProperties": false,
"required": [
"invoiceId"
],
"properties": {
"invoiceId": {
"type": "string",
"description": "Provider identifier of the invoice.",
"minLength": 1
},
"email": {
"type": "string",
"format": "email",
"description": "Explicit delivery address when the provider supports it."
},
"x_provider": {
"type": "object",
"additionalProperties": false,
"properties": {
"quickbooks": {
"type": "object",
"description": "QuickBooks company context for the operation.",
"additionalProperties": false,
"required": [
"realmId"
],
"properties": {
"realmId": {
"type": "string",
"description": "QuickBooks Online company realm identifier.",
"minLength": 1
}
}
}
}
}
}
}Output schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "urn:eyeball:erp_accounting:send_invoice:output:1.0.0:quickbooks",
"type": "object",
"description": "Result of issuing or sending the invoice.",
"additionalProperties": false,
"required": [
"invoiceId",
"status",
"sentAt"
],
"properties": {
"invoiceId": {
"type": "string",
"description": "Provider identifier of the invoice.",
"minLength": 1
},
"status": {
"type": "string",
"description": "Invoice state after the send workflow."
},
"sentAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the provider completed the workflow."
}
}
}Authentication
| Property | Value |
|---|---|
| Auth class | oauth2 |
| Required scopes | None |
| Optional scopes | com.intuit.quickbooks.accounting |
| Credential fields | None |
Credentials are resolved inside the executor by CredentialProvider. They never belong in tool input, x_provider, model context, logs, or execution output.
Provider-specific extensions
quickbooks.list_customers input
input.x_provider.quickbooks accepts:
{
"type": "object",
"description": "QuickBooks company context for the operation.",
"additionalProperties": false,
"required": [
"realmId"
],
"properties": {
"realmId": {
"type": "string",
"description": "QuickBooks Online company realm identifier.",
"minLength": 1
}
}
}quickbooks.create_customer input
input.x_provider.quickbooks accepts:
{
"type": "object",
"description": "QuickBooks company context for the operation.",
"additionalProperties": false,
"required": [
"realmId"
],
"properties": {
"realmId": {
"type": "string",
"description": "QuickBooks Online company realm identifier.",
"minLength": 1
}
}
}quickbooks.list_invoices input
input.x_provider.quickbooks accepts:
{
"type": "object",
"description": "QuickBooks company context for the operation.",
"additionalProperties": false,
"required": [
"realmId"
],
"properties": {
"realmId": {
"type": "string",
"description": "QuickBooks Online company realm identifier.",
"minLength": 1
}
}
}quickbooks.get_invoice input
input.x_provider.quickbooks accepts:
{
"type": "object",
"description": "QuickBooks company context for the operation.",
"additionalProperties": false,
"required": [
"realmId"
],
"properties": {
"realmId": {
"type": "string",
"description": "QuickBooks Online company realm identifier.",
"minLength": 1
}
}
}quickbooks.create_invoice input
input.x_provider.quickbooks accepts:
{
"type": "object",
"description": "QuickBooks company context for the operation.",
"additionalProperties": false,
"required": [
"realmId"
],
"properties": {
"realmId": {
"type": "string",
"description": "QuickBooks Online company realm identifier.",
"minLength": 1
}
}
}quickbooks.send_invoice input
input.x_provider.quickbooks accepts:
{
"type": "object",
"description": "QuickBooks company context for the operation.",
"additionalProperties": false,
"required": [
"realmId"
],
"properties": {
"realmId": {
"type": "string",
"description": "QuickBooks Online company realm identifier.",
"minLength": 1
}
}
}quickbooks.record_payment input
input.x_provider.quickbooks accepts:
{
"type": "object",
"description": "QuickBooks company context for the operation.",
"additionalProperties": false,
"required": [
"realmId"
],
"properties": {
"realmId": {
"type": "string",
"description": "QuickBooks Online company realm identifier.",
"minLength": 1
}
}
}Provider differences may appear only under x_provider.quickbooks and only when the schema above declares them.
Sync and async behavior
All tools are synchronous by nature, but callers may choose mode: "async" to queue them.
Mutations require a stable Idempotency-Key. The TypeScript SDK accepts it as idempotencyKey; it is never part of the JSON request body.
REST example
curl "$EYEBALL_EXECUTOR_URL/v1/execute" \
-H "Authorization: Bearer $EYEBALL_API_KEY" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: docs:quickbooks.create_customer:demo-1' \
--data '{"tool":"quickbooks.create_customer","userId":"demo_user","input":{"name":"example_name"},"mode":"sync"}'Mock support
Point EYEBALL_EXECUTOR_URL at a mock-configured executor to run through the real catalog, validation, credential seam, adapter, normalized errors, and execution records with no QuickBooks Online account. Mock selection changes the executor endpoint and trusted provider base-URL configuration, never the execute request.
Limitations
- This page describes the manifest's explicit P0 subset, not every operation offered by the provider.
- Provider account policy, consent UI, quota details, and current wire compatibility still require a real-provider certification pass.
- Fields outside the canonical schemas and declared
x_providerextensions are rejected.
Versions
| Contract | Version |
|---|---|
| Runtime catalog | 1.1 |
| Manifest catalog | 1.0 |
| Manifest schema | 1.0 |
| Source | activepieces-bridge |
| Tier | P0 |
| Capabilities | erp_accounting |
Next
Use Testing with mocks to exercise this toolkit before connecting a live provider account.