Este método é responsável pela criação de novas Condições de pagamento
- Endpoints:
- V2
- /api/retaguarda/v2/condicaopagtos
- V3.1
- /api/retaguarda/v3/condicaopagtos
- V3.2
- /api/retaguarda/v3/dadosdinamicos/down/17/2
- V2
- Método: Post
- Autenticação: Bearer token
- Permissão: Retaguarda
Este endpoint recebe uma lista de CondicaoPagto para que possam ser enviados vários na mesma requisição
Para que a baixa do CondicaoPagto criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 17 = CondicaoPagto
Requisição
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",
"indicePreco": "string",
"loteOrigem": "string",
"numeroMaximoParcelas": 0,
"percentualMinimoEntrada": 0,
"prazoMaximoPrimeiraParcela": 0,
"situacao": 0,
"solicitaDataDemaisParcelas": 0,
"solicitaDataPrimeiraParcela": 0,
"taxa":0.0
"tipoDadoComplementar": 0
}
]
Definições dos campos do body
Campo |
Tipo |
Descrição |
Obrigatório |
Observações |
|---|---|---|---|---|
descricao |
String |
Descriçã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 pagamento Condição pagamento no POSH | Não | |
| condicoesPagtoOperadoras.idRetaguarda | String | Identificador da condição pagamento operadora na retaguarda | Sim | Tamanho máximo: 100 caracteres |
| condicoesPagtoOperadoras.idRetaguardaCondicaoPagto | String | Identificador 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 |
| indicePreco | String | Indice Preco | Não | 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 |
| taxa | Decimal | Taxa | Não |
|
| tipoDadoComplementar | Int | Tipo do dado complementar | Não |
Retorno
Exemplo de body de retorno
{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}
Definições dos campos do retorno
Campo |
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 |
Exemplo de body de retorno
{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
}
Definições dos campos do retorno
Campo |
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 |
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
Exemplo de body da requisição
[
{
"condicoesPagtoOperadoras": [
{
"idCondicaoPagamento": 0,
"idRetaguarda": "string",
"idRetaguardaCondicaoPagto": "string",
"idRetaguardaOperadora": "string",
"situacao": 0
}
],
"dadoComplementarDescricao": "string",
"descricao": "string",
"diaFixoPagamento": 0,
"diasCarenciaPrimeiroVencimento": 0,
"diasEntreParcelas": 0,
"fixaNumeroParcela": 0,
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"indicePreco": "string",
"loteOrigem": "string",
"numeroMaximoParcelas": 0,
"percentualMinimoEntrada": 0,
"prazoMaximoPrimeiraParcela": 0,
"quantidadeParcelas": 0,
"situacao": 0,
"solicitaDataDemaisParcelas": 0,
"solicitaDataPrimeiraParcela": 0,
"taxa":0.0
"tipoDadoComplementar": 0,
"tipoVencimentoParcelamento": 0,
"valorMinimoParcela": 0
}
]
Definições dos campos do body
Campo |
Tipo |
Descrição |
Obrigatório |
Observações |
||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| descricao | String | Descrição da condição de pagamento | Sim |
Tamanho máximo: 50 caracteres |
||||||||||
| diasEntreParcelas | Int | Dias entre as parcelas | Não | |||||||||||
| numeroMaximoParcelas | Int | Número máximo de parcelas | Não | |||||||||||
| 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 |
||||||||||
| solicitaDataDemaisParcelas | Int | Indica se solicita a data das demais parcelas | Não |
Caso não enviado será cadastrado como 0 |
||||||||||
| solicitaDataPrimeiraParcela | Int | Indica se solicita a data 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 |
||||||||||
| tipoDadoComplementar | Int | Tipo do dado complementar | Não |
|||||||||||
| dadoComplementarDescricao | String | Descrição dado complementar | Não | Tamanho máximo: 30 caracteres | ||||||||||
| condicoesPagtoOperadoras | Lista de Objetos | Lista de operadores | Não | |||||||||||
| condicoesPagtoOperadoras.id | Int | Identificador da operadora no POSH | Não | |||||||||||
| condicoesPagtoOperadoras.idRetaguarda | String | Identificador da condição pagamento operadora na retaguarda | Sim | |||||||||||
| condicoesPagtoOperadoras.idRetaguardaCondicaoPagto | String | Identificador da condição pagamento na retaguarda | Sim | |||||||||||
| condicoesPagtoOperadoras.idRetaguardaOperadora | String | Identificador da operadora na retaguarda | Sim | |||||||||||
| condicoesPagtoOperadoras.situacao | Int | Situação da operadora (0 - Inativo, 1 - Ativo) | Não |
Caso não enviado será cadastrado como 0 |
||||||||||
| condicoesPagtoOperadoras.idCondicaoPagamento | Int | Identificador da Forma de pagamento Condição pagamento no POSH | Não | |||||||||||
| idInquilino | String | Identificador do inquilino | Sim | |||||||||||
| idRetaguarda | String | Identificador da condição de pagamento na retaguarda | Sim | Tamanho máximo: 100 caracteres | ||||||||||
| idProprietario | String | Identificador do proprietário | Sim | |||||||||||
| indicePreco | String | Indice | Não | Tamanho máximo: 100 caracteres | ||||||||||
| loteOrigem | String | Identificador do lote em que os dados serão enviados | Sim | |||||||||||
| diaFixoPagamento | Int | Não | ||||||||||||
| diasCarenciaPrimeiroVencimento | Int | Não | ||||||||||||
| fixaNumeroparcelas | Int | Não | ||||||||||||
| quatidadeParcelas | Int | Não | ||||||||||||
| tipoVencimentoParcelamento | Int | Não |
|
|||||||||||
| taxa | Decimal | Taxa | Não | |||||||||||
| valorMinimoParcela | Int | Sim |
Retornos
Exemplo de body de retorno
{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}
Definições dos campos do retorno
Campo |
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 |
Exemplo de body de retorno
{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
}
Definições dos campos do retorno
Campo |
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 |
O Dado dinâmico é uma nova forma para envio de dados entre PDV e Retaguarda.
Para o envio de condição de pagamento pelo Dado dinâmico, realizar um requisição o seguinte endpoint
- Endpoint: /api/retaguarda/v3/dadosdinamicos/down/17/{Versão Dado}
- Método: Post
- Autenticação: Bearer token
- Permissão: Retaguarda
Versão dado
| Versão requisição | Versão dado |
|---|---|
| V3.1 | 1 |
| V3.2 | 2 |
A propriedade {Versão Dado}, enviado na URL da requisição, deve ser substituído pela versão do dado que será enviado.
O body da requisição é o mesmo enviado no endpoint padrão. Consulte as outras abas dessa seção para ver o que deve ser enviado na requisição de acordo com a versão dado enviado na URL.
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas