Documentation

TerminationService extends BaseService

in package

• Application

Classe responsável por gerar a guia de rescisão e mensal de um empregado.

Tags

example

use App\Services\TerminationService;

$service = TerminationService();
$service->companyCnpj('12345678901234');
$service->customerCnpj('12345678901234');
$service->cpf('12345678901');
$service->amount(1000);
$service->generate();

Table of Contents

Properties

$api  : mixed

Este atributo mantém a instância da classe Api, que é utilizada para realizar chamadas à API externa.

$companyCnpj  : string|null

Este atributo armazena o CNPJ da empresa, informado na invocação do serviço.

$competency  : string|null

Este atributo armazena a data de competência.

$customerCnpj  : string|null

Este atributo armazena o CNPJ da cliente, informado na invocação do serviço.

$employer  : array<string|int, mixed>|null

Este atributo armazena os dados relacionados à empresa, como nome, CNPJ e entre outros.

$invoiceId  : string|null

Este atributo armazena o ID da guia.

$paymentInvoicePdfUrl  : string|null

Este atributo armazena a URL do PDF da guia de pagamento.

$uuid  : string|null

Este atributo armazena o UUID para contexto de logs.

$allowMonthly  : bool

Booleano que indica se a geração da guia mensal está permitida.

$allowTermination  : bool

Booleano que indica se a geração da guia de rescisão está permitida.

$amount  : int|null

Valor total rescisório em formato inteiro.

$cpf  : string|null

CPF do empregado.

$employee  : array<string|int, mixed>|null

Dados relacionados ao empregado, como nome, CPF e entre outros.

$employeeFinancialRecord  : array<string|int, mixed>|null

Dados financeiros do empregado.

$employeeGroupingRecord  : array<string|int, mixed>|null

Dados relacionados aos débitos, como valores, datas e entre outros.

$formattedAmount  : string|null

Valor total rescisório formatado com duas casas decimais.

$nonWorkingDays  : array<string|int, mixed>|null

Dias não úteis.

$payment  : string|null

Data de pagamento.

$severancePay  : bool|null

Este atributo armazena um booleano que indica se o mês anterior deve ser incluído no cálculo.

$shouldIncludePreviousMonth  : bool|null

Este atributo armazena um booleano que indica se deve considerar o valor do FGTS sobre as verbas rescisórias.

$tag  : string|null

Tag com valor da data de emissão ou descrição informada.

$terminationDate  : DateTime|null

Data de rescisão do empregado.

Methods

allowMonthly()  : self

Define se deve incluir débitos mensais na geração da guia de rescisão.

allowTermination()  : self

Define se deve incluir débitos de rescisão na geração da guia de rescisão.

amount()  : self

Define o valor da rescisão em centavos.

companyCnpj()  : self

Define o CNPJ da empresa.

competency()  : self

Define o mês e ano de competência para a instância da classe.

cpf()  : self

Define o CPF para a instância atual.

customerCnpj()  : self

Define o CNPJ do cliente.

formattedAmount()  : void

Formata o valor informado (em centavos) para uma string decimal com duas casas decimais, e atribui à propriedade $formattedAmount da classe.

generate()  : string

Gera a rescisão do empregado.

payment()  : self

Define a data de pagamento.

tag()  : self

Define a tag para a instância da classe.

terminationDate()  : self

Define a data de rescisão para a instância da classe.

createApiWithCnpj()  : MonthlyApi|TerminationApi

downloadInvoice()  : mixed

Faz o download de uma fatura a partir da URL informada.

getApiClass()  : string

Retorna a classe da API.

getDetailedInvoiceById()  : string|array<string|int, mixed>|null

Busca a guia de detalhamento pelo ID da guia.

getUuid()  : string

Gera um UUID aleatório no formato padrão.

returnError()  : string

sanitizeCompetency()  : string

Sanitiza a competência recebida, ajustando-a para o formato exigido pela API.

setEmployer()  : self

Define os dados do empregador.

validateRequiredFields()  : void

Valida os campos obrigatórios da rescisão.

calculatePaymentDate()  : string

Calcula a data de pagamento: terminationDate + 10 dias.

encodeAndReturnInvoices()  : string

Codifica o conteúdo dos PDFs das faturas detalhada e de pagamento em base64, e retorna uma string JSON contendo o nome, CNPJ, guia detalhada e guia de pagamento.

findEmployeeByCpf()  : array<string|int, mixed>|null

Busca um empregado pelo atributo CPF entre os empregados ativos, afastados e inativos.

hasEmployeesRemunerationHistory()  : bool

Verifica se o empregado possui histórico de remuneração, utilizado para fins rescisórios.

sanitizePayment()  : string

Sanitiza a data de pagamento recebida, ajustando-a para o formato exigido pela API.

sanitizeTag()  : string

Sanitiza e valida uma tag conforme os requisitos da API.

searchActiveDebitsByEmployee()  : bool

Busca os débitos ativos para o empregado selecionado.

searchGroupingsByEmployee()  : void

Procura o agrupamento de débitos do empregado.

setEmployee()  : self

Define os dados do empregado.

setEmployeeFinancialRecord()  : self

Define os dados do financeiro do empregado.

shouldIncludePreviousMonth()  : void

O resultado é atribuído ao atributo $shouldIncludePreviousMonth da classe.

stringToDateTime()  : DateTime

Converte uma string de data em um objeto DateTime.

validateFinancialAmountResponse()  : void

Valida o array de resposta do valor financeiro e lança uma exceção se houver mensagem de erro.

validatePaymentDate()  : void

Valida se a data de pagamento é um dia útil.