API documentation | API docs for agents | OpenAPI 3.1

reference-data

ark.list_quickbooks_reference_data

Lists QuickBooks accounts, customers, custom fields, payment accounts, items, terms, tax codes, or vendors for accounting setup, mapping, and sync troubleshooting.

Availability: Expanded preview
Scopes: billing:read
ARK permissions: canViewBilling
Team visibility: Not entity-scoped
Idempotency-Key: Not required
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

resourcequeryQuickBooksReferenceResourcerequired
searchquerystring: min length: 1; max length: 100
max_resultsqueryinteger: default: 100; min: 1; max: 1000
account_typequerystring: max length: 100
classificationquerystring: max length: 100
categoryquerystring: one of: vendor_expense
item_typequerystring: one of: Service, Inventory, NonInventory
include_configqueryboolean: default: false
account_usagequerystring: one of: carrier, customer; default: "carrier"

Request body

None.

Example request

Shell

curl 'https://arktms.com/api/v1/integrations/quickbooks/reference-data?resource=<resource>' \
  -H "Authorization: Bearer $ARK_API_TOKEN"

Success response

QuickBooks reference data

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.resourcestringrequired

one of: accounts, customers, custom_fields, payment_accounts, items, terms, tax_codes, vendors

data.recordsarray<object>required

data.totalintegerrequired

data.maxResultsintegerrequired

data.hasMorebooleanrequired

data.queryobjectrequired

data.configobject | nullrequired

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 502: External provider or worker queue could not be reached