Bluestep JS Documentation
    Preparing search index...

    Provides access to the QuickBooks Online API using OAuth2 authorization code flow.

    The BlueStep system manages the OAuth2 tokens and authorization process, so this client can be used in scripts to interact with QuickBooks on behalf of the user directly in scripts.

    Index

    Constructors

    Methods

    • Builds a proxied authorization URL for OAuth2 authorization code flow.

      Parameters

      • redirectUri: string

        The URI to redirect to after authorization.

      Returns string

    • Makes an authenticated DELETE request to the QuickBooks API.

      Parameters

      • path: string

        The request path.

      Returns FetchedResource

    • Makes an authenticated GET request to the QuickBooks API.

      Parameters

      • path: string

        The request path (e.g., '/query?query=select * from Customer').

      Returns FetchedResource

    • Gets the stored QuickBooks realm (company) ID.

      Returns string

    • Checks if the user has authorized access to QuickBooks.

      Returns boolean

    • Makes an authenticated PATCH request to the QuickBooks API.

      Parameters

      • path: string

        The request path.

      • json: string

        The JSON body of the PATCH request.

      Returns FetchedResource

    post

    • post(path: string, json: string): FetchedResource

      Makes an authenticated POST request to the QuickBooks API.

      Parameters

      • path: string

        The request path.

      • json: string

        The JSON body of the POST request.

      Returns FetchedResource

    • Makes an authenticated PUT request to the QuickBooks API.

      Parameters

      • path: string

        The request path.

      • json: string

        The JSON body of the PUT request.

      Returns FetchedResource

    • Revokes the user's authorization and clears cached tokens.

      Returns void

    • Sets the QuickBooks realm (company) ID. Typically obtained from the authorization callback.

      Parameters

      • realmId: string

        The QuickBooks company ID.

      Returns void