Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Este método é responsável pela criação de novos FormaPagtonovas Condições de pagamento

  • Endpoints: Endpoint:
      • /api/retaguarda/v2/
      FormaPagtos
      • condicaopagtos
      • /api/retaguarda/v3/condicaopagtos
      • /api/retaguarda/v3/dadosdinamicos/down/17/{Versão Dado}
    • Método: Post
    • Autenticação: Bearer token
    • Permissão: Retaguarda

    ...

    Aviso

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

    titleexpandtitleDefinição de requisição
    Deck of Cards
    idversções
    Card
    labelV3.1 (V2)

    Requisição

    Section
    Column
    width50%
    Expandir

    Exemplo de body da requisição

    [
        {
            "condicoesPagtoOperadoras": [
                {
                    "id": 0,
                    "idCondicaoPagamento": 0,
                    "idRetaguarda": "string",
                    "idRetaguardaCondicaoPagto": "string",
                    "idRetaguardaOperadora": "string",
                    "situacao": 0
                }
            ],
            "dadoComplementarDescricao": "string",
            "descricao": "string",
            "diasEntreParcelas": 0,
            "idInquilino": "string",
            "idProprietario": "string",
            "idRetaguarda": "string",
            "indicePreco": "string",
            "loteOrigem": "string",
            "numeroMaximoParcelas": 0,
            "percentualMinimoEntrada": 0,
            "prazoMaximoPrimeiraParcela": 0,
            "situacao": 0,
            "solicitaDataDemaisParcelas": 0,
            "solicitaDataPrimeiraParcela": 0,
            "taxa":0.0
            "tipoDadoComplementar": 0
        }
    ]

    Column
    width50%

    Definições dos campos do body

    Campo

    Tipo

    Descrição

    Obrigatório

    Observações

    descricao

    String

    Desccrição da condição de pagamento

    Sim

    Tamanho máximo: 50 caracteres

    condicoesPagtoOperadorasLista de ObjetosLista de operadoresNão
    condicoesPagtoOperadoras.idIntIdentificador da operadora no POSHNão
    condicoesPagtoOperadoras.idCondicaoPagamentoIntIdentificador da Forma de pagametno Condição pagamento no POSHNão
    condicoesPagtoOperadoras.idRetaguardaStringIdentificador da condicao pagamento operadora na retaguardaSimTamanho máximo: 100 caracteres
    condicoesPagtoOperadoras.idRetaguardaCondicaoPagtoStringIdeintificador da condição pagamento na retaguardaSimTamanho máximo: 100 caracteres
    condicoesPagtoOperadoras.idRetaguardaOperadoraStringIdentificador da operadora na retaguardaSimTamanho máximo: 100 caracteres
    condicoesPagtoOperadoras.situacaoIntSituação da operadora

    Não

    0 - Inativo, 1 - Ativo

    Caso não enviado será cadastrado como 0

    dadoComplementarDescricaoStringDescrição dado complementarNãoTamanho máximo: 30 caracteres
    diasEntreParcelasIntDias entre as parcelasSim
    idInquilinoStringIdentificador do inquilinoSim
    idProprietarioStringIdentificador do proprietárioSim
    idRetaguardaStringIdentificador da condição de pagamento na retaguardaSimTamanho máximo: 100 caracteres
    indicePrecoStringIndice PrecoNãoTamanho máximo: 100 caracteres
    loteOrigemStringIdentificador do lote em que os dados serão enviadosSim
    numeroMaximoParcelasIntNúmero máximo de parcelasSim
    percentualMinimoEntradaIntPercentual mínimo de entradaNão
    prazoMaximoPrimeiraParcelaIntPrazo máximo da primeira parcela

    Não


    Caso não enviado será cadastrado como 0

    situacaoIntSituação da condição de pagamento

    Sim

    0 - Inativo, 1 - Ativo

    solicitaDataDemaisParcelasIntIndica se solicita a data das demais parcelas

    Não

    0 - Não, 1 - Sim

    Caso não enviado será cadastrado como 0

    solicitaDataPrimeiraParcelaIntIndica se solicita a data da primeira parcela

    Não

    0 - Não, 1 - Sim

    Caso não enviado será cadastrado como 0

    taxaDecimalTaxa

    Não


    tipoDadoComplementarIntTipo do dado complementarNão

    Retorno

    Deck of Cards
    idretornos
    Card
    label200 - Ok
    Column
    width50%

    Exemplo de body de retorno

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

    tipoDadoComplementar": 0,
        "dadoComplementarDescricao": "string",

    numberOfRecords": 0
    }

    Column
    width50%

    Definições dos campos do retorno

    Campo

    Tipo

    Descrição

    SuccessboolIndica se a criação do compartilhamento foi feita com sucesso
    MessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
    DataobjetoObjeto compartilhamento criado
    ErrorsListaListas com os erros encontrados no processo
    TotalTimeinttempo da requisição
    NumberOfRecordsintnúmero de dados inseridos
    Card
    label400 - Bad Request
    Column
    width50%

    Exemplo de body de retorno

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

    Column
    width50%

    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
    Card
    labelV3.2
    Informações

    Este endpoint ainda está em processo de manutenção, as informações estão disponibilizadas apenas para consulta, não sendo possível realizar a requisição.

    Requisição

    Section
    Column
    width50%

    Exemplo de body da requisição

    [
        {
            "condicoesPagtoOperadoras": [
                {
                    "

    id

    idCondicaoPagamento": 0,
                    "idRetaguarda": "string",
                    "idRetaguardaCondicaoPagto": "string",
                    "idRetaguardaOperadora": "string",
                    "situacao": 0
                }
            ],
            "dadoComplementarDescricao": "string",
            "descricao": "string",
            "diaFixoPagamento": 0,
            "

    idCondicaoPagamento

    diasCarenciaPrimeiroVencimento": 0,
           

    }
        ],

    "diasEntreParcelas": 0,
            "fixaNumeroParcela": 0,
            "idInquilino": "string",
            "idProprietario": "string",
            "idRetaguarda": "string",
            "

    idProprietario

    indicePreco": "string",
            "loteOrigem": "string",
            "numeroMaximoParcelas": 0,
            "percentualMinimoEntrada": 0,
            "prazoMaximoPrimeiraParcela": 0,
            "quantidadeParcelas": 0,
            "situacao": 0,
            "solicitaDataDemaisParcelas": 0,
            "solicitaDataPrimeiraParcela": 0,
            "taxa":0.0
            "tipoDadoComplementar": 0,
            "tipoVencimentoParcelamento": 0,
            "valorMinimoParcela": 0
        }
    ]

    Column
    width
    50%

    Definições dos campos

    do body

    Campo

    Tipo

    Descrição

    Obrigatório

    Observações

    descricaoStringDesccrição da condição de pagamento
    Obrigatório

    Sim

    Tamanho máximo: 50 caracteres

    diasEntreParcelasIntDias entre as parcelas
    Obrigatório
    Não
    numeroMaximoParcelasIntNúmero máximo de parcelas
    Obrigatório
    Não
    percentualMinimoEntradaIntPercentual mínimo de entrada
    Opcional
    Não
    prazoMaximoPrimeiraParcelaIntPrazo máximo da primeira parcela
    Opcional

    Não

    Caso não enviado será cadastrado como 0

    solicitaDataDemaisParcelasIntIndica se solicita a data das demais parcelas
    Aceito 0 ou 1

    Não

    Caso não enviado será cadastrado como 0

    solicitaDataPrimeiraParcelaIntIndica se solicita a data da primeira parcela
    Aceito 0 ou 1

    Não

    Caso não enviado será cadastrado como 0

    situacaoIntSituação da condição de pagamento
    (

    Sim

    0 - Inativo, 1 - Ativo

    )Obrigatório

    tipoDadoComplementarIntTipo do dado complementar
    Opcional

    Não


    dadoComplementarDescricaoStringDescrição dado complementar
    Opcional
    NãoTamanho máximo: 30 caracteres
    condicoesPagtoOperadorasLista de ObjetosLista de operadores
    Opcional
    Não
    condicoesPagtoOperadoras.idIntIdentificador da operadora no POSH
    Opcional
    Não
    condicoesPagtoOperadoras.idRetaguardaStringIdentificador da condicao pagamento operadora na retaguarda
    Obrigatório
    Sim
    condicoesPagtoOperadoras.idRetaguardaCondicaoPagtoStringIdeintificador da condição pagamento na retaguarda
    Obrigatório
    Sim
    condicoesPagtoOperadoras.idRetaguardaOperadoraStringIdentificador da operadora na retaguarda
    Obrigatório
    Sim
    condicoesPagtoOperadoras.situacaoIntSituação da operadora (0 - Inativo, 1 - Ativo)
    Opcional

    Não

    Caso não enviado será cadastrado como 0

    condicoesPagtoOperadoras.idCondicaoPagamentoIntIdentificador da Forma de pagametno Condição pagamento no POSH
    Opcional
    Não
    idInquilinoStringIdentificador do inquilino
    Obrigatório
    Sim
    idRetaguardaStringIdentificador da condição de pagamento na retaguarda
    Obrigatório
    SimTamanho máximo: 100 caracteres
    idProprietarioStringIdentificador do proprietário
    Obrigatório
    Expandir
    title200 - Ok
    Sim
    indicePrecoStringIndiceNãoTamanho máximo: 100 caracteres
    loteOrigemStringIdentificador do lote em que os dados serão enviados
    Obrigatório para a integração
    Expandir
    titleDefinição dos campos de retorno
    expandtitle
    Sim
    diaFixoPagamentoInt
    Não
    diasCarenciaPrimeiroVencimentoInt
    Não
    fixaNumeroparcelasInt
    Não
    quatidadeParcelasInt
    Não
    tipoVencimentoParcelamentoInt
    Não
    DescriçãoValor
    Dias corridos entre parcelas0
    Dia fixo mensal1
    Dia fixo semanal 2
    Dia fixo quinzenal3
    taxaDecimalTaxaNão


    valorMinimoParcelaInt
    Sim


    Retornos

    Deck of Cards
    idretornos
    Card
    label200 - Ok
    Column
    width50%

    Exemplo de body de retorno

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

    Column
    width50%

    Definições dos campos do retorno

    Campo

    Tipo

    Descrição

    SuccessboolIndica se a criação do compartilhamento foi feita com sucesso
    MessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
    DataobjetoObjeto compartilhamento criado
    ErrorsListaListas com os erros encontrados no processo
    TotalTimeinttempo da requisição
    NumberOfRecordsintnúmero de dados inseridos
    Card
    label400 - Bad Request
    Column
    width50%

    Exemplo de body de retorno

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

    Column
    width50%

    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
    Card
    labelDado Dinâmico

    O Dado dinâmico é uma nova forma para envio de dados entre PDV e Retaguarda.

    Para o envio de condição de pagamento pelo Dado dinâmico,  realizar um requisição o seguinte endpoint

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

    Versão dado

    Versão requisiçãoVersão dado
    V3.11
    V3.22
    Aviso

    A propriedade {Versão Dado}, enviado na URL da requisição, deve ser substituido pela versão do dado que será enviado.

    O body da requisição é o mesmo enviado no endpoint padrão. Consulte as outras abas dessa seção para ver o que deve ser enviado na requisição de acordo com a versão dado enviado na URL.