Skip to content

Latest commit

 

History

History
133 lines (98 loc) · 5.71 KB

File metadata and controls

133 lines (98 loc) · 5.71 KB

Hris.Payrolls

Overview

Available Operations

  • list - List Payroll
  • get - Get Payroll

list

List Payroll

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\HrisPayrollsAllRequest(
    serviceId: 'salesforce',
    filter: new Components\PayrollsFilter(
        startDate: '2022-04-08',
        endDate: '2022-04-21',
    ),
    passThrough: [
        'search' => 'San Francisco',
    ],
    fields: 'id,updated_at',
);

$response = $sdk->hris->payrolls->list(
    request: $request
);

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

Parameters

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

Response

?Operations\HrisPayrollsAllResponse

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 Payroll

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

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

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

$request = new Operations\HrisPayrollsOneRequest(
    payrollId: '<id>',
    serviceId: 'salesforce',
    fields: 'id,updated_at',
);

$response = $sdk->hris->payrolls->get(
    request: $request
);

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

Parameters

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

Response

?Operations\HrisPayrollsOneResponse

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 */*