Á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

  • Endpoint: /api/retaguarda/v2/FormaPagtoscondicaopagtos
  • Método: Post
  • Autenticação: Bearer token
  • Permissão: Retaguarda

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

Aviso

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

Expandir
titleExemplo de body da requisição

[
    {
        "descricaocondicoesPagtoOperadoras": "string",[
        "descricaoFiscal": "string",
        "permiteTroco": 0,{
        "idRetaguardaFormaPagTroco": "string",
        "valorMinimoAceitoidCondicaoPagamento": "string",
        "codigoSistemaExterno": "string",
        "situacao": 0,
        "codigoModalidadePagamento": 0,
        "tipo": 0,
        "tipoCliente": 0,
        "formasPagtoCondicoes": [
            {
                "idRetaguarda": "string",
                "idRetaguardaFormaPagtoidRetaguardaCondicaoPagto": "string",
                "idRetaguardaCondicaoPagtoidRetaguardaOperadora": "string",
                "situacao": 0
            }
        ],
        "formasPagtoDadosComplementares": [
            {
                "idRetaguardadadoComplementarDescricao": "string",
                "idRetaguardaFormaPagtodescricao": "string",
                "idRetaguardaDadoComplementarPagtodiaFixoPagamento": "string"0,
                "situacaodiasCarenciaPrimeiroVencimento": 0,
                "ordemdiasEntreParcelas": 0
            }
        ],
        "formasPagtoOperadorasfixaNumeroParcela": [0,
            {
                "idRetaguarda"idInquilino": "string",
                "idRetaguardaFormaPagtoidProprietario": "string",
                "idRetaguardaOperadoraPagtoidRetaguarda": "string",
                "situacaoloteOrigem": 0
            }
        ],
        "formaPagtoModeloFiscal": ["string",
            {
                "idRetaguarda": "string",
        "numeroMaximoParcelas": 0,
        "idRetaguardaFormaPagtopercentualMinimoEntrada": "string"0,
                "modeloFiscalprazoMaximoPrimeiraParcela": "string"0,
                "codigoFiscalquantidadeParcelas": "string"0,
                "descricaoFiscalsituacao": "string"0,
                "situacaosolicitaDataDemaisParcelas": 0
            }
        ],
        "idInquilinosolicitaDataPrimeiraParcela": "string"0,
        "idRetaguardatipoDadoComplementar": "string"0,
        "idProprietariotipoVencimentoParcelamento": "string"0,
        "loteOrigemvalorMinimoParcela": "string"0
    }
]

Expandir
titleDefinição dos campos de requisição

Campo

Tipo

Descrição

Observações

Obrigatório

descricao
string
String
Descrição
Desccrição da
forma
condição de pagamento
Obrigatório

Tamanho

Máximo

máximo: 50 caracteres

descricaoFiscal

Sim

stringDescrição fiscal da forma de pagamento

Obrigatório

Tamanho Máximo: 50 caracteres

permiteTrocoIntIndica se a forma de pagamento permite troco (0 - Não; 1 - Sim)Obrigatório
idRetaguardaFormaPagTrocostringIdentificador da forma de pagamento troco na retaguarda

Obrigatório

Tamanho Máximo: 100 caracteres

valorMinimoAceitostringValor mínimo aceita para a forma de pagamentoOpcional
codigoSistemaExternostringCódigo Sistema Externo

Obrigatório

Tamanho Máximo: 50 caracteres

diasEntreParcelasIntDias entre as parcelas
Não
numeroMaximoParcelasIntNúmero máximo de parcelas
Não
percentualMinimoEntradaIntPercentual mínimo de entrada
Não
prazoMaximoPrimeiraParcelaIntPrazo máximo da primeira parcela
situacaointegerSituação da forma de pagamento (0 - Inativo, 1 - Ativo)

Caso não enviado será cadastrado como 0

codigoModalidadePagamento

Não

integerCódigo da modalidade de pagamentoOpcional
solicitaDataDemaisParcelasIntIndica se solicita a data das demais parcelas

Caso não enviado será cadastrado como 0

Não

solicitaDataPrimeiraParcelaIntIndica se solicita a data da primeira parcela

Caso não enviado será cadastrado como 0

Não

situacaoInt
tipointegerTipo da forma de pagamento (Descrição abaixo)ObrigatóriotipoClienteintegerTipo clienteOpcionalformasPagtoCondicoesLista de objetosLista de condições de forma de pagamentoOpcionalformasPagtoCondicoes.idRetaguardastringIdentificador da condição na retaguardaOpcionalformasPagtoCondicoes.idRetaguardaFormaPagtostringIdentificador da forma de pagamento na retaguardaOpcionalformasPagtoCondicoes.idRetaguardaCondicaoPagtostringIdentificador da condição de pagamento na retaguardaOpcionalformasPagtoCondicoes.situacaointeger
Situação da condição de pagamento
(

0 - Inativo, 1 - Ativo

)

Opcional

Sim

formasPagtoDadosComplementares
tipoDadoComplementar
Lista de objetosLista de Dados complementares da forma de pagamentoOpcionalformasPagtoDadosComplementares.idRetaguardastring
IntTipo
Identificador
do dado complementar
na reguardar
Opcional

Não

formasPagtoDadosComplementares.idRetaguardaFormaPagto
dadoComplementarDescricao
stringIdentificador da forma de pagamento na retaguardaOpcionalformasPagtoDadosComplementares.idRetaguardaDadoComplementarPagtostringIdentificador do dado complementar pagamento na retaguardaOpcionalformasPagtoDadosComplementares.situacaointegerSituação do dado complementar (0 - Inativo, 1 - Ativo)OpcionalformasPagtoDadosComplementares.ordemintegerOrdem do dado complementarOpcionalformasPagtoOperadorasLista de objetosLista de operadoras da forma de pagamentoOpcionalformasPagtoOperadoras.idRetaguardastringIdentificador da operadora na retaguardaOpcionalformasPagtoOperadoras.idRetaguardaFormaPagtostringIdentificador da forma de pagamento na retaguardaOpcionalformasPagtoOperadoras.idRetaguardaOperadoraPagtostringIdentificador da Operadora pagamento na retaguardaOpcionalformasPagtoOperadoras.situacao
StringDescrição dado complementarTamanho máximo: 30 caracteresNão
condicoesPagtoOperadorasLista de ObjetosLista de operadores
Não
condicoesPagtoOperadoras.idIntIdentificador da operadora no POSH
Não
condicoesPagtoOperadoras.idRetaguardaStringIdentificador da condicao pagamento operadora na retaguarda
Sim
condicoesPagtoOperadoras.idRetaguardaCondicaoPagtoStringIdeintificador da condição pagamento na retaguarda
Sim
condicoesPagtoOperadoras.idRetaguardaOperadoraStringIdentificador da operadora na retaguarda
Sim
condicoesPagtoOperadoras.situacaoInt
integer
Situação da operadora (0 - Inativo, 1 - Ativo)
OpcionalformaPagtoModeloFiscalLista de objetosLista de modelos fiscaisOpcionalformaPagtoModeloFiscal.idRetaguardastringIdentificador do modelo na retaguardaOpcionalformaPagtoModeloFiscal.idRetaguardaFormaPagtostringIdentificador da forma de pagamento na retaguardaOpcionalformaPagtoModeloFiscal.modeloFiscalstringModelo fiscalOpcionalformaPagtoModeloFiscal.codigoFiscalstringCódigo fiscalOpcionalformaPagtoModeloFiscal.descricaoFiscalstringDescrição fiscalOpcionalformaPagtoModeloFiscal.situacaointegerSituação do modelo fiscal (0 - Inativo, 1 - Ativo)Opcional

Caso não enviado será cadastrado como 0

Não

condicoesPagtoOperadoras.idCondicaoPagamentoIntIdentificador da Forma de pagametno Condição pagamento no POSH
Não
idInquilinoString
idInquilinostring
Identificador do inquilino
Obrigatório

Sim
idRetaguarda
string
StringIdentificador da
forma
condição de pagamento na retaguarda
Obrigatório

Sim
idProprietario
string
StringIdentificador do proprietário
Obrigatório

Sim
loteOrigem
string
StringIdentificador do lote
Obrigatório para a integração
Expandir
titleTipoFormaPagto
em que os dados serão enviados
Sim
diaFixoPagamentoInt

Não
diasCarenciaPrimeiroVencimentoInt

Não
fixaNumeroparcelasInt

Não
quatidadeParcelasInt

Não
tipoVencimentoParcelamentoInt
DescriçãoValor
Dias corridos entre parcelas0
Dia fixo mensal1
Dia fixo semanal 2
Dia fixo quinzenal3
Não
valorMinimoParcelaInt


Sim
CódigoTipo0Outros1Dinheiro2Credito3Debito4Cheque5POS6Troca8Gift10QRCode
Expandir
titleDefinição dos campos de retorno
Expandir
title200 - Ok

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
Expandir
title400 - Bad Request

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