Linha RM

Atalhos

Páginas filhas
  • API - Documentação Técnica - Tarifas de Vale Transporte

Versões comparadas

Versão antiga 1

changes.mady.by.user Rafael Silva Souza

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Andre Misson Garcia

Gravado em

Chave

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

Foi criada a API para uso dos produtos de TOTVS Folha de Pagamento das linhas RM, Datasul e Protheus, que será utilizada na nova tela "Consulta Movimento Tarifas de IntegraçãoVale Transporte", desenvolvida em Smart UI. Esta tela oferece novos recursos visuais e funcionais do Consulta Movimento de Integração Tarifas de Vale Transporte, que já conhecíamos anteriormente.
Este módulo contém dados relativos às integrações que foram processadas pelo sistema
Este documento contém detalhes técnicos sobre os parâmetros, os retornos de cada um e a funcionalidade da API.

...

Expandir
titleSchema

Endpoint:  /api/rh/v1/TarifaTransporte/Schema
Método: GET
Objetivo: Retornar o Schema utilizado neste endpoint, com propriedades e tipos de dados

Expandir
titleExemplo de Retorno

{
    "title": "Tarifa Transporte",
    "version": "1.0",
    "identifier": "TarifaTransporte",
    "fields": [
        {
            "key": true,
            "property": "codColigada",
            "label": "Coligada",
            "visible": false,
            "type": "string",
            "componentType": "Input"
        },
        {
            "quickFilter": true,
            "required": true,
            "mask": "99999",
            "maskFormatModel": true,
            "maxLength": 5,
            "layoutDefinition": [
                {
                    "gridColumns": 3,
                    "componentType": "EditLayout"
                }
            ],
            "key": true,
            "property": "codigo",
            "label": "Código",
            "type": "string",
            "componentType": "Input"
        },
        {
            "required": true,
            "format": "dd/MM/yyyy",
            "layoutDefinition": [
                {
                    "gridColumns": 2,
                    "componentType": "EditLayout"
                }
            ],
            "key": true,
            "property": "inicioVigencia",
            "label": "Início vigência",
            "type": "date",
            "componentType": "DatePicker"
        },
        {
            "required": true,
            "format": "dd/MM/yyyy",
            "layoutDefinition": [
                {
                    "gridColumns": 2,
                    "componentType": "EditLayout"
                }
            ],
            "property": "finalVigencia",
            "label": "Final vigência",
            "type": "date",
            "componentType": "DatePicker"
        },
        {
            "required": true,
            "maxLength": 30,
            "layoutDefinition": [
                {
                    "gridColumns": 5,
                    "componentType": "EditLayout"
                }
            ],
            "property": "descricao",
            "label": "Descrição",
            "type": "string",
            "componentType": "Input"
        },
        {
            "required": true,
            "decimalsLength": 2,
            "thousandMaxlength": 11,
            "layoutDefinition": [
                {
                    "gridColumns": 3,
                    "componentType": "EditLayout"
                }
            ],
            "property": "valor",
            "label": "Valor",
            "type": "currency",
            "componentType": "Decimal"
        },
        {
            "booleanTrue": "Sim",
            "booleanFalse": "Não",
            "layoutDefinition": [
                {
                    "gridColumns": 9,
                    "componentType": "EditLayout"
                }
            ],
            "property": "atualizaVigencia",
            "label": "Atualiza final de vigência na liberação de competência",
            "type": "boolean",
            "componentType": "Switch"
        }
    ],
    "groups": []
}

/api/rh/v1/TarifaTransporte/

Expandir
titleInclusão de Registro

Endpoint:  /api/rh/v1/TarifaTransporte/
Método: POST
Objetivo: Excluir Incluir registros da Consulta de Movimento de Integraçãona Tarifa de Vale Transporte

Expandir
titleExemplo de Requisição

{
  "codigo": "123",
  "inicioVigencia": "2011-01-01",
  "finalVigencia": "2025-12-31",
  "descricao": "teste",
  "valor": 200
}


Expandir
titleExemplo de Retorno

Status Code: 201 Created

{
    "codColigada": 1,
    "codigo": "123",
    "inicioVigencia": "2011-01-01",
    "finalVigencia": "2025-12-31",
    "descricao": "teste",
    "valor": 200.0,
    "atualizaVigencia": false,
    "id": 0
}

Expandir
titleExemplo de utilização

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

View file
nameTarifaTransporte API.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_tarifas_vale_transporte_post.json
height150





...