Skip to content

Latest commit

 

History

History
215 lines (152 loc) · 8.1 KB

ItemsApi.md

File metadata and controls

215 lines (152 loc) · 8.1 KB

TheLogicStudio\CodatPHP\ItemsApi

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

Method HTTP request Description
companiesCompanyIdConnectionsConnectionIdPushItemsPost() POST /companies/{companyId}/connections/{connectionId}/push/items Posts a new item to the accounting package for a given company.
companiesCompanyIdDataItemsGet() GET /companies/{companyId}/data/items Gets the items for a given company.
companiesCompanyIdDataItemsItemIdGet() GET /companies/{companyId}/data/items/{itemId} Gets the specified item for a given company.

companiesCompanyIdConnectionsConnectionIdPushItemsPost()

companiesCompanyIdConnectionsConnectionIdPushItemsPost($company_id, $connection_id, $timeout_in_minutes, $codat_data_contracts_datasets_item): \TheLogicStudio\CodatPHP\Model\CodatDataContractsDatasetsItemPushOperation

Posts a new item to the accounting package for a given 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\ItemsApi(
    // 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
$connection_id = 'connection_id_example'; // string
$timeout_in_minutes = 56; // int
$codat_data_contracts_datasets_item = new \TheLogicStudio\CodatPHP\Model\CodatDataContractsDatasetsItem(); // \TheLogicStudio\CodatPHP\Model\CodatDataContractsDatasetsItem

try {
    $result = $apiInstance->companiesCompanyIdConnectionsConnectionIdPushItemsPost($company_id, $connection_id, $timeout_in_minutes, $codat_data_contracts_datasets_item);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemsApi->companiesCompanyIdConnectionsConnectionIdPushItemsPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
company_id string
connection_id string
timeout_in_minutes int [optional]
codat_data_contracts_datasets_item \TheLogicStudio\CodatPHP\Model\CodatDataContractsDatasetsItem [optional]

Return type

\TheLogicStudio\CodatPHP\Model\CodatDataContractsDatasetsItemPushOperation

Authorization

CodatLogin, APIKeyAuth

HTTP request headers

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

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

companiesCompanyIdDataItemsGet()

companiesCompanyIdDataItemsGet($company_id, $page, $page_size, $query, $order_by): \TheLogicStudio\CodatPHP\Model\CodatDataContractsDatasetsItemPagedResponseModel

Gets the items for a given 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\ItemsApi(
    // 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
$page = 1; // int
$page_size = 100; // int
$query = 'query_example'; // string
$order_by = 'order_by_example'; // string

try {
    $result = $apiInstance->companiesCompanyIdDataItemsGet($company_id, $page, $page_size, $query, $order_by);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemsApi->companiesCompanyIdDataItemsGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
company_id string
page int [default to 1]
page_size int [optional] [default to 100]
query string [optional]
order_by string [optional]

Return type

\TheLogicStudio\CodatPHP\Model\CodatDataContractsDatasetsItemPagedResponseModel

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]

companiesCompanyIdDataItemsItemIdGet()

companiesCompanyIdDataItemsItemIdGet($company_id, $item_id): \TheLogicStudio\CodatPHP\Model\CodatDataContractsDatasetsItem

Gets the specified item for a given 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\ItemsApi(
    // 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
$item_id = 'item_id_example'; // string

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

Parameters

Name Type Description Notes
company_id string
item_id string

Return type

\TheLogicStudio\CodatPHP\Model\CodatDataContractsDatasetsItem

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]