A folha do mês, etapa a etapa

GET

/folha/mes

• Produção

As seis etapas do ciclo (variáveis, calcular, aprovar/pagar, guias, eSocial, contabilidade) com estado e frase derivados no servidor, os cartões das folhas vivas, as guias da competência e o quadro ‘Precisa de você’ (holerites com erro, variáveis pendentes, guias vencendo, rescisões no prazo do art. 477). Leitura pura — nada é gravado.

Autorização
Módulo contratado: FOLHA_PAGAMENTO
Permissão: FOLHA_PROCESSAR

Authorizations

• Bearer

Parameters

Query Parameters

empresaId

required

integer format: int64

competencia

required

string

Responses

200

OK

object

empresaId

integer format: int64

empresaNome

string

competencia

string

entrada

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object

estado

string

frase

string

referenciaId

integer format: int64

calcular

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object

estado

string

frase

string

referenciaId

integer format: int64

aprovarPagar

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object

estado

string

frase

string

referenciaId

integer format: int64

guias

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object

estado

string

frase

string

referenciaId

integer format: int64

esocial

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object

estado

string

frase

string

referenciaId

integer format: int64

contabilidade

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object

estado

string

frase

string

referenciaId

integer format: int64

folhas

Array<object>

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object

id

integer format: int64

tipo

string

Allowed values: MENSAL ADIANTAMENTO DECIMO_TERCEIRO_1P DECIMO_TERCEIRO_2P FERIAS RESCISAO COMPLEMENTAR PARTICIPACAO_LUCROS

sequencia

integer format: int32

status

string

Allowed values: ABERTA EM_PROCESSAMENTO CALCULADA EM_REVISAO APROVADA PAGA FECHADA ERRO CANCELADA REABERTA

qtdColaboradores

integer format: int32

qtdColaboradoresErro

integer format: int32

totalLiquido

number

proximoGesto

string

guiasDaCompetencia

Array<object>

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object

id

integer format: int64

active

boolean

createdAt

string format: date-time

empresaId

integer format: int64

empresaNome

string

competencia

string

tipo

string

Allowed values: FGTS_MENSAL PREVIDENCIARIA IRRF_FOLHA IRRF_PLR CONTRIBUICAO_SINDICAL DAS OUTRA

tipoSigla

string

tipoDescricao

string

origem

string

Allowed values: APURADA MANUAL

descricao

string

codigoReceita

string

valorApurado

number

dataVencimento

string format: date-time

status

string

Allowed values: PENDENTE PAGA CANCELADA

dataPagamento

string format: date-time

valorPago

number

comprovanteUrl

string

comprovanteNome

string

observacoes

string

apuradoPor

string

baixadoPor

string

atrasada

boolean

diasAtraso

integer format: int32

pagamentoDivergente

boolean

pendencias

Array<object>

Objeto relacionado: aqui aparecem só os campos simples. Na escrita, basta enviar o id.

object

codigo

string

texto

string

referenciaId

integer format: int64

data

string format: date-time

variaveisPendentes

integer format: int32

variaveisAprovadas

integer format: int32

esocialFechada

boolean

lotesContabeisVivos

integer format: int32