Páginas filhas
  • API - Documentação Técnica - Parametrização do Lançamento Financeiro

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Expandir
titleEdição de Registro

Endpoint:  /api/rh/v1/FixedValues/1%7CNEWF%7C2001-01-01 (Este é um exemplo do End Point onde o " 1%7CNEWF%7C2001-01-01  " é variável)
Apesar de ser variável a construção do End point utiliza o seguinte padrão:
1%7CNEWF%7C2001-01-01 
/1%7C = Codigo da Coligada
NEWF%7C= Codigo do Valor Fixo
2011-01-01  = Ano / Mes / Dia
ParametrizacaoLancamentosFinanceiros/1|078


Método:
PUT
Objetivo:
Edita registros dos Valores FixosParametros do Lançamento Financeiro


Expandir
titleExemplo de Requisição

{
  "codColigada": 1,
  "codigocodLanc": "NEWF078",
  "nomedescricao": "NOVO VALOR FIXOTESTE 78 EDICAO",
  "inicioVigencialanFin": "2001-01-01"1,
  "arredTotal": false,
  "finalVigenciacodTDO": "2025-12-3101",
  "valortipoDocumento": 352"NF",
  "finalidadecodColCFO": 01,
  "nomeFinalidadecodCFO": "Sem finalidade específica.RM",
  "atualizaVigenciafornecedorGlobal": false
}

Expandir
titleExemplo de Retorno

Status Code: 200 OK
{
    "codColigada": 1,
    "codigo": "NEWF",
    "nome": "NOVO VALOR FIXO",
    "inicioVigencia": "2001-01-01",
    "finalVigencia": "2025-12-31",
    "valor": 352.0,
    "finalidade": 0,
    "nomeFinalidade": "Sem finalidade específica.",
    "atualizaVigencia": false,
  "perCalcRateio": 0,
  "usarHistoricoPadrao": false,
  "desconsiderarAutonomos": false,
  "tipoGuiaFGTSDigitalDescricao": "",
  "acrescimo": 0,
  "tipoContabil": 0,
  "codColCxa": 0,
  "caixaGlobal": true,
  "usarDataPagNoVencimento": false,
  "tipoIndividual": 0,
  "origemFornec": 0,
  "lancamentosAtivos": []

}


Expandir
titleExemplo de utilizaçãoRetorno

Status Code: 200 OK

{
    "codColigada": 1,
    "codLanc": "078",
    "descricao": "TESTE 78 EDICAO",
    "lanFin": 1,
    "arredTotal": false,
    "codTDO": "01",
    "tipoDocumento": "NF",
    "codColCFO": 1,
    "codCFO": "RM",
    "fornecedorGlobal": false,
    "perCalcRateio": 0,
    "usarHistoricoPadrao": false,
    "desconsiderarAutonomos": false,
    "tipoGuiaFGTSDigital": 0,
    "tipoGuiaFGTSDigitalDescricao": "",
    "acrescimo": 0.0,
    "tipoContabil": 0,
    "codColCxa": 0,
    "caixaGlobal": true,
    "usarDataPagNoVencimento": false,
    "tipoIndividual": 0,
    "origemFornec": 0,
    "lancamentosAtivos": []
}

Expandir
titleExemplo de utilização

Para análise rápida, importe a seguinte collection no Postman:

View file
nameParametrizacaoLancamentosFinanceiros PUT.postman_collection.json
height150


Para a utilização da collection, podemos utilizar um mock, para melhor visualização da API, basta importar o seguinte arquivo .json, usando a ferramenta Mockoon, basta importar o enviroment na ferramenta e iniciar o servidor:

View file
namemock_parametro_lanc_financ_put.json
height150


Expandir
titleExclusão de Registro

Endpoint: /api/rh/v1/ParametrizacaoLancamentosFinanceiros/1|078

Método:
DELETE
Objetivo:
Excluir registros da Parametrização do Lançamento Financeiro

Expandir
titleExemplo de Retorno

Status Code: 204 No Content

Expandir
titleExemplo de utilização

Para análise rápida, importe a seguinte collection no Postman:

View file
nameParametrizacaoLancamentosFinanceiros DEL
Para análise rápida, importe a seguinte collection no Postman:
View file
nameFixedValues PUT.postman_collection.json
height150


Para a utilização da collection, podemos utilizar um mock, para melhor visualização da API, basta importar o seguinte arquivo .json, usando a ferramenta Mockoon, basta importar o enviroment na ferramenta e iniciar o servidor:

View file
namemock_valoresparametro_lanc_fixosfinanc_putdel.json
height150

Expandir
titleExclusão de Registro
Endpoint:  /api/rh/v1/FixedValues/1%7CNEWF%7C2001-01-01(Este é um exemplo do End Point onde o " 1%7CNEWF%7C2001-01-01  " é variável)
Apesar de ser variável a construção do End point utiliza o seguinte padrão:
1%7CNEWF%7C2001-01-01 
/1%7C = Codigo da Coligada
NEWF%7C=
Codigo do Valor Fixo
2011-01-01  =
Ano / Mes / Dia
Método: DELETE
Objetivo:
Excluir registros dos Valores Fixos
Expandir
titleExemplo de Retorno

Status Code: 204 No Content