Este método é responsável pela criação de motivos
- Endpoint: /api/retaguarda/v2/motivos
- Método: Post
- Autenticação: Bearer token
- Permissão: Retaguarda
Este endpoint recebe uma lista de motivos para que possam ser enviados vários na mesma requisição
Expandir |
---|
title | Exemplo de body da requisição |
---|
|
[ { "descricao": "string", "tipo": 0, "situacao": 0, "idInquilino": "string", "idRetaguarda": "string", "idProprietario": "string", "loteOrigem": "string" } ] |
Expandir |
---|
title | Definição dos campos de requisição |
---|
|
Campo | Tipo | Descrição | Observações |
---|
descricao | string | Descrição do motivo | Obrigatório Tamanho máximo: 100 caracteres | tipo | int | Tipo do motivo | Obrigatório Descrição dos tipos abaixo | situacao | int | Stituação do motivo (0 - Inativo; 1 - Ativo) | Se não enviado será cadastrado como 0 | idInquilino | string | Identificador do inquilino | Obrigatório | idRetaguarda | string | Identificador do motivo na retaguarda | Obrigatório | idProprietario | string | Identificador do proprietário do dado | Obrigatório | loteOrigem | string | Identificador do lote | Obrigatório para a integração |
|
Expandir |
---|
|
Código | Tipo |
---|
0 | AcrescimoDesconto | 1 | TrocaDevolucao | 5 | CancelamentoVenda | 6 | Sangria | 7 | Suprimento |
|
Expandir |
---|
title | Retorno da requisição |
---|
|
Expandir |
---|
| { "success": true, "message": "Requisição inserida com sucesso!", "data": null, "errors": null, "totalTime": 0, "numberOfRecords": 0 } |
Expandir |
---|
| { "code": "string", "message": "string", "detailedMessage": "string", "helpUrl": "string", "details": [ { "guid": "string", "code": "string", "message": "string", "detailedMessage": "string" } ] } |
|
Expandir |
---|
title | Definição dos campos de retorno |
---|
|
Expandir |
---|
| Campo | Tipo | Descrição |
---|
Success | bool | Indica se a criação do compartilhamento foi feita com sucesso | Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | Data | objeto | Objeto compartilhamento criado | Errors | Lista | Listas com os erros encontrados no processo | TotalTime | int | tempo da requisição | NumberOfRecords | int | número de dados inseridos |
|
Expandir |
---|
| Campo | Tipo | Descrição |
---|
code | string | Código de erro | message | string | Mensagem do erro | detailedMessage | string | Detalhamento do erro | helpUrl | string | url de ajuda | TotalTime | string | Tempo total de busca | details | lista de objeto | Lista de objeto de erros | details.guid | string | Identificador do erro | details.code | string | Código do erro | details.message | string | Mensagem do erro | details.detailedMessage | string | Detalhamento do erro |
|
|