Skip to main content

QuickBooks

Get a project

Reads a QuickBooks project's name, status, dates, notes and custom fields, by its id or its name.

GEThttps://api.clickr.cloud/v2/integrations/quickbooks/projects
  • Uses 1 run: 100 a day on Standard, 500 on Velocity, reset at midnight UTC.
  • On Standard, 1 call every 30 seconds across the Projects endpoints.
  • Also served at /integrations/quickbooks/projects, for older integrations.
  • For assistants, the MCP tool get_quickbooks_project.

Request

curl -G https://api.clickr.cloud/v2/integrations/quickbooks/projects \
  -H "Authorization: Bearer $CLICKR_API_KEY" \
  --data-urlencode "projectName=Henderson Residence Addition" \
  --data-urlencode "callbackUrl=https://example.com/clickr/runs"

Response

200
{
  "receipt": "6729c1f04b7e3d0012a91e07"
}

Like the other QuickBooks actions this starts a run, so the project arrives in the run's data, not in this response. callbackUrl is required.

Query parameters

projectIdstring

QuickBooks' id for the project. Give this or projectName.

projectNamestring

The project's name. Give this or projectId.

callbackUrlstringRequired

A URL Clickr POSTs the project to when the run finishes.

Response

200, as JSON, once the run is queued. What the run did comes from Get a run, or is POSTed to your statusCallbackUrl.

receiptstring

The id of the run this call started. Pass it to Get a run.

Errors

JSON with an error and, on most, a message saying what to change. All errors

StatusErrorWhen
400Must include projectId or projectName in the query stringNeither was given.
400Must include callbackUrl in the query stringcallbackUrl is missing.
401No API Key providedThe Authorization header is missing.
401No account found for api key providedThe key isn't recognised: mistyped, revoked, or held by someone who has left the account.
401No integration found for accountThe account has no connector connected yet.
401This integration is still pending setup…QuickBooks isn't fully set up in Clickr: its sign-in or two-factor setup is unfinished. The error says what to do.
403ForbiddenYour access on the account doesn't include this action.
403Daily cap exceededThe account has used its runs for the day: 100 on Standard, 500 on Velocity. They reset at midnight UTC.
403Rate limit exceededA second call within 30 seconds on Standard. Velocity has no wait.