Skip to main content

autessa.quickbooks

QuickBooks connector operations.

autessa.quickbooks.connectors.allREAD

autessa.quickbooks.connectors.all()

List every QuickBooks connector you can access in your company.

Returns all QuickBooks connectors in your current company that you have at least READ access to, newest-relevant first. Use a connector's connectorId with the other quickbooks.connectors.* methods. Credentials are never included in the returned DTOs.

Request fields

No fields.

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    connectors
    Type
    QuickBooksConnectorDto[]
    Description

autessa.quickbooks.connectors.deleteMUTATE

autessa.quickbooks.connectors.delete({ connectorId })

Permanently delete a QuickBooks connector and its stored credential.

Removes the QuickBooks connector for connectorId entirely (owner only), revoking every tool and script that relied on it. This deletes the Autessa record only — it does NOT revoke the grant on the Intuit side; use quickbooks.connectors.revokeAccess for that. Reconnecting requires the full OAuth flow again.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    message
    Type
    string
    Description

autessa.quickbooks.connectors.getREAD

autessa.quickbooks.connectors.get({ connectorId })

Fetch one QuickBooks connector by id.

Returns the full QuickBooks connector for connectorId, including its sharing/active state and the linked account metadata — but never the stored credential. Fails if you lack READ access to the connector.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    connector
    Type
    QuickBooksConnectorDto
    Description

autessa.quickbooks.connectors.getSharingDetailsREAD

autessa.quickbooks.connectors.getSharingDetails({ connectorId })

Read the current sharing configuration of a QuickBooks connector.

Returns how the QuickBooks connector is shared: the overall sharingLevel, the companyPermissionLevel granted for COMPANY sharing, the explicit sharedWith members, and your own userAccessLevel. Use before share to see the current state.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    sharingLevel
    Type
    "PRIVATE" | "SPECIFIC_MEMBER" | "COMPANY"
    Description
  • Name
    companyPermissionLevel
    Type
    "READ" | "WRITE" | "PUBLISH" | "ADMIN"
    Description
  • Name
    sharedWith
    Type
    UserShareWrapper[]
    Description
  • Name
    userAccessLevel
    Type
    "READ" | "WRITE" | "PUBLISH" | "ADMIN"
    Description

autessa.quickbooks.connectors.revokeAccessMUTATE

autessa.quickbooks.connectors.revokeAccess({ connectorId })

Revoke a QuickBooks connector's Intuit OAuth grant, keeping the connector for reconnection.

Revokes the connector's QuickBooks OAuth tokens at Intuit and clears them locally, leaving the connector record in place so it can be re-authorized later. Local tokens are cleared even if the remote Intuit revoke call fails; the connector is unusable until a human re-authorizes it through the browser OAuth reconnect flow. Unlike delete, the connector row is kept. Requires ADMIN access.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    message
    Type
    string
    Description
  • Name
    connector
    Type
    QuickBooksConnectorDto
    Description

autessa.quickbooks.connectors.shareMUTATE

autessa.quickbooks.connectors.share({ connectorId, level, accessLevel, usersToAdd, usersToRemove })

Change who in your company can use a QuickBooks connector.

Sets the sharing scope of the QuickBooks connector. level=PRIVATE keeps it to the owner; level=COMPANY grants everyone in the company the given accessLevel; level=SPECIFIC_MEMBER shares with named users — add them in usersToAdd and revoke via usersToRemove (each as a UserShareWrapper). accessLevel applies to COMPANY sharing. Sharing lets other members' tools and scripts use the connector; the credential itself is never exposed. Requires WRITE access.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.
  • Name
    level
    Type
    "PRIVATE" | "SPECIFIC_MEMBER" | "COMPANY"
    Description
  • Name
    accessLevel
    Type
    "READ" | "WRITE" | "PUBLISH" | "ADMIN"
    Description
  • Name
    usersToAdd
    Type
    UserShareWrapper[]
    Description
  • Name
    usersToRemove
    Type
    UserShareWrapper[]
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    level
    Type
    "PRIVATE" | "SPECIFIC_MEMBER" | "COMPANY"
    Description
  • Name
    accessLevel
    Type
    "READ" | "WRITE" | "PUBLISH" | "ADMIN"
    Description
  • Name
    usersWithAccess
    Type
    UserShareWrapper[]
    Description

autessa.quickbooks.connectors.updateMUTATE

autessa.quickbooks.connectors.update({ connectorId, connectorName, isActive })

Rename a QuickBooks connector or toggle whether it is active.

Applies a sparse patch to the QuickBooks connector for connectorId: send connectorName to rename it, isActive to enable/disable it. This is a partial update — omit a field to leave it unchanged; sending null or an empty name is ignored. Does not touch the stored credential or sharing. Requires WRITE access.

Request fields

  • Name
    connectorId
    Type
    string (opaque id)
    Description
    References external connector by opaque id.
  • Name
    connectorName
    Type
    string
    Description
  • Name
    isActive
    Type
    boolean
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    message
    Type
    string
    Description
  • Name
    connector
    Type
    QuickBooksConnectorDto
    Description