Linha RM

Atalhos

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

Foi criada a API para uso dos produtos TOTVS Folha de Pagamento, que será utilizada na nova tela "Tarifas de Vale Transporte", desenvolvida em Smart UI. Esta tela oferece novos recursos visuais e funcionais do Tarifas de Vale Transporte, que já conhecíamos anteriormente.
Este documento contém detalhes técnicos sobre os parâmetros, os retornos de cada um e a funcionalidade da API.


Informações Técnicas das API's utilizadas 

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

{
    "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": []
}

Endpoint:  /api/rh/v1/TarifaTransporte/
Método: POST
Objetivo: Incluir registros na Tarifa de Vale Transporte

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


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
}

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

TarifaTransporte API.postman_collection.json

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:

mock_tarifas_vale_transporte_post.json




Endpoint:  /api/rh/v1/TarifaTransporte/1%7C123%7C2011-01-01 (Este é um exemplo do End Point onde o " 1%7C123%7C2011-01-01 " é variável)

Apesar de ser variável a construção do End point utiliza o seguinte padrão:

1%7C123%7C2011-01-01
/1%7C = Codigo da Coligada
123%7C = Codigo da Tarifa
2011-01-01  = Ano / Mes / Dia


Método: PUT
Objetivo: Edita registros da Tarifa de Transporte


 {
  "codColigada": 1,
  "codigo": "123",
  "inicioVigencia": "2011-01-01",
  "finalVigencia": "2025-12-31",
  "descricao": "teste update",
  "valor": 200,
  "atualizaVigencia": false,
  "id": 310,
  "links": [
    {
      "relation": "Vales",
      "apiMetaData": "api/rh/v1/LinhaValeTransporte/schema",
      "apiData": "api/rh/v1/LinhaValeTransporte/",
      "apiDataFilter": "?$filter=codColigada eq 1 and codTarifa eq '123'",
      "type": "RelatedItems",
      "label": "Vale Transporte",
      "mapper": {
        "codTarifa": "123"
      }
    }
  ]
}


Status Code: 200 OK

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

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

TarifaTransporte Update.postman_collection.json

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:
mock_tarifas_vale_transporte_put.json


Endpoint:  /api/rh/v1/TarifaTransporte/1%7C123%7C2011-01-01 (Este é um exemplo do End Point onde o " 1%7C123%7C2011-01-01 " é variável)

Apesar de ser variável a construção do End point utiliza o seguinte padrão:

1%7C123%7C2011-01-01
/1%7C = Codigo da Coligada
123%7C = Codigo da Tarifa
2011-01-01  = Ano / Mes / Dia


Método: DELETE
Objetivo: Excluir registros da Tarifa de Transporte

Status Code: 204 No Content

  • Sem rótulos