POST api/retaguarda/v2/FormaPagtos

Este método é responsável pela criação de novos FormaPagto

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

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

Para que a baixa do FormaPagto criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 18 = FormaPagto

Exemplo de body da requisição

[
{
"descricao": "string",
"descricaoFiscal": "string",
"permiteTroco": 0,
"idRetaguardaFormaPagTroco": "string",
"valorMinimoAceito": "string",
"codigoSistemaExterno": "string",
"situacao": 0,
"codigoModalidadePagamento": 0,
"tipo": 0,
"tipoCliente": 0,
"formasPagtoCondicoes": [
{
"idRetaguarda": "string",
"idRetaguardaFormaPagto": "string",
"idRetaguardaCondicaoPagto": "string",
"situacao": 0
}
],
"formasPagtoDadosComplementares": [
{
"idRetaguarda": "string",
"idRetaguardaFormaPagto": "string",
"idRetaguardaDadoComplementarPagto": "string",
"situacao": 0,
"ordem": 0
}
],
"formasPagtoOperadoras": [
{
"idRetaguarda": "string",
"idRetaguardaFormaPagto": "string",
"idRetaguardaOperadoraPagto": "string",
"situacao": 0
}
],
"formaPagtoModeloFiscal": [
{
"idRetaguarda": "string",
"idRetaguardaFormaPagto": "string",
"modeloFiscal": "string",
"codigoFiscal": "string",
"descricaoFiscal": "string",
"situacao": 0
}
],
"idInquilino": "string",
"idRetaguarda": "string",
"idProprietario": "string",
"loteOrigem": "string"
}
]

Definição dos campos de requisição

Campo	Tipo	Descrição	Observações
descricao	string	Descrição da forma de pagamento	Obrigatório Tamanho Máximo: 50 caracteres
descricaoFiscal	string	Descrição fiscal da forma de pagamento	Obrigatório Tamanho Máximo: 50 caracteres
permiteTroco	Int	Indica se a forma de pagamento permite troco (0 - Não; 1 - Sim)	Obrigatório
idRetaguardaFormaPagTroco	string	Identificador da forma de pagamento troco na retaguarda	Obrigatório Tamanho Máximo: 100 caracteres
valorMinimoAceito	string	Valor mínimo aceita para a forma de pagamento	Opcional
codigoSistemaExterno	string	Código Sistema Externo	Obrigatório Tamanho Máximo: 50 caracteres
situacao	integer	Situação da forma de pagamento (0 - Inativo, 1 - Ativo)	Caso não enviado será cadastrado como 0
codigoModalidadePagamento	integer	Código da modalidade de pagamento	Opcional
tipo	integer	Tipo da forma de pagamento (Descrição abaixo)	Obrigatório
tipoCliente	integer	Tipo cliente	Opcional
formasPagtoCondicoes	Lista de objetos	Lista de condições de forma de pagamento	Opcional
formasPagtoCondicoes.idRetaguarda	string	Identificador da condição na retaguarda	Opcional
formasPagtoCondicoes.idRetaguardaFormaPagto	string	Identificador da forma de pagamento na retaguarda	Opcional
formasPagtoCondicoes.idRetaguardaCondicaoPagto	string	Identificador da condição de pagamento na retaguarda	Opcional
formasPagtoCondicoes.situacao	integer	Situação da condição de pagamento (0 - Inativo, 1 - Ativo)	Opcional
formasPagtoDadosComplementares	Lista de objetos	Lista de Dados complementares da forma de pagamento	Opcional
formasPagtoDadosComplementares.idRetaguarda	string	Identificador do dado complementar na reguardar	Opcional
formasPagtoDadosComplementares.idRetaguardaFormaPagto	string	Identificador da forma de pagamento na retaguarda	Opcional
formasPagtoDadosComplementares.idRetaguardaDadoComplementarPagto	string	Identificador do dado complementar pagamento na retaguarda	Opcional
formasPagtoDadosComplementares.situacao	integer	Situação do dado complementar (0 - Inativo, 1 - Ativo)	Opcional
formasPagtoDadosComplementares.ordem	integer	Ordem do dado complementar	Opcional
formasPagtoOperadoras	Lista de objetos	Lista de operadoras da forma de pagamento	Opcional
formasPagtoOperadoras.idRetaguarda	string	Identificador da operadora na retaguarda	Opcional
formasPagtoOperadoras.idRetaguardaFormaPagto	string	Identificador da forma de pagamento na retaguarda	Opcional
formasPagtoOperadoras.idRetaguardaOperadoraPagto	string	Identificador da Operadora pagamento na retaguarda	Opcional
formasPagtoOperadoras.situacao	integer	Situação da operadora (0 - Inativo, 1 - Ativo)	Opcional
formaPagtoModeloFiscal	Lista de objetos	Lista de modelos fiscais	Opcional
formaPagtoModeloFiscal.idRetaguarda	string	Identificador do modelo na retaguarda	Opcional
formaPagtoModeloFiscal.idRetaguardaFormaPagto	string	Identificador da forma de pagamento na retaguarda	Opcional
formaPagtoModeloFiscal.modeloFiscal	string	Modelo fiscal	Opcional
formaPagtoModeloFiscal.codigoFiscal	string	Código fiscal	Opcional
formaPagtoModeloFiscal.descricaoFiscal	string	Descrição fiscal	Opcional
formaPagtoModeloFiscal.situacao	integer	Situação do modelo fiscal (0 - Inativo, 1 - Ativo)	Opcional
idInquilino	string	Identificador do inquilino	Obrigatório
idRetaguarda	string	Identificador da forma de pagamento na retaguarda	Obrigatório
idProprietario	string	Identificador do proprietário	Obrigatório
loteOrigem	string	Identificador do lote	Obrigatório para a integração

TipoFormaPagto

Código	Tipo
0	Outros
1	Dinheiro
2	Credito
3	Debito
4	Cheque
5	POS
6	Troca
8	Gift
10	QRCode

Definição dos campos de retorno

200 - Ok

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

Body de retorno

{
"success": true,
"message": "",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

400 - Bad Request

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

Atalhos

Árvore de páginas