...
| Informações |
|---|
|
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.
| Informações |
|---|
| | Expandir |
|---|
| Tipo: POST | Lote |
|---|
| Campo |
|---|
Identificador | Tipo | Descrição | Obrigatório | Observação |
|---|
CodColigada | CodColigada |
|---|
| Expandir |
|---|
| | Lote |
|---|
| Campo | Tipo | Descrição | Observação |
|---|
CompanyId | Int | Código da Coligada |
|
| POST | CodLote | CodLote | | POST | - | Lista | Lista com os lotes que serão processados | | - | | Message | String | Observação, complemento, mensagem a ser enviada junto ao e-mail | Não | O 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:
| Informações |
|---|
|
| Informações |
|---|
| | Expandir |
|---|
| title | Post (Inserir um Lançamento e PartidaSolicitar Aprovação do Lote) |
|---|
| POST: Solicita a Aprovação dos Lotes enviados | Informações |
|---|
| Máscara de Url: http://{domínio}:{porta}/api/ctb/v1/lotLancApprovalbatchLancApproval/requestApproval | Informações |
|---|
| icon | false |
|---|
| title | Exemplo de Entrada |
|---|
| | Expandir |
|---|
| title | Ver resultado JSON... |
|---|
| O JSON abaixo contém os dados para solicitar a aprovação de um Lote ContábilLotes Contábeis.
| Bloco de código |
|---|
| language | js |
|---|
| theme | Emacs |
|---|
| firstline | 1 |
|---|
| title | Resultado (JSON) |
|---|
| linenumbers | true |
|---|
| {
"Message": "Teste envio de email",
"BatchList": [
{
"CodColigadaCompanyId": 1,
"CodLoteBatchId":5501
99
}
]
} |
|
|
| Informações |
|---|
| icon | false |
|---|
| title | Exemplo de Resultado Positivo |
|---|
| | Expandir |
|---|
| title | Ver resultado JSON... |
|---|
| Na resposta do resultado, são retornadas algumas informações adicionais. Destacamos especialmente o cálculo do rateio de multimoeda, realizado pelo sistema, bem como o valor percentual do rateio gerencialas informações dos Lotes que foram processados com sucesso. | Bloco de código |
|---|
| language | js |
|---|
| theme | RDark |
|---|
| firstline | 1 |
|---|
| title | Resultado (JSON) |
|---|
| linenumbers | true |
|---|
| {
"hasNext": true,
"items": [
{
"codColigada": 1,
"codLote": 5501 77,
"descricao": "Lote gerado pelo processo de Rateio - LONDON ROYAL",
"status": "Success"
}
],
"total": 1
} |
|
|
| Informações |
|---|
| icon | false |
|---|
| title | Exemplo de Resultado Negativo |
|---|
| | Expandir |
|---|
| title | Ver resultado JSON... |
|---|
| | Bloco de código |
|---|
| language | js |
|---|
| theme | FadeToGrey |
|---|
| firstline | 1 |
|---|
| title | Resultado (JSON) |
|---|
| linenumbers | true |
|---|
| {
"hasNext": true,
"items": [
{
"codColigada": 1,
"codLote": 1030,
"descricao": "Lote 1.2.01/1.2.02 do RMNucleus",
"status": "Error",
"mensagem": "O Lote 030 da Coligada 1 não pertence ao TOTVS Gestão Contábil."
}
],
"total": 1
} |
|
|
|
|
|
|
