Á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

[
    {
        "descricao": "string",
        "descricaoFiscaldiasEntreParcelas": "string"0,
        "permiteTroconumeroMaximoParcelas": 0,
        "idRetaguardaFormaPagTrocopercentualMinimoEntrada": "string"0,
        "valorMinimoAceitoprazoMaximoPrimeiraParcela": "string"0,
        "codigoSistemaExternosolicitaDataDemaisParcelas": "string",
        "situacao": 0,
        "codigoModalidadePagamentosolicitaDataPrimeiraParcela": 0,
        "tiposituacao": 0,
        "tipoClientetipoDadoComplementar": 0,
        "formasPagtoCondicoes": [
            {
                "idRetaguardadadoComplementarDescricao": "string",
                "idRetaguardaFormaPagto": "string",
                "idRetaguardaCondicaoPagto": "string",
                "situacao": 0
            }
        ],
        "formasPagtoDadosComplementares": [
      condicoesPagtoOperadoras": [
      {
                "idRetaguarda": "string",
                "idRetaguardaFormaPagto": "string",
                "idRetaguardaDadoComplementarPagto": "string",
                "situacao": 0,
        id": 0,
        "ordem ": 0
            }
        ],
        "formasPagtoOperadoras": [
            {
                "idRetaguarda": "string",
                "idRetaguardaFormaPagtoidRetaguardaCondicaoPagto": "string",
                "idRetaguardaOperadoraPagtoidRetaguardaOperadora": "string",
                "situacao": 0
            }
        ],
        "formaPagtoModeloFiscal": [
            {
                "idRetaguarda": "string",
                "idRetaguardaFormaPagto": "string",
                "modeloFiscal": "string",
                "codigoFiscal": "string",
                "descricaoFiscal": "string",
                "situacao": 0
            idCondicaoPagamento": 0
      }
        ],
        "idInquilino": "string",
        "idRetaguarda": "string",
        "idProprietario": "string",
        "loteOrigem": "string"
    }]

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

Campo

Tipo

Descrição

Observações

descricaostringStringDescrição Desccrição da forma condição de pagamento

Obrigatório

Tamanho Máximomáximo: 50 caracteres

descricaoFiscaldiasEntreParcelasstringIntDias entre as parcelasDescrição fiscal da forma de pagamentoObrigatório

Tamanho Máximo: 50 caracteres

permiteTroconumeroMaximoParcelasIntIndica se a forma de pagamento permite troco (0 - Não; 1 - Sim)Número máximo de parcelasObrigatório
idRetaguardaFormaPagTrocopercentualMinimoEntradastringIdentificador 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

IntPercentual mínimo de entradaOpcional
prazoMaximoPrimeiraParcelaIntPrazo máximo da primeira parcela

Opcional

Caso não enviado será cadastrado como 0

solicitaDataDemaisParcelasIntIndica se solicita a data das demais parcelas

Aceito 0 ou 1

situacaointegerSituação da forma de pagamento (0 - Inativo, 1 - Ativo)

Caso não enviado será cadastrado como 0

codigoModalidadePagamentosolicitaDataPrimeiraParcelaintegerCódigo da modalidade de pagamentoOpcional
tipointegerTipo da forma de pagamento (Descrição abaixo)Obrigatório
tipoClienteintegerTipo clienteOpcional
formasPagtoCondicoesLista de objetosLista de condições de forma de pagamentoOpcional
formasPagtoCondicoes.idRetaguardastringIdentificador da condição na retaguardaOpcional
formasPagtoCondicoes.idRetaguardaFormaPagtostringIdentificador da forma de pagamento na retaguardaOpcional
formasPagtoCondicoes.idRetaguardaCondicaoPagtostringIdentificador da condição de pagamento na retaguardaOpcional
IntIndica se solicita a data da primeira parcela

Aceito 0 ou 1

Caso não enviado será cadastrado como 0

situacaoIntformasPagtoCondicoes.situacaointegerSituação da condição de pagamento (0 - Inativo, 1 - Ativo)Opcional

Obrigatório

formasPagtoDadosComplementarestipoDadoComplementarLista de objetosLista de Dados complementares da forma de pagamentoOpcionalIntTipo formasPagtoDadosComplementares.idRetaguardastringIdentificador do dado complementar na reguardarOpcional
formasPagtoDadosComplementares.idRetaguardaFormaPagtodadoComplementarDescricaostringIdentificador da forma de pagamento na retaguardaOpcionalStringDescrição dado complementarformasPagtoDadosComplementares.idRetaguardaDadoComplementarPagtostringIdentificador do dado complementar pagamento na retaguardaOpcional
condicoesPagtoOperadorasLista de ObjetosLista de operadoresformasPagtoDadosComplementares.situacaointegerSituação do dado complementar (0 - Inativo, 1 - Ativo)Opcional
formasPagtoDadosComplementarescondicoesPagtoOperadoras.ordemidintegerOrdem do dado complementarOpcionalIntIdentificador da operadora no POSHformasPagtoOperadorasLista de objetosLista de operadoras da forma de pagamentoOpcional
formasPagtoOperadorascondicoesPagtoOperadoras.idRetaguardastringStringIdentificador da condicao pagamento operadora na retaguardaOpcionalObrigatório
formasPagtoOperadorascondicoesPagtoOperadoras.idRetaguardaFormaPagtoidRetaguardaCondicaoPagtostringStringIdentificador Ideintificador da forma de condição pagamento na retaguardaOpcionalObrigatório
formasPagtoOperadorascondicoesPagtoOperadoras.idRetaguardaOperadoraPagtoidRetaguardaOperadorastringStringIdentificador da Operadora pagamento operadora na retaguardaOpcionalObrigatório
formasPagtoOperadorascondicoesPagtoOperadoras.situacaointegerIntSituação da operadora (0 - Inativo, 1 - Ativo)

Opcional

formaPagtoModeloFiscalLista de objetosLista de modelos fiscaisOpcional
formaPagtoModeloFiscal.idRetaguardastringIdentificador do modelo na retaguardaOpcional
formaPagtoModeloFiscal.idRetaguardaFormaPagtostringIdentificador da forma de pagamento na retaguardaOpcional
formaPagtoModeloFiscal.modeloFiscalstringModelo fiscalOpcional
formaPagtoModeloFiscal.codigoFiscalstringCódigo fiscalOpcional
formaPagtoModeloFiscal.descricaoFiscalstringDescrição fiscalOpcional

Caso não enviado será cadastrado como 0

condicoesPagtoOperadoras.idCondicaoPagamentoIntIdentificador da Forma de pagametno Condição pagamento no POSHformaPagtoModeloFiscal.situacaointegerSituação do modelo fiscal (0 - Inativo, 1 - Ativo)Opcional
idInquilinostringStringIdentificador do inquilinoObrigatório
idRetaguardastringStringIdentificador da forma condição de pagamento na retaguardaObrigatório
idProprietariostringStringIdentificador do proprietárioObrigatório
loteOrigemstringStringIdentificador do lote em que os dados serão enviadosObrigatório para a integração
Expandir
titleTipoFormaPagto
CódigoTipo
0Outros
1Dinheiro
2Credito
3Debito
4Cheque
5POS
6Troca
8Gift
10
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