InfoApi.md

TheLogicStudio\CodatPHP\InfoApi

All URIs are relative to https://api.codat.io, except if the operation defines another base path.

Method	HTTP request	Description
companiesCompanyIdDataInfoGet()	GET /companies/{companyId}/data/info	Gets the latest basic info for a company.
companiesCompanyIdDataInfoPost()	POST /companies/{companyId}/data/info	Initiates the process of synchronising basic info for a company

companiesCompanyIdDataInfoGet()

companiesCompanyIdDataInfoGet($company_id): \TheLogicStudio\CodatPHP\Model\CodatDataContractsDatasetsCompanyDataset

Gets the latest basic info for a company.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: CodatLogin
$config = TheLogicStudio\CodatPHP\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure API key authorization: APIKeyAuth
$config = TheLogicStudio\CodatPHP\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TheLogicStudio\CodatPHP\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TheLogicStudio\CodatPHP\Api\InfoApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$company_id = 'company_id_example'; // string

try {
    $result = $apiInstance->companiesCompanyIdDataInfoGet($company_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InfoApi->companiesCompanyIdDataInfoGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
company_id	string

Return type

\TheLogicStudio\CodatPHP\Model\CodatDataContractsDatasetsCompanyDataset

Authorization

CodatLogin, APIKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

companiesCompanyIdDataInfoPost()

companiesCompanyIdDataInfoPost($company_id): \TheLogicStudio\CodatPHP\Model\CodatPublicApiModelsDataDataSet

Initiates the process of synchronising basic info for a company

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: CodatLogin
$config = TheLogicStudio\CodatPHP\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure API key authorization: APIKeyAuth
$config = TheLogicStudio\CodatPHP\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TheLogicStudio\CodatPHP\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new TheLogicStudio\CodatPHP\Api\InfoApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$company_id = 'company_id_example'; // string

try {
    $result = $apiInstance->companiesCompanyIdDataInfoPost($company_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InfoApi->companiesCompanyIdDataInfoPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
company_id	string

Return type

\TheLogicStudio\CodatPHP\Model\CodatPublicApiModelsDataDataSet

Authorization

CodatLogin, APIKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]