title | Exemplo de body da requisição[ { "condicoesPagtoOperadoras": [ { "id": 0, "idCondicaoPagamento": 0, "idRetaguarda": "string", "idRetaguardaCondicaoPagto": "string", "idRetaguardaOperadora": "string", "situacao": 0 } ], "dadoComplementarDescricao": "string", "descricao": "string", "diasEntreParcelas": 0, "idInquilino": "string", "idProprietario": "string", "idRetaguarda": "string", "loteOrigem": "string", "numeroMaximoParcelas": 0, "percentualMinimoEntrada": 0, "prazoMaximoPrimeiraParcela": 0, "situacao": 0, "solicitaDataDemaisParcelas": 0, "solicitaDataPrimeiraParcela": 0, "tipoDadoComplementar": 0 } ] |
Column |
---|
| Definições dos campos do bodyCampo | Tipo | Descrição | Obrigatório | Observações |
---|
descricao | String | Desccriçã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 pagametno Condição pagamento no POSH | Não |
| condicoesPagtoOperadoras.idRetaguarda | String | Identificador da condicao pagamento operadora na retaguarda | Sim | Tamanho máximo: 100 caracteres | condicoesPagtoOperadoras.idRetaguardaCondicaoPagto | String | Ideintificador 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 | dadoComplementarDescricao | String | Descrição dado complementar | Não | Tamanho máximo: 30 caracteres | diasEntreParcelas | Int | Dias entre as parcelas | Sim |
| 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 | loteOrigem | String | Identificador do lote em que os dados serão enviados | Sim |
| numeroMaximoParcelas | Int | Número máximo de parcelas | Sim |
| percentualMinimoEntrada | Int | Percentual mínimo de entrada | Não |
| prazoMaximoPrimeiraParcela | Int | Prazo máximo da primeira parcela | Não |
Caso não enviado será cadastrado como 0 | 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 | tipoDadoComplementar | Int | Tipo do dado complementar | Não |
|
|
|
Retorno Deck of Cards |
---|
| Card |
---|
| Column |
---|
| Exemplo de body de retorno{ "success": true, "message": "Requisição inserida com sucesso!", "data": null, "errors": null, "totalTime": 0, " |
|
|
| tipoDadoComplementar": 0, "dadoComplementarDescricao Column |
---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
---|
Success | bool | Indica se a criação do compartilhamento foi feita com sucesso | Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | Data | objeto | Objeto compartilhamento criado | Errors | Lista | Listas com os erros encontrados no processo | TotalTime | int | tempo da requisição | NumberOfRecords | int | número de dados inseridos |
|
|
Card |
---|
| Column |
---|
| Exemplo de body de retorno{ "code": "string", "message": "string", "detailedMessage": "string", "helpUrl": "string", "details": [ { "guid": "string", "code": "string", "message": "string", "detailedMessage": "string" } ] } |
Column |
---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
---|
code | string | Código de erro | message | string | Mensagem do erro | detailedMessage | string | Detalhamento do erro | helpUrl | string | url de ajuda | TotalTime | string | Tempo total de busca | details | lista de objeto | Lista de objeto de erros | details.guid | string | Identificador do erro | details.code | string | Código do erro | details.message | string | Mensagem do erro | details.detailedMessage | string | Detalhamento do erro |
|
|
|
|
Card |
---|
| Informações |
---|
Este endpoint ainda está em processo de manutenção, as informações estão disponibilizadas apenas para consulta, não sendo possível realizar a requisição. |
Requisição Section |
---|
Column |
---|
| Exemplo de body da requisição[ { "condicoesPagtoOperadoras": [ { " |
|
| ididCondicaoPagamento": 0, "idRetaguarda": "string", "idRetaguardaCondicaoPagto": "string", "idRetaguardaOperadora": "string", "situacao": 0 } ], "dadoComplementarDescricao": "string", "descricao": "string", "diaFixoPagamento": 0, " |
|
| idCondicaoPagamentodiasCarenciaPrimeiroVencimento": 0, |
|
| } ],
"diasEntreParcelas": 0, "fixaNumeroParcela": 0, "idInquilino": "string", " |
|
| idRetaguardaidProprietario": "string", " |
|
| idProprietarioidRetaguarda": "string", "loteOrigem": "string", "numeroMaximoParcelas": 0, "percentualMinimoEntrada": 0, "prazoMaximoPrimeiraParcela": 0, "quantidadeParcelas": 0, "situacao": 0, "solicitaDataDemaisParcelas": 0, "solicitaDataPrimeiraParcela": 0, "tipoDadoComplementar": 0, "tipoVencimentoParcelamento": 0, "valorMinimoParcela": 0 } ] |
|
|
|