Á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

...

Expandir
titleExemplo de body da requisição

[
    {
        "descricaocondicoesPagtoOperadoras": "string",
    "diasEntreParcelas[
            {
                "idCondicaoPagamento": 0,
                "numeroMaximoParcelasidRetaguarda": 0"string",
                "percentualMinimoEntradaidRetaguardaCondicaoPagto": 0"string",
                "prazoMaximoPrimeiraParcelaidRetaguardaOperadora": 0"string",
                "solicitaDataDemaisParcelassituacao": 0
            }
        ],
        "solicitaDataPrimeiraParceladadoComplementarDescricao": 0"string",
        "situacaodescricao": 0"string",
        "tipoDadoComplementardiaFixoPagamento": 0,
        "dadoComplementarDescricaodiasCarenciaPrimeiroVencimento": "string"0,
        "condicoesPagtoOperadorasdiasEntreParcelas": [0,
      {  "fixaNumeroParcela": 0,
        "ididInquilino": 0"string",
        "idRetaguardaidProprietario": "string",
        "idRetaguardaCondicaoPagtoidRetaguarda": "string",
        "idRetaguardaOperadoraloteOrigem": "string",
        "situacaonumeroMaximoParcelas": 0,
        "idCondicaoPagamentopercentualMinimoEntrada": 0,
      }  "prazoMaximoPrimeiraParcela": 0,
    ]    "quantidadeParcelas": 0,
        "idInquilinosituacao": "string"0,
        "solicitaDataDemaisParcelas": 0,
        "idRetaguardasolicitaDataPrimeiraParcela": "string"0,
        "tipoDadoComplementar": 0,
        "idProprietariotipoVencimentoParcelamento": "string"0,
        "loteOrigemvalorMinimoParcela": "string"0
    }
]

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

Campo

Tipo

Descrição

Observações

Obrigatório

descricaoStringDesccrição da condição de pagamento

Obrigatório

Tamanho máximo: 50 caracteres

Sim

diasEntreParcelasIntDias entre as parcelas
Obrigatório

Não
numeroMaximoParcelasIntNúmero máximo de parcelas
Obrigatório

Não
percentualMinimoEntradaIntPercentual mínimo de entrada
Opcional

Não
prazoMaximoPrimeiraParcelaIntPrazo máximo da primeira parcela

Opcional

Caso não enviado será cadastrado como 0

Não

solicitaDataDemaisParcelasIntIndica se solicita a data das demais parcelas
Aceito 0 ou 1

Caso não enviado será cadastrado como 0

Não

solicitaDataPrimeiraParcelaIntIndica se solicita a data da primeira parcela
Aceito 0 ou 1

Caso não enviado será cadastrado como 0

Não

situacaoIntSituação da condição de pagamento
(

0 - Inativo, 1 - Ativo

)

Obrigatório

Sim

tipoDadoComplementarIntTipo do dado complementar
Opcional

Não

dadoComplementarDescricaoStringDescrição dado complementar
Opcional
Tamanho máximo: 30 caracteresNão
condicoesPagtoOperadorasLista de ObjetosLista de operadores
Opcional

Não
condicoesPagtoOperadoras.idIntIdentificador da operadora no POSH
Opcional

Não
condicoesPagtoOperadoras.idRetaguardaStringIdentificador da condicao pagamento operadora na retaguarda
Obrigatório

Sim
condicoesPagtoOperadoras.idRetaguardaCondicaoPagtoStringIdeintificador da condição pagamento na retaguarda
Obrigatório

Sim
condicoesPagtoOperadoras.idRetaguardaOperadoraStringIdentificador da operadora na retaguarda
Obrigatório

Sim
condicoesPagtoOperadoras.situacaoIntSituação da operadora (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
Opcional

Não
idInquilinoStringIdentificador do inquilino
Obrigatório

Sim
idRetaguardaStringIdentificador da condição de pagamento na retaguarda
Obrigatório

Sim
idProprietarioStringIdentificador do proprietário
Obrigatório

Sim
loteOrigemStringIdentificador do lote em que os dados serão enviados
Obrigatório para a integração

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