Este método é responsável pela criação de um novo Ramo de Atividade


Pendente PDV

Este método é responsável pela criação de um novo Ramo de Atividade

  • Endpoint: /api/retaguarda/v3/dadosdinamicos/down/58/{versaoJson}
  • Método: Post
  • Autenticação: Bearer token
  • Permissão: Retaguarda

Este endpoint recebe uma lista de ramos de atividade para que possam ser enviados vários na mesma requisição

Para que a baixa do Ramo Atividade criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 58 = Ramo Atividade

Observação: no parâmetro {versaoJson} enviar o número 1, que refere-se a primeira versão do Json que está detalhado abaixo.

Requisição

Exemplo de body da requisição

[
  {    
    "Situacao": 1,
    "IdInquilino": "string",
    "IdRetaguarda": "string",
    "DataAtualizacao": "2024-09-11T20:48:33.609Z",
    "DataCadastro": "2024-09-11T20:48:33.609Z",
    "IdProprietario": "string",
    "LoteOrigem": "string",
    "Descricao": "string",
    "PercentualTaxa":0.0,
    "IdRetaguardaAtividadePrincipal": "string"
  }
]


Definições dos campos do body

Campo

Tipo

Descrição

Obrigatório

Observações

SituacaointSituação cadastralNão

0 - Inativo, 1 - Ativo 

Caso não enviado será cadastrado com 0 

IdInquilinostringIdentificador do inquilinoSim
IdRetaguardastringIdentificador do perfil na retaguarda SimTamanho máximo de 100 caracteres
DataAtualizacaoDatetimeData de AtualizaçãoNão
DataCadastroDatetimeData de CadastroNão
IdProprietariostringIdentificador do proprietárioSim
LoteOrigemstringLote vinculado ao dadoSim
DescricaostringDescrição do Ramo AtividadeNãoTamanho máximo de 40 caracteres
PercentualTaxadecimalPercentual de TaxaSim
IdRetaguardaAtividadePrincipalstringIdentificador do Ramo Atividade PrincipalNão

Retorno

Exemplo de body de retorno

{
    "success": true,
    "message": "Requisição inserida com sucesso!",
    "data": null,
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Definições dos campos do retorno

Campo

Tipo

Descrição

SuccessboolIndica se a criação do ramo atividade foi feita com sucesso
MessagestringCaso ocorra erros durante a criação do ramo atividade eles serão enviados nesse campo
DataobjetoObjeto ramo atividade criado
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo da requisição
NumberOfRecordsintnúmero de dados inseridos

Exemplo de body de retorno

{
    "code": "string",
    "message": "string",
    "detailedMessage": "string",
    "helpUrl": "string",
    "details": [
        {
            "guid": "string",
            "code": "string",
            "message": "string",
            "detailedMessage": "string"
        }
    ]
}

Definições dos campos do retorno

Campo

Tipo

Descrição

codestringCódigo de erro
messagestringMensagem do erro
detailedMessagestringDetalhamento do erro
helpUrlstringurl de ajuda
TotalTimestringTempo total de busca
detailslista de objetoLista de objeto de erros
details.guidstringIdentificador do erro
details.codestringCódigo do erro
details.messagestringMensagem do erro 
details.detailedMessagestringDetalhamento do erro