 AddTrustedEntity | Adds a trusted entity. |
| AuthenticateUser | Checks whether a pair of username and password exist and match in the current SAP Business One company .
Note: this method is for superuser only. |
| ChangePassword | Changes the password of the actual user connected to SAP Business One. The system verifies whether the new password complies to the company password policy and if not, the system returns an error. |
| Connect | Connects to the SAP Business One company database. |
| DeleteTrustedEntity | Deletes a trusted entity. |
| Disconnect | Disconnects an active connection with the company database. |
| EndTransaction | Ends a global transaction that started with the StartTransaction method. |
| GetBusinessObject | Creates a new business object. |
| GetBusinessObjectFromXML | Creates a new business object based on a valid XML file. |
| GetBusinessObjectXmlSchema | Retrieves the XML schema that is used by the object to validate the input XML files. |
| GetCompanyDate | Get Company DATE |
| GetCompanyList | Retrieves a list of the company databases located on the specified server. |
| GetCompanyService | Creates a new CompanyService. |
| GetCompanyTime | Get Company Time |
| GetContextCookie | Creates a cookie that consists of the current DI API session for Sign-on Procedure. |
| GetDBServerDate | method GetDBServerDate |
| GetDBServerTime | method GetDBServerTime |
| GetLastError | Retrieves the error code and message for the last error for any object tied to the Company object. |
| GetLastErrorCode | Retrieves the last error code issued by any object related to the Company object. |
| GetLastErrorContext | method GetLastErrorContext |
| GetLastErrorDescription | Retrieves the description of the last error issued by any object related to the Company object. |
| GetNewObjectCode | Retrieves the key of the last added record. |
| GetNewObjectKey | Retrieves the key of the last added record. |
| GetNewObjectType | Gets the last added object type. |
| GetRegisteredServersList | Retrieves a list of servers registered with the System Landscape Directory (SLD) server.
Use this method when creating a window for logging into SAP Business One. Create a dropdown list of servers and allow the user to select the server to which to connect. |
| GetTenantList | method GetTenantList |
| GetTrustedEntitiesAllowedList | method GetTrustedEntitiesAllowedList |
| GetXMLelementCount | Retrieves the number of business objects described in an XML file. |
| GetXMLobjectType | Retrieves the type of business object described in an XML file on a specific offset specified by the Index parameter. |
| IsDTCTransactionObjectSet | Checks whether or not the DTCTransactionObject is set. |
| SetSboLoginContext | Decodes the encrypted connection information received from the UI API -- based on the cookie created by the GetContextCookie method -- and then sets the connection information for log on to the Company database.
See Sign-on Procedure. |
| StartTransaction | Starts a transaction, allowing you to perform data operations on several business objects.
Use the EndTransaction method to end the transaction and free locked records, allowing other users to access them. |
 AccessToken | When you enable Identity and Authentication Management as of SAP Business One 10.0 FP 2208, you can obtain an access token from the authorization server and use the access token to access some server resources. |
| AddonIdentifier | Sets or returns a string identifier that your add-on must use to connect to SAP Business One database. |
| Application | To connect with SAP Business One, you can set this property to a SAPbouiCOM.Application object, and then call the Connect method without specifying any other connection properties -- the properties are taken from the UI API Application object. |
| AttachMentPath | Returns the path to all the company's saved mail attachments and all contact related files. |
| BitMapPath | Returns the path to all the picture files of the company, which are related to the Picture property of Items object, Picture property of BusinessPartners object, and documents. |
| CompanyDB | Sets or returns the name of the company SQL database . |
| CompanyID | Identifies a unique company. |
| CompanyName | Returns the company name as defined in the database. |
| Connected | Returns a Boolean value that specifies whether or not the Company object is connected to the database. |
| DbPassword | Sets or returns the password for establishing a connection to the database server.
The field is not mandatory, as the database credentials are stored in the System Landscape Directory (SLD) server and you can use these values instead. |
| DbServerType | The database type. |
| DbUserName | Sets or returns the user name for establishing a connection to the database server.
The field is not mandatory, as the database credentials are stored in the System Landscape Directory (SLD) server and you can use these values instead. |
| DTCTransactionObject | This interface supports Distributed Transactions for MS-SQL database that are controlled by MS-DTC engine (Microsoft Distributed Transaction Coordinator). DTC is a system service that coordinates transactions so that work can be committed as an atomic transaction even if it spans multiple resource managers on multiple computers, regardless of failures. This interface is applicable for the following environment:
|
| ExcelDocsPath | Returns the path to the Microsoft Excel documents exported from the SAP Business One application. |
| InTransaction | Returns a Boolean value that specifies whether or not the transaction is active. |
| language | Sets or returns the resource language of the object. |
| LicenseServer | Deprecated in DI API 9.2 PL05. Please use SLDServer instead. The DI API will continue to support this property for backward compatibility. The license server name and port for connecting to the company database. The value is in the format myServer:30000. If no value is given, the default license server and port are used. If a server is given but no port is given, 30000 is used for the port. |
| MinimalSupportedVersion | Returns the minimal version of the Company database that the Add-on supports. |
| Password | Sets or returns the SAP Business One password issued to the user. |
| SecurityCode | property SecurityCode |
| Server | Sets or returns the SQL server to which the object connects. |
| SLDServer | Set the System Landscape Directory (SLD) server address to connect to the company database and to retrieve the real license address from the SLD server. |
| UserName | Sets or returns the user ID, which is used for log on to the SAP Business One application. |
| UserSignature | Returns the identification key of the active user who operates the system. |
| UserTables | Returns the UserTables object, which is the interface to the tables defined by the user. This object allows you to access to the user tables as if they were regular business objects. |
| UseTrusted | Sets or returns a Boolean value that specifies whether the Company object uses NT authentication, or the internal SQL Server user ObsCommon, to establish a connection with the SQL Server. |
| Version | Returns the version of the Company database. |
| WordDocsPath | Returns the path to the Microsoft Word documents exported from the SAP Business One application. This directory also contains Microsoft Word templates, which are used for exporting data to Word documents. |
| XMLAsString | Sets or returns a Boolean value that determines whether the XML data will be saved as a file or transferred as a string. |
| XmlExportType | Sets or returns a valid value of BoXmlExportTypes that specifies the types for exporting data from the database to XML format. |
| XmlFiltered | To improve security, you can set the property to true and call the AddTrustedEntity, DeleteTrustedEntity, and GetTrustedEntitiesAllowedList to prevent XML injection. |
 ProgressIndicator | Progress indicator for long process execution. To be supported in future releases. |