Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Deck of Cards
idversções
Card
idcard1
labelDescrição dos campos e regras

Pagamento_Condicao

Pagamento_Condicao

A tabela pagamento_condicao possui vinculo tanto com a operadora quanto a forma de pagamento em si.
O vinculo entre a pagamento_condicao e a pagamento_operadora ocorre através da pagamento_condicao_operadora, onde é informado os IDs de vinculo.
O vinculo entre a pagamento_condicao e a pagamento_forma ocorre através da pagamento_forma_condicao, onde é informado os IDs de vinculo.

Informação

Coluna

Obrigatório

Tipo

Tamanho

Descrição

Descrição da condição

descricao

Sim

Texto

50

Descrição da condição de pagamento.

*Condições relacionados ao produto eletrônico possui um texto padronizado diferente do cadastrado, onde o nome é formado por:
Caso a operação seja débito será iniciado com "PRE DATADO" e caso seja diferente de débito será "PARCELADO". Na sequência virá o nome do produto, número de parcelas e o texto "PARCELAS".
Por exemplo: "PARCELADO ELO CRED (C)-5 parcelas"

Dias entre parcelasdias_entre_parcelasNãoInteiro
Dado recebido no retagaurda/ERP. Posteriormente esse dado é gravado no objeto Financeiro.Objects.Cartao na mensagem do financeiro integrado com o TOTVS Live
Número máximo de parcelasnumero_maximo_parcelasNãoInteiro
Dado recebido no retagaurda/ERP. No PDV esse dado é utilizado para preenchimento de lista de parcelas disponívels para seleção e finalização da venda.
Percentual mínimo de entradapercentual_minimo_entradaNãoInteiro
Dado recebido no retaguarda/ERP, porém não utilizado no PDV.
Prazo máximo para primeira parcelaprazo_maximo_primeira_parcelaNãoInteiro
Dado recebido no retaguarda/ERP, porém não utilizado no PDV.
Solicita a data das demais parcelassolicita_data_demais_parcelasNãoInteiro
Dado recebido no retaguarda/ERP, porém não utilizado no PDV.
Solicita a data da primeira parcelasolicita_data_primeira_parcelaNãoInteiro
Dado recebido no retaguarda/ERP, porém não utilizado no PDV.
SituaçãosituacaoSimInteiro

Define se a condição em questão está ativo ou inativo.

  • 0 - Inativo
  • 1 - Ativo
Data de cadastrodata_cadastroSimData
Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente.
Data de atualizaçãodata_atualizacaoSimData
Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi atualizado localmente.
Identificação no retaguardaid_retaguardaNãoTexto100
Dado complementardado_complementarNãoInteiro
Defasado
Descrição do dado complementardado_complementar_descricaoNãoTexto30Defasado
Dia fixo para o pagamentodia_fixo_pagamentoNãoInteiro
Dado recebido no retaguarda/ERP e utilizado pelo PDV para realizar o calculo das parcelas.
Quantidade de dias de carência para o primeiro pagamentodias_carencia_primeiro_vencimentoNãoInteiro
Dado recebido no retaguarda/ERP e utilizado pelo PDV para realizar o calculo das parcelas.
Configuração se o número de parcelas é fixofixa_numero_parcelasNãoInteiro
Dado recebido no retaguarda/ERP e utilizado pelo PDV formatar a apresentação das parcelas.
Quantidade de parcelasquantidade_parcelasNãoInteiro
Dado recebido no retaguarda/ERP e utilizado pelo PDV formatar a apresentação das parcelas.
Tipo de arredondamentotipo_arredondamentoNãoInteiro
Defasado
  • Arredonda primeira parcela = 0
  • Arredonda ultima parcela = 1
Tipo de vencimento para o parcelamentotipo_vencimento_parcelamentoNãoInteiro
  • Dado recebido no retaguarda/ERP e utilizado pelo PDV para realizar o calculo das parcelas.
    Dias corridos entre parcelas = 0
  • Dia fixo mensal = 1
  • Dia fixo semanal = 2
  • Dia fixo quinzenal = 3
Configuração se vence em dia útilvence_dia_utilNãoInteiro
Defasado
Configuração do valor mínimo de parcelavalor_minimo_parcelaSimNumérico10Dado recebido no retaguarda/ERP e utilizado pelo PDV formatar a apresentação das parcelas
Card
labelComo integrar

Este método é responsável pela criação de um novo Preço Promocional

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

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

Aviso

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

Deck of Cards
idv2
Card
labelV3.1

Requisição

Section
Column
width50%

Exemplo de body da requisição

[
    {
        "condicoesPagtoOperadoras": [
            {
                "id": 0,
                "idCondicaoPagamento": 0,
                "idRetaguarda": "string",
                "idRetaguardaCondicaoPagto": "string",
                "idRetaguardaOperadora": "string",
                "situacao": 0
            }
        ],
        "condicoesPagtoRestricoes": [
            {
                "Situacao": 0,
                "idRetaguarda": "string",
                "idRetaguardaSecao": "string",
                "idRetaguardaCliente": "string",
                "idRetaguardaCategoria": "string",
                "idRetaguardaFornecedor": "string",
                "idRetaguardaDepartamento": "string",
                "idRetaguardaSubCategoria": "string",
                "idRetaguardaRamoAtividade": "string",
                "idRetaguardaCondicaoPagamento": "string"
            }
        ],
        "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,
        "tipoVencimentoParcelamento": 1,
        "valorMinimoParcela": 1
    }
]

Column
width50%

Definições dos campos do body

Campo

Tipo

Descrição

Obrigatório

Observações

descricao

String

Descriçã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 pagamento Condição pagamento no POSHNão
condicoesPagtoOperadoras.idRetaguardaStringIdentificador da condição pagamento operadora na retaguardaSimTamanho máximo: 100 caracteres
condicoesPagtoOperadoras.idRetaguardaCondicaoPagtoStringIdentificador 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

condicoesPagtoRestricoesLista de ObjetosLista de restrições de pagamentoNão
condicoesPagtoRestricoes.SituacaoIntSituação da restrição da condição de pagamento

Sim

0 - Inativo, 1 - Ativo

condicoesPagtoRestricoes.idRetaguardaStringIdentificador da Restrição da condição de pagamento na retaguardaSimTamanho máximo: 100 caracteres
condicoesPagtoRestricoes.idRetaguardaSecaoStringIdentificador da Seção da restrição da condição de pagamento na retaguardaNãoTamanho máximo: 100 caracteres
condicoesPagtoRestricoes.idRetaguardaClienteStringIdentificador do cliente da restrição condição de pagamento na retaguardaNãoTamanho máximo: 100 caracteres
condicoesPagtoRestricoes.idRetaguardaCategoriaStringIdentificador da Categoria da restrição da condição de pagamento na retaguardaNãoTamanho máximo: 100 caracteres
condicoesPagtoRestricoes.idRetaguardaFornecedorStringIdentificador do Fornecedor da Restrição da condição de pagamento na retaguardaNãoTamanho máximo: 100 caracteres
condicoesPagtoRestricoes.idRetaguardaDepartamentoStringIdentificador do departamento da Restrição da condição de pagamento na retaguardaNãoTamanho máximo: 100 caracteres
condicoesPagtoRestricoes.idRetaguardaSubCategoriaStringIdentificador da SubCategoria da Restrição da condição de pagamento na retaguardaNãoTamanho máximo: 100 caracteres
condicoesPagtoRestricoes.idRetaguardaRamoAtividadeStringIdentificador do Ramo de Atividade da Restrição da condição de pagamento na retaguardaNãoTamanho máximo: 100 caracteres
condicoesPagtoRestricoes.idRetaguardaCondicaoPagamentoStringIdentificador da Condição de Pagamento referente à Restrição da condição de pagamento na retaguardaSimTamanho máximo: 100 caracteres
dadoComplementarDescricaoStringDEFASADONãoTamanho máximo: 30 caracteres
diasEntreParcelasIntDias entre as parcelasNão
diaFixoPagamentoIntDado recebido no retaguarda/ERP e utilizado pelo PDV para realizar o calculo das parcelas.Não
diasCarenciaPrimeiroVencimentoInteiroQuantidade de dias de carência para o primeiro pagamentoNão
fixaNumeroParcelasInteiroConfiguração se o número de parcelas é fixoNão
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 parcelasNão
percentualMinimoEntradaIntPercentual mínimo de entradaNão
prazoMaximoPrimeiraParcelaIntPrazo máximo da primeira parcela

Não


Caso não enviado será cadastrado como 0

quantidadeParcelasIntQuantidade de parcelas

Não


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


tipoDadoComplementarIntDEFASADONão

tipoVencimentoParcelamento

IntDado recebido no retaguarda/ERP e utilizado pelo PDV para realizar o calculo das parcelas.Não
CódigoDescrição
0Dias corridos entre parcelas
1Dia fixo mensal
2Dia fixo semanal
3Dia fixo quinzenal 

valorMinimoParcela

DecimalConfiguração do valor mínimo de parcelaSim

Tamanho máximo: 10

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,
    "numberOfRecords": 0
}

Column
width50%

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
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