Skip to content

README.md

Latest commit

 

History

History
138 lines (102 loc) · 6.37 KB

README.md

File metadata and controls

138 lines (102 loc) · 6.37 KB
Raw

Accounting.Categories

Overview

Available Operations

  • list - List Categories
  • get - Get Category

list

List Categories

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Apideck\Unify;
use Apideck\Unify\Models\Components;
use Apideck\Unify\Models\Operations;

$sdk = Unify\Apideck::builder()
    ->setConsumerId('test-consumer')
    ->setAppId('dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX')
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$request = new Operations\AccountingCategoriesAllRequest(
    serviceId: 'salesforce',
    companyId: '12345',
    fields: 'id,updated_at',
    filter: new Components\CategoriesFilter(
        type: Components\CategoriesFilterType::Expense,
    ),
);

$responses = $sdk->accounting->categories->list(
    request: $request
);


foreach ($responses as $response) {
    if ($response->httpMeta->response->getStatusCode() === 200) {
        // handle response
    }
}

Parameters

Parameter Type Required Description
$request Operations\AccountingCategoriesAllRequest ✔️ The request object to use for the request.

Response

?Operations\AccountingCategoriesAllResponse

Errors

Error Type Status Code Content Type
Errors\BadRequestResponse 400 application/json
Errors\UnauthorizedResponse 401 application/json
Errors\PaymentRequiredResponse 402 application/json
Errors\NotFoundResponse 404 application/json
Errors\UnprocessableResponse 422 application/json
Errors\APIException 4XX, 5XX */*

get

Get Category

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Apideck\Unify;
use Apideck\Unify\Models\Components;
use Apideck\Unify\Models\Operations;

$sdk = Unify\Apideck::builder()
    ->setConsumerId('test-consumer')
    ->setAppId('dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX')
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$request = new Operations\AccountingCategoriesOneRequest(
    id: '<id>',
    serviceId: 'salesforce',
    companyId: '12345',
    fields: 'id,updated_at',
    filter: new Components\CategoriesFilter(
        type: Components\CategoriesFilterType::Expense,
    ),
);

$response = $sdk->accounting->categories->get(
    request: $request
);

if ($response->getCategoryResponse !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Operations\AccountingCategoriesOneRequest ✔️ The request object to use for the request.

Response

?Operations\AccountingCategoriesOneResponse

Errors

Error Type Status Code Content Type
Errors\BadRequestResponse 400 application/json
Errors\UnauthorizedResponse 401 application/json
Errors\PaymentRequiredResponse 402 application/json
Errors\NotFoundResponse 404 application/json
Errors\UnprocessableResponse 422 application/json
Errors\APIException 4XX, 5XX */*