Encerrar CIOT TAC Agregado
Método responsável por realizar o Encerramento de contratos de CIOT do tipo TAC AGREGADO. Este comando deverá ser enviado quando a quitação do agregado for finalizada ou houver necessidade de encerramento do contrato.
Request
- ENDPOINT: ContratoAgregado/Encerrar
- VERBO: PUT
| Índice | Chave | Descrição | Elem. | Tipo | Ocor. | Tam. | Versão |
|---|---|---|---|---|---|---|---|
| 1 | CNPJAplicacao | CNPJ para autenticação | E | Caractere | 1-1 | 14 | 1.0 |
| 2 | Token | Gerado a partir do CNPJ de autenticação para validar permissões | E | Caractere | 1-1 | 100 | 1.0 |
| 3 | DocumentoUsuarioAudit | Documento do usuário que está realizando a operação | E | Caractere | 1-1 | 14 | 1.0 |
| 4 | NomeUsuarioAudit | Nome do usuário que está realizando a operação | E | Caractere | 1-1 | 60 | 1.0 |
| 5 | CNPJEmpresa | CNPJ para autenticação | E | Caractere | 1-1 | 14 | 1.0 |
| 6 | CIOT | Número do CIOT do tipo TAC AGREGADO que deseja encerrar | A | Caractere | 1-1 | 12 | 1.0 |
Modelo de Json - Request
{
"Token": "",
"CNPJAplicacao": "",
"DocumentoUsuarioAudit": "",
"NomeUsuarioAudit": "",
"CNPJEmpresa": "",
"CIOT": ""
}
Response
| Índice | Chave | Descrição | Elem. | Tipo | Ocor. | Tam. | Versão |
|---|---|---|---|---|---|---|---|
| 1 | Sucesso | True: Caso não tenha acontecido nenhuma exceção ou validação no processo mesmo não trazendo dados no retorno False: Quaisquer validações ou exceção não tratada pelo sistema que impediu o processo de ser concluído |
E | Booleano | 1-1 | True/False | 1.0 |
| 2 | Mensagem | Mensagem com as validações e exceções | E | Caractere | 0-1 | 100 | 1.0 |
Modelo de Json - Response
{
"Sucesso": false,
"Mensagem": ""
}