Linha RM

Atalhos

Páginas filhas
  • API do Processo de Solicitação de Aprovação

Sumário

Objetivo

      Esse documento tem o objetivo de exemplificar o uso da API de Solicitação de Aprovação de Lotes utilizando todos os métodos implementados.

Importante

Recurso disponível a partir da release 12.1.2406.

1 - Campos e Parâmetros

      Descrição detalhada dos campos da API de Solicitação de Aprovação de Lotes.

As tabelas abaixo são divididas da seguinte maneira:

  • Campo: Identificação do campo no Json.
  • Identificador: Identificação do campo no banco de dados RM correspondente ao campo Json.
  • Tipo: Tipo de valor aceito no campo, podendo ser numérico (Int, Decimal), condicionais (Boolean), texto (String, Datetime), além do tipo List, para esse último, é esperado uma nova sequência de dados (Bloco interno).
  • Descrição: Fornece uma descrição do campo.
  • Obrigatório: Especifica se a informação é obrigatória durante operações de envio (POST, PUT, PATCH). Caso a informação seja obrigatória condicionalmente essa informação será descrita no campo Observação.
  • Observação: Informações condicionais ou importantes para o funcionamento da API serão apresentadas nesse campo.

Tipo: POST

Lote
CampoTipoDescriçãoObrigatórioObservação
Lote
CampoTipoDescriçãoObservação

CompanyId

IntCódigo da Coligada-
BatchIdIntCódigo do Lote-
ListaLista com os lotes que serão processados

Sim

-
MessageStringObservação, complemento, mensagem a ser enviada junto ao e-mailNãoO campo é opcional, sendo utilizado no corpo do email.

2 - Métodos

      Métodos disponíveis na API de Solicitação de Aprovação de Lotes:

POST: Solicita a Aprovação dos Lotes enviados

Post

Máscara de Url: http://{domínio}:{porta}/api/ctb/v1/batchLancApproval/requestApproval

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/ctb/v1/batchLancApproval/requestApproval

Exemplo de Entrada

O JSON abaixo contém os dados para solicitar a aprovação de Lotes Contábeis.

Resultado (JSON)
   {
      "Message": "Teste envio de email", 
      "BatchList": [
        {
          "CompanyId": 1,
          "BatchId": 99
        }
      ]
   }

Exemplo de Resultado Positivo

Na resposta do resultado, são retornadas as informações dos Lotes que foram processados com sucesso.

Resultado (JSON)
{
    "hasNext": true,
    "items": [
        {
            "codColigada": 1,
            "codLote": 77,
            "descricao": "Lote gerado pelo processo de Rateio - LONDON ROYAL",
            "status": "Success"
        }
    ],
    "total": 1
}

Exemplo de Resultado Negativo

Resultado (JSON)
{
    "hasNext": true,
    "items": [
        {
            "codColigada": 1,
            "codLote": 30,
            "descricao": "Lote 1.2.01/1.2.02 do RMNucleus",
            "status": "Error",
            "mensagem": "O Lote 30 da Coligada 1 não pertence ao TOTVS Gestão Contábil."
        }
    ],
    "total": 1
}
  • Sem rótulos