Este método é responsável pela criação de novos FormaPagtoDados complementares de pagamento
- 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 = CondicaoPagto16 = DadoComplementarPagto |
Deck of Cards |
---|
|
|
Expandir |
---|
title | Exemplo de body da requisição[ { "descricao": "string", " |
|
| diasEntreParcelas 0numeroMaximoParcelas 0percentualMinimoEntrada 0prazoMaximoPrimeiraParcela 0solicitaDataDemaisParcelassolicitaDataPrimeiraParcelasituacaotamanho": 0, "tipoDadoComplementar": 0 } ] |
Column |
---|
| Definições dos campos do bodyCampo | Tipo | Descrição | Obrigatório | Observações |
---|
descricao | String | Descrição do dado complementar | Sim | Tamanho máximo: 30 caracteres | idInquilino | String | Identificador do inquilino | Sim |
| idProprietario | String | Identificador do proprietário | Sim |
| idRetaguarda | String | Identificador do dado complementar na retaguarda | Sim | Tamanho máximo: 100 caracteres | loteOrigem | String | Identificador do lote em que os dados serão enviados | Sim |
| obrigatorio | Int | Indica se o dado é obrigatório | Sim | 0 - Opcional, 1 - Obrigatório | situacao | Int | Situação do dado complementar | Sim | 0 - Inativo, 1 - Ativo | tamanho | Int | Tamanho do dado complementar | Não |
| tipoDadoComplementar | Int | Tipo do dado complementar | Sim | Código | Tipo |
---|
0 | Alfanumerico | 1 | Numerico | 2 | Data | 3 | ListaSelecao |
|
|
|
Retorno Deck of Cards |
---|
| Card |
---|
| Column |
---|
| Exemplo de body de retorno{ "success": true, " |
|
|
| dadoComplementarDescricaostringRequisição inserida com sucesso!", " |
|
|
| condicoesPagtoOperadoras [ { idtotalTime": 0, "numberOfRecords": 0 } |
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{ " |
|
|
| idRetaguarda idRetaguardaCondicaoPagto idRetaguardaOperadoradetailedMessage": "string",
|
|
|
| situacao 0 idCondicaoPagamento 0 } ], idInquilinoidRetaguardaidProprietarioloteOrigemdetailedMessage": "string" } ] } |
|
|
|
|
expand | title | Definição | de requisiçãoObservações |
descricao | String | Desccrição da condição de pagamento | Obrigatório Tamanho máximo: 50 caracteres |
diasEntreParcelas | Int | Dias entre as parcelas | Obrigatório |
numeroMaximoParcelas | Int | Número máximo de parcelas | Obrigatório |
percentualMinimoEntrada | Int | Percentual mínimo de entrada | Opcional |
prazoMaximoPrimeiraParcela | Int | Prazo máximo da primeira parcela | Opcional Caso não enviado será cadastrado como 0 |
solicitaDataDemaisParcelas | Int | Indica se solicita a data das demais parcelas | Aceito 0 ou 1 Caso não enviado será cadastrado como 0 |
solicitaDataPrimeiraParcela | Int | Indica se solicita a data da primeira parcela | Aceito 0 ou 1 Caso não enviado será cadastrado como 0 |
situacao | Int | Situação da condição de pagamento (0 - Inativo, 1 - Ativo) | Obrigatório |
tipoDadoComplementar | Int | Tipo do dado complementar | Opcional |
dadoComplementarDescricao | String | Descrição dado complementar | Opcional |
condicoesPagtoOperadoras | Lista de Objetos | Lista de operadores | Opcional |
condicoesPagtoOperadoras.id | Int | Identificador da operadora no POSH | Opcional |
condicoesPagtoOperadoras.idRetaguarda | String | Identificador da condicao pagamento operadora na retaguarda | Obrigatório |
condicoesPagtoOperadoras.idRetaguardaCondicaoPagto | String | Ideintificador da condição pagamento na retaguarda | Obrigatório |
condicoesPagtoOperadoras.idRetaguardaOperadora | String | Identificador da operadora na retaguarda | Obrigatório |
condicoesPagtoOperadoras.situacao | Int | Situação da operadora (0 - Inativo, 1 - Ativo) | Opcional Caso não enviado será cadastrado como 0 |
condicoesPagtoOperadoras.idCondicaoPagamento | Int | Identificador da Forma de pagametno Condição pagamento no POSH | Opcional |
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[ { "descricao": "string", "idInquilino": "string", "idProprietario": "string", "idRetaguarda": "string", "loteOrigem": "string", "obrigatorio": 0, "situacao": 0, "tamanho": 0, "tipoDadoComplementar": 0 } ] |
Column |
---|
| Definições dos campos do bodyCampo | Tipo | Descrição | Obrigatório | Observações |
---|
descricao | String | Descrição do dado complementar | Não | Tamanho máximo: 30 caracteres | tipoDadoComplementar | Int | Tipo do dado complementar | Não | Código | Tipo |
---|
0 | Alfanumerico | 1 | Numerico | 2 | Data | 3 | ListaSelecao |
| obrigatorio | Int | Indica se o dado é obrigatório | Sim | 0 - Opcional, 1 - Obrigatório | tamanho | Int | Tamanho do dado complementar | Não |
| situacao | Int | Situação do dado complementar | Sim | 0 - Inativo, 1 - Ativo | idInquilino | String | Identificador do inquilino |
|
|
|
ObrigatórioSim |
| idRetaguarda | String | Identificador |
|
|
|
da condição de pagamento do dado complementar na retaguarda |
|
|
|
ObrigatórioSim |
| idProprietario | String | Identificador do proprietário |
|
|
|
ObrigatórioSim |
| loteOrigem | String | Identificador do lote em que os dados serão enviados |
|
|
|
Obrigatório para a integração | Expandir |
---|
title | Definição dos campos de retorno |
---|
|
Retornos Deck of Cards |
---|
| Card |
---|
| Column |
---|
| Exemplo de body de retorno{ "success": true, "message": "Requisição inserida com sucesso!", "data": null, "errors": null, "totalTime": 0, "numberOfRecords": 0 } |
Column |
---|
| Definições dos campos do retorno |
|
|
| Expandir |
---|
title | 200 - OkCampo | 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 |
|
|
|
| expand | title | 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 |
|
|
|
|
|