Árvore de páginas

Versões comparadas

Chave

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

...

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

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

Aviso

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

Expandir
titleExemplo de body da requisição

[
  {
    "descricao": "string",
    "diasEntreParcelastipoDadoComplementar": 0,
    "numeroMaximoParcelasobrigatorio": 0,
    "percentualMinimoEntrada": 0,
    "prazoMaximoPrimeiraParcela": 0,
    "solicitaDataDemaisParcelas": 0,
    "solicitaDataPrimeiraParcelatamanho": 0,
    "situacao": 0,
    "tipoDadoComplementar": 0,
    "dadoComplementarDescricao": "string",
    "condicoesPagtoOperadoras": [
      {
        "id": 0,
        "idRetaguarda": "string",
        "idRetaguardaCondicaoPagto": "string",
        "idRetaguardaOperadora": "string",
        "situacao": 0,
        "idCondicaoPagamento": 0
      }
    ],
    "idInquilino": "string",
    "idRetaguarda": "string",
    "idProprietario": "string",
    "loteOrigem": "string"
  }
]

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

Campo

Tipo

Descrição

Observações

descricaoStringDesccrição da condição de pagamentoDescrição do dado complementar

Obrigatório

Tamanho máximo: 50 30 caracteres

diasEntreParcelastipoDadoComplementarIntDias entre as parcelasObrigatório
numeroMaximoParcelasIntNúmero máximo de parcelasObrigatório
percentualMinimoEntradaIntPercentual 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

Caso não enviado será cadastrado como 0

solicitaDataPrimeiraParcelaIntIndica se solicita a data da primeira parcela

Aceito 0 ou 1

Caso não enviado será cadastrado como 0

situacaoIntSituação da condição de pagamento (0 - Inativo, 1 - Ativo)

Obrigatório

tipoDadoComplementarIntTipo do dado complementarOpcional
dadoComplementarDescricaoStringDescrição dado complementarOpcional
condicoesPagtoOperadorasLista de ObjetosLista de operadoresOpcional
condicoesPagtoOperadoras.idIntIdentificador da operadora no POSHOpcional
condicoesPagtoOperadoras.idRetaguardaStringIdentificador da condicao pagamento operadora na retaguardaObrigatório
condicoesPagtoOperadoras.idRetaguardaCondicaoPagtoStringIdeintificador da condição pagamento na retaguardaObrigatório
condicoesPagtoOperadoras.idRetaguardaOperadoraStringIdentificador da operadora na retaguardaObrigatório
Tipo do dado complementar (Descritivo abaixo)Obrigatório
obrigatorioIntIndica se o dado é obrigatório (0 - Opcional, 1 - Obrigatório)Obrigatório
tamanhoIntTamanho do dado complementarOpcional
situacaoIntSituação do dado complementar condicoesPagtoOperadoras.situacaoIntSituação da operadora (0 - Inativo, 1 - Ativo)

Opcional

Caso não enviado será cadastrado como 0

condicoesPagtoOperadoras.idCondicaoPagamentoIntIdentificador da Forma de pagametno Condição pagamento no POSHOpcional
Obrigatório
idInquilinoStringIdentificador do inquilinoObrigatório
idRetaguardaStringIdentificador da condição de pagamento do dado complementar na retaguardaObrigatório
idProprietarioStringIdentificador do proprietárioObrigatório
loteOrigemStringIdentificador do lote em que os dados serão enviadosObrigatório para a integração
Expandir
titleTipoDadoComplementar
CódigoTipo
0Alfanumerico
1Numerico
2Data
3ListaSelecao
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