...
| Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) | |
|---|---|---|---|---|
| acordos | Obrigatório - Por acordo | |||
| nroEmpresa | Número da empresa | integer | A API valida se a empresa existe e está ativa | |
| codTipoAcordo | Código do tipo do acordo | integer | A API valida se o tipo acordo existe | |
| seqComprador | Código do comprador | integer | A API valida se o comprador existe e está ativo | |
| seqFornecedor | Código do fornecedor | integer | A API valida se o fornecedor existe | |
| descricao | Descrição do acordo | string | Não pode conter mais de 50 caracteres | |
| referencia | Referência do acordo | string | Não pode conter mais de 50 caracteres | |
| parcelas | Obrigatório - Deve conter no mínimo uma parcela | |||
| dataVencimento | Data de vencimento da parcela | date | A data de vencimento deve ser maior que a data atual Não é permitido parcelas com a mesma data de vencimento | |
| valorParcela | Valor da parcela | number | O valor total do acordo será a somatória dos valores das parcelas O valor total do acordo não pode ser maior que R$ 99999999999,99 | |
| acordos | Opcional - Por acordo | |||
| nomeRepresentante | Nome do representante | string | Não pode conter mais de 100 caracteres | |
| doctoRepresentante | Documento do representante | string | Não pode conter mais de 20 caracteres | |
| cpfRepresentante | CPF do representante | string | A API valida se o CPF é válido | |
| cargoRepresentante | Cargo do representante | string | Não pode conter mais de 40 caracteres | |
| nroFormaPagamento | Número da forma de pagamento | integer | A API valida se a forma de pagamento existe | |
| observacao | Observação do acordo | string | Não pode conter mais de 4000 caracteres |
...
Code 200
Response Body
{
"mensagem": "Acordos inseridos com sucesso",
"mensagemDetalhada": "Alguns acordos não foram gerados. Verifique o Log para mais detalhes",
"totalAcordosGenerados": 1,
"totalAcordosNaoGenerados": 1,
"seqLoteProcesso": 1
}
Code 400 - Error
Response Body
[
{
"guid": "Código de guia",
"code": "400",
"message": "Erro ao inserir os acordos promocionais",
"detailedMessage": "Não é permitido inserir mais de 500 acordos."
}
]
| Código (Code) | Nome (Name) | Descrição (Description) | Tipo (Type) |
|---|---|---|---|
| 200 | Sucesso (Seccess) | ||
| mensagem | Mensagem de retorno | string | |
| mensagemDetalhada | Detalhe da mensagem | string | |
| totalAcordosGenerados | Número total de acordos gerados | integer | |
| totalAcordosNaoGenerados | Número total de acordos não gerados | integer | |
| seqLoteProcesso | Código do Lote do Processo | integer | |
| 400 | Erro (Error) | ||
| guid | Código de guia | string | |
| code | Código de retorno | string | |
| message | Mensagem de retorno | string | |
| detailedMessage | Detalhe da mensagem | string |
...