TOTVS Varejo PDV Omni

Árvore de páginas

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
    Situacao int Situação cadastral Não

    0 - Inativo, 1 - Ativo 

    Caso não enviado será cadastrado com 0 
    IdInquilino string Identificador do inquilino Sim
    IdRetaguarda string Identificador do perfil na retaguarda  Sim Tamanho máximo de 100 caracteres
    DataAtualizacao Datetime Data de Atualização Não
    DataCadastro Datetime Data de Cadastro Não
    IdProprietario string Identificador do proprietário Sim
    LoteOrigem string Lote vinculado ao dado Sim
    Descricao string Descrição do Ramo Atividade Não Tamanho máximo de 40 caracteres
    PercentualTaxa decimal Percentual de Taxa Sim
    IdRetaguardaAtividadePrincipal string Identificador do Ramo Atividade Principal Nã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
    Success bool Indica se a criação do ramo atividade foi feita com sucesso
    Message string Caso ocorra erros durante a criação do ramo atividade eles serão enviados nesse campo
    Data objeto Objeto ramo atividade criado
    Errors Lista Listas com os erros encontrados no processo
    TotalTime int tempo da requisição
    NumberOfRecords int nú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
    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
    • Sem rótulos