Documentation

TerminationApi extends BaseApi
in package

Application

Classe responsável por fazer requisições para a API de Rescisão.

Herda os métodos da classe BaseApi.

Constants

MONTHLY_SERVICE_DEV_MODE = false: Constante utilizada para forçar a geração de carrinho e guias com o propósito de teste.
TERMINATION_SERVICE_DEV_MODE = false: Constante utilizada para forçar a geração de carrinho e guias com o propósito de teste.

Methods

__construct() : mixed
clearDebitCart() : array<string|int, mixed>|string: Limpa o carrinho de débitos existente.
createEmployeeDebitCart() : array<string|int, mixed>|string: Cria um carrinho com os débitos do empregado informado no parâmetro employee.
createFinancialRecord() : array<string|int, mixed>|string: Envia uma requisição PUT para atualizar um registro financeiro de um empregado.
downloadFile() : mixed: Faz o download de qualquer arquivo (não da API, mas necessário para baixar PDFs).
generateInvoice() : array<string|int, mixed>|string: Generates the payment invoice with the provided data.
getActiveEmployees() : array<string|int, mixed>: Recupera uma lista de vínculos empregatícios afastados.
getAllEmployees() : array<string|int, mixed>: Recupera todos os vínculos empregatícios (ativos, afastados e desligados).
getAwayEmployees() : array<string|int, mixed>: Recupera uma lista de vínculos empregatícios afastados.
getDetailedInvoiceFile() : array<string|int, mixed>|string: Returns the binary file of the detailed payment invoice.
getEmployeeActiveDebits() : array<string|int, mixed>|string: Busca os débitos ativos de um empregado, utilizando os parâmetros employee (array) e competência.
getEmployeeFinancialRecord() : array<string|int, mixed>|string: Recupera o registro financeiro para um determinado ID de empregado.
getEmployeesRemunerationHistory() : array<string|int, mixed>|string: Recupera uma lista de empregados e seus respectivos históricos de remunerações.
getEmployer() : string|array<string|int, mixed>
getGroupings() : array<string|int, mixed>|string: Retrieves groupings, basically fetches the existing cart.
getInactiveEmployees() : array<string|int, mixed>: Recupera uma lista de vínculos empregatícios inativos (desligados).
getInvoiceDetail() : array<string|int, mixed>|string: Consulta os débitos de uma guia específica.
getPendingPaymentInvoices() : array<string|int, mixed>|string: Lista as guias de pagamento existentes com status "Aguardando Pagamento".
getReviewDebits() : array<string|int, mixed>: Lists the review debits, used to validate if the payment date is allowed by the API.
makeRequest() : array<string|int, mixed>|string: Makes an HTTP request using the specified method, URI, and options.
setCnpj() : self: Define o CNPJ para contexto de logs
setUuid() : self: Define o UUID para contexto de logs

MONTHLY_SERVICE_DEV_MODE

Constante utilizada para forçar a geração de carrinho e guias com o propósito de teste.


    public
        bool
    MONTHLY_SERVICE_DEV_MODE
    = false

Caso já existam guias emitidas, é necessário aguardar o vencimento para emitir uma nova. Então para evitar ter que aguardar, podemos colocar como true. Colocar como false, significa que ele vai incluir apenas débitos sem guias.

Padrão é false

TERMINATION_SERVICE_DEV_MODE

Constante utilizada para forçar a geração de carrinho e guias com o propósito de teste.


    public
        bool
    TERMINATION_SERVICE_DEV_MODE
    = false

Padrão é false

__construct()


    public
                    __construct(Client $client) : mixed

Parameters

$client : Client

clearDebitCart()

Limpa o carrinho de débitos existente.


    public
                    clearDebitCart() : array<string|int, mixed>|string

Return values

array<string|int, mixed>|string —

Retorna a resposta da API como um array ou string. Se ocorrer uma exceção, retorna um array com as chaves 'error', 'code' e 'message'.

createEmployeeDebitCart()

Cria um carrinho com os débitos do empregado informado no parâmetro employee.


    public
                    createEmployeeDebitCart(mixed $employee, mixed $competencyStartDate, mixed $competencyEndDate, bool $allowMonthly, bool $allowTermination) : array<string|int, mixed>|string

Parameters

$employee : mixed
$competencyStartDate : mixed
$competencyEndDate : mixed
$allowMonthly : bool
$allowTermination : bool

Return values

array<string|int, mixed>|string —

Retorna a resposta da API como um array ou string. Em caso de exceção, retorna um array com as chaves 'error', 'code' e 'message'.

createFinancialRecord()

Envia uma requisição PUT para atualizar um registro financeiro de um empregado.


    public
                    createFinancialRecord(array<string|int, mixed> $employee, float|int $amount, bool|null $shouldIncludePreviousMonth, bool $severancePay) : array<string|int, mixed>|string

Parameters

$employee : array<string|int, mixed>

Array associativo contendo dados do empregado, incluindo:

'idVinculoEmpregado': ID do vínculo do empregado.
'sqVinculoEmpregado': Sequência do vínculo do empregado.
'versaoFichaAtual': Array com 'numeroVersaoFicha' (número da versão atual do registro).

$amount : float|int

Valor base para fins de FGTS.

$shouldIncludePreviousMonth : bool|null

$severancePay : bool

Indica se deve considerar o valor do FGTS sobre as verbas rescisórias.

Return values

array<string|int, mixed>|string —

Retorna a resposta da API como array ou string. Em caso de exceção, retorna um array com as chaves 'error', 'code' e 'message'.

downloadFile()

Faz o download de qualquer arquivo (não da API, mas necessário para baixar PDFs).


    public
                    downloadFile(string $endpoint) : mixed

Parameters

$endpoint : string: O endpoint ou URL de onde baixar o arquivo.

Return values

mixed —

A resposta do método makeRequest, ou um array com detalhes do erro em caso de falha.

generateInvoice()

Generates the payment invoice with the provided data.


    public
                    generateInvoice(string $paymentDate, string $uuid, string $tag, string $hash) : array<string|int, mixed>|string

Uses a retry loop because the API may take time to generate the invoice, avoiding empty responses.

Parameters

$paymentDate : string: The payment date.
$uuid : string: The UUID for the request.
$tag : string: The tag parameter.
$hash : string: The hash parameter.

Return values

array<string|int, mixed>|string —

The API response or error details.

getActiveEmployees()

Recupera uma lista de vínculos empregatícios afastados.


    public
                    getActiveEmployees([string|null $cpf = null ]) : array<string|int, mixed>

Este método retorna um array contendo os vínculos empregatícios afastados, podendo ser filtrado por CPF do trabalhador.

Parameters

$cpf : string|null = null: CPF do empregado (opcional).

Return values

array<string|int, mixed> —

Lista de empregados ativos ou empregado filtrado por CPF.

getAllEmployees()

Recupera todos os vínculos empregatícios (ativos, afastados e desligados).


    public
                    getAllEmployees([string|null $cpf = null ]) : array<string|int, mixed>

Este método retorna um array contendo todos os vínculos empregatícios, podendo ser filtrado pelo CPF do trabalhador.

Parameters

$cpf : string|null = null: CPF do trabalhador para filtrar os vínculos (opcional).

Return values

array<string|int, mixed> —

Lista de vínculos empregatícios.

getAwayEmployees()

Recupera uma lista de vínculos empregatícios afastados.


    public
                    getAwayEmployees([string|null $cpf = null ]) : array<string|int, mixed>

Este método retorna um array contendo os vínculos empregatícios afastados, podendo ser filtrado por CPF do trabalhador.

Parameters

$cpf : string|null = null: CPF do trabalhador para filtrar os vínculos afastados (opcional).

Return values

array<string|int, mixed> —

Lista de vínculos empregatícios afastados.

getDetailedInvoiceFile()

Returns the binary file of the detailed payment invoice.


    public
                    getDetailedInvoiceFile(mixed $invoiceId, mixed $uuid) : array<string|int, mixed>|string

Retries the request in a loop, as the API may have a delay in generating the detailed invoice.

Parameters

$invoiceId : mixed: The ID of the invoice to reprint.
$uuid : mixed: The UUID associated with the request.

Return values

array<string|int, mixed>|string —

The binary file or an array with error details.

getEmployeeActiveDebits()

Busca os débitos ativos de um empregado, utilizando os parâmetros employee (array) e competência.


    public
                    getEmployeeActiveDebits(array<string|int, mixed> $employee, mixed $competencyStartDate, mixed $competencyEndDate, bool $allowMonthly, bool $allowTermination) : array<string|int, mixed>|string

O parâmetro $employee deve ser um array contendo os dados do empregado, normalmente obtido como atributo da classe de serviço. O método utiliza o CPF presente em $employee['nrCpfTrabalhador'] e a competência informada para buscar os débitos ativos.

Parameters

$employee : array<string|int, mixed>: Array com os dados do empregado, incluindo o CPF.
$competencyStartDate : mixed
$competencyEndDate : mixed
$allowMonthly : bool
$allowTermination : bool

Return values

array<string|int, mixed>|string —

Retorna um array com os débitos ativos encontrados ou lança uma exceção da API em caso de erro.

getEmployeeFinancialRecord()

Recupera o registro financeiro para um determinado ID de empregado.


    public
                    getEmployeeFinancialRecord(mixed $employeeId) : array<string|int, mixed>|string

Envia uma requisição GET para o endpoint /historico/api/fichafinanceira/{id} para buscar o registro financeiro associado ao ID do empregado fornecido.

Parameters

$employeeId : mixed

Return values

array<string|int, mixed>|string —

Retorna os dados do registro financeiro como array ou string em caso de sucesso, ou um array contendo informações de erro em caso de falha.

getEmployeesRemunerationHistory()

Recupera uma lista de empregados e seus respectivos históricos de remunerações.


    public
                    getEmployeesRemunerationHistory([string|null $cpf = null ]) : array<string|int, mixed>|string

Se o parâmetro $cpf for informado, retorna apenas o empregado correspondente ao CPF. Caso contrário, retorna a lista de todos os empregados e seus históricos.

Parameters

$cpf : string|null = null: CPF do empregado (opcional).

Return values

array<string|int, mixed>|string —

Lista de empregados com históricos de remunerações ou mensagem de erro.

getEmployer()


    public
                    getEmployer() : string|array<string|int, mixed>

Return values

string|array<string|int, mixed>

getGroupings()

Retrieves groupings, basically fetches the existing cart.


    public
                    getGroupings(string $paymentDate) : array<string|int, mixed>|string

Parameters

$paymentDate : string: The payment date.

Return values

array<string|int, mixed>|string —

Returns the API response as an array or string. If an exception occurs, returns an array with 'error', 'code', and 'message' keys.

getInactiveEmployees()

Recupera uma lista de vínculos empregatícios inativos (desligados).


    public
                    getInactiveEmployees([string|null $cpf = null ]) : array<string|int, mixed>

Este método retorna um array contendo os vínculos empregatícios desligados, podendo ser filtrado pelo CPF do trabalhador.

Parameters

$cpf : string|null = null: CPF do trabalhador para filtrar os vínculos desligados (opcional).

Return values

array<string|int, mixed> —

Lista de vínculos empregatícios desligados.

getInvoiceDetail()

Consulta os débitos de uma guia específica.


    public
                    getInvoiceDetail(string $invoiceId) : array<string|int, mixed>|string

Parameters

$invoiceId : string

Return values

array<string|int, mixed>|string —

Retorna o array de débitos ou detalhes do erro.

getPendingPaymentInvoices()

Lista as guias de pagamento existentes com status "Aguardando Pagamento".


    public
                    getPendingPaymentInvoices(string $competency, string $paymentDate) : array<string|int, mixed>|string

Parameters

$competency : string: Período de competência.
$paymentDate : string: Data de vencimento do pagamento.

Return values

array<string|int, mixed>|string —

Retorna a resposta da API como um array ou string. Se ocorrer uma exceção, retorna um array com as chaves 'error', 'code' e 'message'.

getReviewDebits()

Lists the review debits, used to validate if the payment date is allowed by the API.


    public
                    getReviewDebits(string $uuid) : array<string|int, mixed>

Parameters

$uuid : string: The UUID for the request.

Return values

array<string|int, mixed> —

Returns the API response as an array.

makeRequest()

Makes an HTTP request using the specified method, URI, and options.


    public
                    makeRequest(string $method, string $uri[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>|string

Handles retries for connection exceptions, decodes JSON responses, and throws custom exceptions for errors.

Parameters

$method : string: The HTTP method to use (e.g., 'GET', 'POST').
$uri : string: The URI to request.
$options : array<string|int, mixed> = []: Optional request options to pass to the HTTP client.

Return values

array<string|int, mixed>|string —

Returns the decoded JSON response as an array, or the raw response body as a string for non-JSON content.

setCnpj()

Define o CNPJ para contexto de logs


    public
                    setCnpj(string $cnpj) : self

Parameters

$cnpj : string

Return values

self

setUuid()

Define o UUID para contexto de logs


    public
                    setUuid(string $uuid) : self

Parameters

$uuid : string

Return values

self

TerminationApi extends BaseApi in package Application

Table of Contents

Constants

Methods

Constants

MONTHLY_SERVICE_DEV_MODE

TERMINATION_SERVICE_DEV_MODE

Methods

__construct()

Parameters

clearDebitCart()

Return values

createEmployeeDebitCart()

Parameters

Return values

createFinancialRecord()

Parameters

Return values

downloadFile()

Parameters

Return values

generateInvoice()

Parameters

Return values

getActiveEmployees()

Parameters

Return values

getAllEmployees()

Parameters

Return values

getAwayEmployees()

Parameters

Return values

getDetailedInvoiceFile()

Parameters

Return values

getEmployeeActiveDebits()

Parameters

Tags

Return values

getEmployeeFinancialRecord()

Parameters

Return values

getEmployeesRemunerationHistory()

Parameters

Return values

getEmployer()

Return values

getGroupings()

Parameters

Return values

getInactiveEmployees()

Parameters

Return values

getInvoiceDetail()

Parameters

Return values

getPendingPaymentInvoices()

Parameters

Return values

getReviewDebits()

Parameters

Return values

makeRequest()

Parameters

Tags

Return values

setCnpj()

Parameters

Return values

setUuid()

Parameters

Return values

TerminationApi extends BaseApi
in package

Application