Histórico da Página

Definições dos campos do body

Caso não enviado será cadastrado como 0

Retorno

Deck of Cards

id	versções

Card

id	card1
label	Descriçã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 parcelas	dias_entre_parcelas	Não	Inteiro		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 parcelas	numero_maximo_parcelas	Não	Inteiro		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 entrada	percentual_minimo_entrada	Não	Inteiro		Dado recebido no retaguarda/ERP, porém não utilizado no PDV.
Prazo máximo para primeira parcela	prazo_maximo_primeira_parcela	Não	Inteiro		Dado recebido no retaguarda/ERP, porém não utilizado no PDV.
Solicita a data das demais parcelas	solicita_data_demais_parcelas	Não	Inteiro		Dado recebido no retaguarda/ERP, porém não utilizado no PDV.
Solicita a data da primeira parcela	solicita_data_primeira_parcela	Não	Inteiro		Dado recebido no retaguarda/ERP, porém não utilizado no PDV.
Situação	situacao	Sim	Inteiro		Define se a condição em questão está ativo ou inativo. 0 - Inativo 1 - Ativo
Data de cadastro	data_cadastro	Sim	Data		Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente.
Data de atualização	data_atualizacao	Sim	Data		Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi atualizado localmente.
Identificação no retaguarda	id_retaguarda	Não	Texto	100
Dado complementar	dado_complementar	Não	Inteiro		Defasado
Descrição do dado complementar	dado_complementar_descricao	Não	Texto	30	Defasado
Dia fixo para o pagamento	dia_fixo_pagamento	Não	Inteiro		Dado recebido no retaguarda/ERP e utilizado pelo PDV para realizar o calculo das parcelas.
Quantidade de dias de carência para o primeiro pagamento	dias_carencia_primeiro_vencimento	Não	Inteiro		Dado recebido no retaguarda/ERP e utilizado pelo PDV para realizar o calculo das parcelas.
Configuração se o número de parcelas é fixo	fixa_numero_parcelas	Não	Inteiro		Dado recebido no retaguarda/ERP e utilizado pelo PDV formatar a apresentação das parcelas.
Quantidade de parcelas	quantidade_parcelas	Não	Inteiro		Dado recebido no retaguarda/ERP e utilizado pelo PDV formatar a apresentação das parcelas.
Tipo de arredondamento	tipo_arredondamento	Não	Inteiro		Defasado Arredonda primeira parcela = 0 Arredonda ultima parcela = 1
Tipo de vencimento para o parcelamento	tipo_vencimento_parcelamento	Não	Inteiro		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 útil	vence_dia_util	Não	Inteiro		Defasado
Configuração do valor mínimo de parcela	valor_minimo_parcela	Sim	Numérico	10	Dado recebido no retaguarda/ERP e utilizado pelo PDV formatar a apresentação das parcelas

Requisição

Card

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

id	v2

Card

label	V3.1

Section

Column

width	50%

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

width	50%

Campo

Tipo

Descrição

Obrigatório

Observações

descricao

String

Descrição da condição de pagamento

Sim

Tamanho máximo: 50 caracteres

condicoesPagtoOperadoras

Lista de Objetos

Lista de operadores

Não

condicoesPagtoOperadoras.id

Int

Identificador da operadora no POSH

Não

condicoesPagtoOperadoras.idCondicaoPagamento

Int

Identificador da Forma de pagamento Condição pagamento no POSH

Não

condicoesPagtoOperadoras.idRetaguarda

String

Identificador da condição pagamento operadora na retaguarda

Sim

Tamanho máximo: 100 caracteres

condicoesPagtoOperadoras.idRetaguardaCondicaoPagto

String

Identificador da condição pagamento na retaguarda

Sim

Tamanho máximo: 100 caracteres

condicoesPagtoOperadoras.idRetaguardaOperadora

String

Identificador da operadora na retaguarda

Sim

Tamanho máximo: 100 caracteres

condicoesPagtoOperadoras.situacao

Int

Situação da operadora

Não

0 - Inativo, 1 - Ativo

Caso não enviado será cadastrado como 0

condicoesPagtoRestricoes

Lista de Objetos

Lista de restrições de pagamento

Não

condicoesPagtoRestricoes.Situacao

Int

Situação da restrição da condição de pagamento

Sim

0 - Inativo, 1 - Ativo

condicoesPagtoRestricoes.idRetaguarda

String

Identificador da Restrição da condição de pagamento na retaguarda

Sim

Tamanho máximo: 100 caracteres

condicoesPagtoRestricoes.idRetaguardaSecao

String

Identificador da Seção da restrição da condição de pagamento na retaguarda

Não

Tamanho máximo: 100 caracteres

condicoesPagtoRestricoes.idRetaguardaCliente

String

Identificador do cliente da restrição condição de pagamento na retaguarda

Não

Tamanho máximo: 100 caracteres

condicoesPagtoRestricoes.idRetaguardaCategoria

String

Identificador da Categoria da restrição da condição de pagamento na retaguarda

Não

Tamanho máximo: 100 caracteres

condicoesPagtoRestricoes.idRetaguardaFornecedor

String

Identificador do Fornecedor da Restrição da condição de pagamento na retaguarda

Não

Tamanho máximo: 100 caracteres

condicoesPagtoRestricoes.idRetaguardaDepartamento

String

Identificador do departamento da Restrição da condição de pagamento na retaguarda

Não

Tamanho máximo: 100 caracteres

condicoesPagtoRestricoes.idRetaguardaSubCategoria

String

Identificador da SubCategoria da Restrição da condição de pagamento na retaguarda

Não

Tamanho máximo: 100 caracteres

condicoesPagtoRestricoes.idRetaguardaRamoAtividade

String

Identificador do Ramo de Atividade da Restrição da condição de pagamento na retaguarda

Não

Tamanho máximo: 100 caracteres

condicoesPagtoRestricoes.idRetaguardaCondicaoPagamento

String

Identificador da Condição de Pagamento referente à Restrição da condição de pagamento na retaguarda

Sim

Tamanho máximo: 100 caracteres

dadoComplementarDescricao

String

DEFASADO

Não

Tamanho máximo: 30 caracteres

diasEntreParcelas

Int

Dias entre as parcelas

Não

diaFixoPagamento

Int

Dado recebido no retaguarda/ERP e utilizado pelo PDV para realizar o calculo das parcelas.

Não

diasCarenciaPrimeiroVencimento

Inteiro

Quantidade de dias de carência para o primeiro pagamento

Não

fixaNumeroParcelas

Inteiro

Configuração se o número de parcelas é fixo

Não

idInquilino

String

Identificador do inquilino

Sim

idProprietario

String

Identificador do proprietário

Sim

idRetaguarda

String

Identificador da condição de pagamento na retaguarda

Sim

Tamanho máximo: 100 caracteres

indicePreco

String

Indice Preco

Não

Tamanho máximo: 100 caracteres

loteOrigem

String

Identificador do lote em que os dados serão enviados

Sim

numeroMaximoParcelas

Int

Número máximo de parcelas

Não

percentualMinimoEntrada

Int

Percentual mínimo de entrada

Não

prazoMaximoPrimeiraParcela

Int

Prazo máximo da primeira parcela

Não

quantidadeParcelas

Int

Quantidade de parcelas

Não

situacao

Int

Situação da condição de pagamento

Sim

0 - Inativo, 1 - Ativo

solicitaDataDemaisParcelas

Int

Indica se solicita a data das demais parcelas

Não

0 - Não, 1 - Sim

Caso não enviado será cadastrado como 0

solicitaDataPrimeiraParcela

Int

Indica se solicita a data da primeira parcela

Não

0 - Não, 1 - Sim

Caso não enviado será cadastrado como 0

taxa

Decimal

Taxa

Não

tipoDadoComplementar

Int

DEFASADO

Não

tipoVencimentoParcelamento

Int

Dado recebido no retaguarda/ERP e utilizado pelo PDV para realizar o calculo das parcelas.

Não

Código

Descrição

0

Dias corridos entre parcelas

1

Dia fixo mensal

2

Dia fixo semanal

3

Dia fixo quinzenal

valorMinimoParcela

Decimal

Configuração do valor mínimo de parcela

Sim

Tamanho máximo: 10

Deck of Cards

id	retornos

Card

label	200 - Ok

Column

width	50%

Exemplo de body de retorno

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

Column

width	50%

Definições dos campos do retorno

Campo

Tipo

Descrição

SuccessboolIndica se a criação do ramo atividade foi feita com sucessoMessagestringCaso ocorra erros durante a criação do ramo atividade eles serão enviados nesse campoDataobjetoObjeto ramo atividade criadoErrorsListaListas com os erros encontrados no processoTotalTimeinttempo da requisiçãoNumberOfRecordsintnúmero de dados inseridos Card

label	400 - Bad Request

Column

width	50%

Exemplo de body de retorno

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

Column

width	50%

Definições dos campos do retorno

Campo

Tipo

Descrição

codestringCódigo de erromessagestringMensagem do errodetailedMessagestringDetalhamento do errohelpUrlstringurl de ajudaTotalTimestringTempo total de buscadetailslista de objetoLista de objeto de errosdetails.guidstringIdentificador do errodetails.codestringCódigo do errodetails.messagestringMensagem do erro details.detailedMessagestringDetalhamento do erro

Para maiores informações de como integrar a Condição de Pagamento, clique aqui.

Árvore de páginas

Versões comparadas

Versão antiga 14

Nova versão Atual

Chave

Definições dos campos do body

Exemplo de body da requisição

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos do retorno