class IntacctClient extends AbstractClient

Constants

PROFILE_ENV_NAME

Profile environment name

Methods

__construct(array $params = array())

Initializes the class with the given parameters.

string
generateRandomControlId()

Generate a version 4 (random) UUID

getSessionCreds()

Session credentials

execute(Content $contentBlock, bool $transaction = false, string $requestControlId = null, bool $uniqueFunctionControlIds = false, array $params = array())

Execute a synchronous request to the API

executeAsync(Content $contentBlock, string $asyncPolicyId, bool $transaction = false, string $requestControlId = null, bool $uniqueFunctionControlIds = false, array $params = array())

Execute an asynchronous request to the API

Details

at line line 52
__construct(array $params = array())

Initializes the class with the given parameters.

The constructor accepts the following options:

  • profile_name (string, default=string "default") Profile name to use
  • profile_file (string) Profile file to load from
  • sender_id (string) Intacct sender ID
  • sender_password (string) Intacct sender password
  • session_id (string) Intacct session ID
  • endpoint_url (string) Endpoint URL
  • company_id (string) Intacct company ID
  • user_id (string) Intacct user ID
  • user_password (string) Intacct user password
  • max_retries (int, default=int(5)) Max number of retries
  • no_retry_server_error_codes (int[], default=array(524)) HTTP server error codes to abort retrying if one occurs
  • verify_ssl (bool, default=bool(true)) Verify SSL certificate of response
  • logger (Psr\Log\LoggerInterface)
  • log_formatter (Intacct\Logging\MessageFormatter) Log formatter
  • log_level (int, default=int(400)) Log level
  • mock_handler (GuzzleHttp\Handler\MockHandler) Mock handler for unit tests

Parameters

array $params Client configuration options

in AbstractClient at line line 139
string generateRandomControlId()

Generate a version 4 (random) UUID

Return Value

string

at line line 62
SessionCredentials getSessionCreds()

Session credentials

Return Value

SessionCredentials

at line line 78
SynchronousResponse execute(Content $contentBlock, bool $transaction = false, string $requestControlId = null, bool $uniqueFunctionControlIds = false, array $params = array())

Execute a synchronous request to the API

Parameters

Content $contentBlock Content block to send
bool $transaction Force the operation to be one transaction
string $requestControlId Request control ID
bool $uniqueFunctionControlIds Force the function control ID's to be unique
array $params Overriding params, see IntacctClient::__construct()

Return Value

SynchronousResponse

at line line 106
AsynchronousResponse executeAsync(Content $contentBlock, string $asyncPolicyId, bool $transaction = false, string $requestControlId = null, bool $uniqueFunctionControlIds = false, array $params = array())

Execute an asynchronous request to the API

Parameters

Content $contentBlock Content block to send
string $asyncPolicyId Intacct asynchronous policy ID
bool $transaction Force the operation to be one transaction
string $requestControlId Request control ID
bool $uniqueFunctionControlIds Force the function control ID's to be unique
array $params Overriding params, see IntacctClient::__construct()

Return Value

AsynchronousResponse