QuickBooks Integrator 2020 Delphi Edition

Questions / Feedback?

AuthorizedUser Type

Client login, password, and QuickBooks connection information.

Remarks

The AuthorizedUser type contains the User and Password of a client that is allowed to connect to the QBConnector component. When a client connects, the user name and password supplied in the HTTP authorization header are compared to the credentials of each authorized user. If a match is found, the component uses the information in the QBConnectionString to make a connection to QuickBooks.

Fields

AuthMode
TiqbAuthModes

This property defines how the user is authorized.

There are two ways that the user may be authorized, against the user list defined in the component, or as a Windows user. From the client side the process of connecting is exactly the same no matter which option you choose. Possible values are:

0 (amNormal - default) The user is authenticated against the user list defined in the component.
1 (amWindows) The user is authenticated as a Windows user.

When using the amNormal AuthMode (default) the user's password will be checked against the Password property.

When using the amWindows AuthMode the component will validate the user's credentials with Windows. When calling AddUser the Password parameter should be set to empty string.

Password
String

A password associated with the User who is allowed to connect to the component. Connecting clients' authorization headers will be compared against this User and Password.

QBConnectionString
String

An aggregate consisting of various QuickBooks connection properties that are used to connect the authorized client to the QuickBooks application.

The connection properties should be formatted in a sequence as follows:

propertyname = "propertyvalue" propertyname = "propertyvalue" ...

The order is irrelevant, and the whitespace around the equal sign is optional.

The following properties are currently supported:

ApplicationNameThe name of the developer's application. This name will appear when the application first connects to QuickBooks; QuickBooks will display this name and prompt the user to grant or refuse access.
CompanyFileThe name of the company file to open. If QuickBooks is not currently open with a company file, QuickBooks will be automatically opened in the background with the file specified. Do not set CompanyFile when QuickBooks is open; if QuickBooks is open through the application UI, only that company file may be used.
QBConnectionModeThe mode of connection to QuickBooks. Specifies whether the integrated application logs in using single-user or multi-user mode. Allowable values include "DontCare", "SingleUserMode" and "MultiUserMode".

User
String

Name of a user which is allowed to connect to the component. Connecting clients' authorization headers will be compared against this User and Password.

Constructors

constructor Create();
constructor Create(valUser: String; valPassword: String);
constructor Create(valUser: String; valPassword: String; valQBConnectionString: String);
constructor Create(valUser: String; valPassword: String; valQBConnectionString: String; valAuthMode: TiqbAuthModes);

Copyright (c) 2021 /n software inc. - All rights reserved.
QuickBooks Integrator 2020 Delphi Edition - Version 20.0 [Build 7941]