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

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

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

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

titleexpandtitleDefinição de requisição

Deck of Cards

id	versções

Card

label	V3.1 (V2)

Requisição

Section

Column

width	50%

Expandir

Exemplo de body da requisição

[
{
"

descricao

codigoModalidadePagamento":

"string"

0,
"

unidadeMedida

codigoSistemaExterno": "string",
"

descontoMaximo

descricao": "string",
"

arredondaTrunca": 0,
"codigoProduto"

descricaoFiscal": "string",
"

codigoAlternativo

formaPagtoModeloFiscal":

"string",

[

"origemProduto": 0,

{

"situacao": 0,

"

imagem

codigoFiscal": "string

",

"

tipoProduto": 0

,

"fracionado": true,

"

cnpjFornecedor

descricaoFiscal": "string",

"escalaRelevante": true,

"

cstIcms

idRetaguarda": "string",
"

percentualReducaoIcms

idRetaguardaFormaPagto": "string",

"aliquotaIcms": "string",

"

vlicmsret

modeloFiscal": "string",

"cest": "string",

"

encomenda

situacao":

true,

0

"pesoLiquido": 0,

}

"pesoBruto": 0

],
"

associacaoProdutosClassificacao

formasPagtoCondicoes": [
{
"idRetaguarda": "string",
"

idRetaguardaProduto

idRetaguardaCondicaoPagto": "string",
"

idRetaguardaClassificacaoProduto

idRetaguardaFormaPagto": "string

",
"ordem

"

: 0

,
"situacao": 0
}
],
"

produtoEmbalagens

formasPagtoDadosComplementares": [
{
"

codigoBarras

idRetaguarda": "string",
"

descricao

idRetaguardaDadoComplementarPagto": "string",
"

idProdutoRetaguarda

idRetaguardaFormaPagto": "string",
"

idRetaguarda

ordem":

"string"

0,
"

pesoBruto

situacao": 0

,

}
],
"

pesoLiquido

formasPagtoOperadoras":

0,

[

"quantidade": 0,

{
"

situacao

idRetaguarda":

0

"string",
"

unidadeMedida

idRetaguardaFormaPagto": "string",

}

"idRetaguardaOperadoraPagto": "string",

],

"

produtoKits

situacao":

[

0

{

}
],
"

idRetaguardaProduto

idInquilino": "string",
"idProprietario": "string",
"

idRetaguardaProdutoKit

idRetaguarda": "string",
"idRetaguardaFormaPagTroco": "string",
"

descricao

loteOrigem": "string",
"permiteTroco": 0,
"

quantidadeVendaKit

situacao": 0,
"tipo": 0,
"

tipoValorKit

tipoCliente": 0,
"valorMinimoAceito": "string"

"situacao": 0,
"valorDesconto": "string",
"novoValorUnitario": "string"
}
],
"produtosSimilares

}
]

Column

width	50%

Definições dos campos do body

Campo

Tipo

Descrição

Obrigatório

Observações

descricao

string

Descrição da forma de pagamento

Sim

Tamanho Máximo: 50 caracteres

codigoModalidadePagamento

integer

Código da modalidade de pagamento

Não

codigoSistemaExterno

string

Código Sistema Externo

Sim

Tamanho Máximo: 50 caracteres

descricaoFiscal

string

Descrição fiscal da forma de pagamento

Sim

Tamanho Máximo: 50 caracteres

formaPagtoModeloFiscal

Lista de objetos

Lista de modelos fiscais

Não

formaPagtoModeloFiscal.codigoFiscal

string

Código fiscal

Não

formaPagtoModeloFiscal.descricaoFiscal

string

Descrição fiscal

Não

formaPagtoModeloFiscal.idRetaguarda

string

Identificador do modelo na retaguarda

Não

formaPagtoModeloFiscal.idRetaguardaFormaPagto

string

Identificador da forma de pagamento na retaguarda

Não

formaPagtoModeloFiscal.modeloFiscal

string

Modelo fiscal

Não

formaPagtoModeloFiscal.situacao

integer

Situação do modelo fiscal

Não

0 - Inativo, 1 - Ativo

formasPagtoCondicoes

Lista de objetos

Lista de condições de forma de pagamento

Não

formasPagtoCondicoes.idRetaguarda

string

Identificador da condição na retaguarda

Não

formasPagtoCondicoes.idRetaguardaCondicaoPagto

string

Identificador da condição de pagamento na retaguarda

Não

formasPagtoCondicoes.idRetaguardaFormaPagto

string

Identificador da forma de pagamento na retaguarda

Não

formasPagtoCondicoes.situacao

integer

Situação da condição de pagamento (0 - Inativo, 1 - Ativo)

Não

formasPagtoDadosComplementares

Lista de objetos

Lista de Dados complementares da forma de pagamento

Não

formasPagtoDadosComplementares.idRetaguarda

string

Identificador do dado complementar na reguardar

Não

formasPagtoDadosComplementares.idRetaguardaDadoComplementarPagto

string

Identificador do dado complementar pagamento na retaguarda

Não

formasPagtoDadosComplementares.idRetaguardaFormaPagto

string

Identificador da forma de pagamento na retaguarda

Não

formasPagtoDadosComplementares.ordem

integer

Ordem do dado complementar

Não

formasPagtoDadosComplementares.situacao

integer

Situação do dado complementar (0 - Inativo, 1 - Ativo)

Não

formasPagtoOperadoras

Lista de objetos

Lista de operadoras da forma de pagamento

Não

formasPagtoOperadoras.idRetaguarda

string

Identificador da operadora na retaguarda

Não

formasPagtoOperadoras.idRetaguardaFormaPagto

string

Identificador da forma de pagamento na retaguarda

Não

formasPagtoOperadoras.idRetaguardaOperadoraPagto

string

Identificador da Operadora pagamento na retaguarda

Não

formasPagtoOperadoras.situacao

integer

Situação da operadora (0 - Inativo, 1 - Ativo)

Não

idInquilino

string

Identificador do inquilino

Sim

idProprietario

string

Identificador do proprietário

Sim

idRetaguarda

string

Identificador da forma de pagamento na retaguarda

Sim

idRetaguardaFormaPagTroco

string

Identificador da forma de pagamento troco na retaguarda

Sim

Tamanho Máximo: 100 caracteres

loteOrigem

string

Identificador do lote

Sim

permiteTroco

Int

Indica se a forma de pagamento permite troco (0 - Não; 1 - Sim)

Sim

situacao

integer

Situação da forma de pagamento (0 - Inativo, 1 - Ativo)

Não

Caso não enviado será cadastrado como 0

tipo

integer

Tipo da forma de pagamento

Sim

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

tipoCliente

integer

Tipo cliente

Não

valorMinimoAceito

string

Valor mínimo aceita para a forma de pagamento

Não

Retorno

Deck of Cards

id	retornos

Card

label	200 - Ok

Column

width	50%

Exemplo de body de retorno

{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

Column

width	50%

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

Card

label	400 - Bad Request

Column

width	50%

Exemplo de body de retorno

{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [

{

"

idRetaguardaProduto

guid": "string",

"

idRetaguardaSimilar

code": "string",

"

situacao

message":

0

"string",

}

"detailedMessage": "string"
}
]
}

Column

width	50%

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

Card

label	V3.2

Informações
Este endpoint ainda está em processo de manutenção, as informações estão disponibilizadas apenas para consulta,

"produtosSugestoes":

não sendo possível realizar a requisição.

Requisição

Section

Column

width	50%

Exemplo de body da requisição

[

{
"codigoModalidadePagamento": 0,
"

idRetaguardaProduto

codigoSistemaExterno": "string",

"

idRetaguardaSugestao

descricao": "string",

"

situacao": 0
}
]

descricaoFiscal": "string",
"

codigosProduto

formaPagtoModeloFiscal": [
{
"

codigo

codigoFiscal": "string",
"

descricao

descricaoFiscal": "string",
"idRetaguarda": "string",
"

dataAtualizacao

idRetaguardaFormaPagto": "

2024-03-28T13:13:11.127Z

string",
"

dataCadastro

modeloFiscal": "

2024-03-28T13:13:11.127Z

string",
"situacao": 0
}
],
"

impostos

formasPagtoCondicoes": [
{
"idRetaguarda": "string",
"idRetaguardaCondicaoPagto": "string",
"

idProprietario

idRetaguardaFormaPagto": "string",
"situacao": 0
}
],
"

ncms

formasPagtoDadosComplementares": [
{
"idRetaguarda": "string",
"

idProprietario

idRetaguardaDadoComplementarPagto": "string"

}

,

],

"

pisCofins

idRetaguardaFormaPagto":

[
{

"string",
"

idRetaguarda

ordem":

"string"

0,
"

idProprietario

situacao":

"string"

0
}
],
"

fcps

formasPagtoOperadoras": [
{
"

valorBaseFcp

idRetaguarda": "string",
"

percentualFcp

idRetaguardaFormaPagto": "string",
"

codigoBeneficioFiscal

idRetaguardaOperadoraPagto": "string",
"

motivoDesoneracaoIcms

situacao": 0

,

}
],
"

descontaDesoneracaoNf

idInquilino":

true

"string",
"idProprietario": "string",
"

idProprietario

idRetaguarda": "string",

}

"idRetaguardaFormaPagTroco": "string",

]

"loteOrigem": "string",
"

quantidadeMovimentacao

permiteTroco": 0,
"

idInquilino

situacao":

"string"

0,
"

idRetaguarda

tipo":

"string"

0,
"

idProprietario

tipoCliente":

"string"

0,
"

loteOrigem

valorMinimoAceito": "string"
}
]

Column

width

50%

Definições dos campos

Expandir

title	200 - Ok

do body

Campo	Tipo	Descrição	Observações	Obrigatório
descricao	string	Descrição

do produto

unidadeMedida

string

Unidade de medida do produto

descontoMaximo

string

Desconto máximo aplicado ao produto

arredondaTrunca

int

codigoProduto

string

Código do produto

codigoAlternativo

string

Código alternativo do produto

origemProduto

int

Origem do produto

situacao

int

Situação do produto (0 - Inativo, 1 - Ativo)

imagem

string

URL com a imagem do produto

tipoProduto

int

fracionado

boolean

Indica se o produto é vendido fracionado

cnpjFornecedor

string

CNPJ do fornecedor do produto

escalaRelevante

boolean

cstIcms

string

CST ICMS do produto

percentualReducaoIcms

string

Percentual de redução ICMS

aliquotaIcms

string

Aliquota ICMS

vlicmsret

string

cest

string

encomenda

boolean

Indica se o produto é uma encomenda

pesoLiquido

float

Peso liquido do produto

pesoBruto

float

Peso bruto do produto

associacaoProdutosClassificacao

Lista de objetos

Lista de classificação do produto

associacaoProdutosClassificacao.idRetaguarda

string

Identificador da classificação na retaguarda

associacaoProdutosClassificacao.idRetaguardaProduto

string

Identificador do produto na retaguarda

associacaoProdutosClassificacao.idRetaguardaClassificacaoProduto

string

associacaoProdutosClassificacao.ordem

int

associacaoProdutosClassificacao.situacao

int

produtoEmbalagens

lista de objetos

Lista de embalagens do produto

produtoEmbalagens.codigoBarras

string

Código de barras da embalagem

produtoEmbalagens.descricao

string

Descrição da embalagem

produtoEmbalagens.idProdutoRetaguarda

string

Identificador do produto na retaguarda

produtoEmbalagens.idRetaguarda

string

Identificador da embalagem na retaguarda

produtoEmbalagens.pesoBruto

float

Peso bruto da embalagem

produtoEmbalagens.pesoLiquido

float

Peso liquido da embalagem

produtoEmbalagens.quantidade

int

Quantidade de produtos na embalagem

produtoEmbalagens.situacao

int

produtoEmbalagens.unidadeMedida

string

Unidade de medida da embalagem

produtoKits

Lista de objetos

Lista de kits

produtoKits.idRetaguardaProduto

string

Identificador do produto na retaguarda

produtoKits.idRetaguardaProdutoKit

string

Identificador do kit na retaguarda

produtoKits.descricao

string

Descrição do kit

produtoKits.quantidadeVendaKit

int

produtoKits.tipoValorKit

int

produtoKits.situacao

int

produtoKits.valorDesconto

string

produtoKits.novoValorUnitario

string

produtosSimilares

Lista de objetos

Lista de produtos similares

produtosSimilares.idRetaguardaProduto

string

Identificador do produto na retaguarda

produtosSimilares.idRetaguardaSimilar

string

Identificador do produto similar na retaguarda

produtosSimilares.situacao

int

produtosSugestoes

Lista de objetos

Lista de sugestôes

produtosSugestoes.idRetaguardaProduto

string

Identificador do produto na retaguarda

produtosSugestoes.idRetaguardaSugestao

string

Identificador da sugestão na retaguarda

produtosSugestoes.situacao

int

codigosProduto

Lista de objetos

Lista de códigos do produto

codigosProduto.codigo

string

Código do produto

codigosProduto.descricao

string

Descrição do código

codigosProduto.idRetaguarda

string

Identificador do código na retaguarda

codigosProduto.dataAtualizacao

string

Data atualização do código

codigosProduto.dataCadastro

string

Data cadastro do código

codigosProduto.situacao

int

impostos

Lista de objetos

Lista de impostos do produto

impostos.idRetaguarda

string

Identificador do imposto na retaguarda

impostos.idProprietario

string

Identificador do proprietário

ncms

Lista de objetos

Lista de NCMs

ncms.idRetaguarda

string

Identificador do NCM na retaguarda

ncms.idProprietario

string

Identificador do proprietário

pisCofins

Lista de objetos

Lista de PisCofins

pisCofins.idRetaguarda

string

Identificador do PisCofin na retaguarda

pisCofins.idProprietario

string

Identificador do proprietário

fcps

Lista de objetos

Lista de FCPs

fcps.valorBaseFcp

string

Valor base do FCP

fcps.percentualFcp

string

Percentual do FCP

fcps.codigoBeneficioFiscal

string

Código de benefício fiscal

fcps.motivoDesoneracaoIcms

int

fcps.descontaDesoneracaoNf

boolean

fcps.idProprietario

string

Identificador do proprietário

quantidadeMovimentacao

float

idInquilino

string

Identificador do inquilino

idRetaguarda

string

Identificador do produto na retaguarda

idProprietario

string

Identificador do proprietário

loteOrigem

string

Identificador do lote que os dados serão enviados

Expandir

title	Definição dos campos de retorno

expandtitle

da forma de pagamento

Tamanho Máximo: 50 caracteres

Sim

descricaoFiscal

string

Descrição fiscal da forma de pagamento

Tamanho Máximo: 30 caracteres

Sim

pagamentoValorTotal

int

Configuração da forma de pagamento para que a mesma permita o pagamento do valor total da venda utilizando a mesma. Ou seja, se o carrinho tiver o valor de R$100,00 e a forma de pagamento DINHEIRO não permitir o pagamento total da venda, você não irá conseguir fechar a venda com o pagamento de R$100,00 em DINHEIRO. É necessário informar um pagamento inferior em DINHEIRO e o restante em outra forma de pagamento.

Não

permiteTroco

Int

Indica se a forma de pagamento permite troco

0 - Não; 1 - Sim

Sim

idRetaguardaFormaPagTroco

string

Identificador da forma de pagamento troco na retaguarda

Tamanho Máximo: 100 caracteres

Sim

valorMinimoAceito

string

Valor mínimo aceita para a forma de pagamento

Não

codigoSistemaExterno

string

Código Sistema Externo

Tamanho Máximo: 50 caracteres

Sim

situacao

integer

Situação da forma de pagamento

0 - Inativo, 1 - Ativo)

Sim

codigoModalidadePagamento

integer

DEFASADO

Não

tipo

integer

Tipo da forma de pagamento

Código	Tipo
0	Outros
1	Dinheiro
2	Credito
3	Debito
4	Cheque
5	POS
6	Troca
7	Fidelidade
8	Gift
9	Cliente
10	QRCode
11	Todos

Sim

tipoCliente

integer

Identifica se a forma de pagamento é uma forma utilizada para clientes cadastrados, como por exemplo, promissoria ou crédito empresa

Não

formasPagtoCondicoes

Lista de objetos

Lista de condições de forma de pagamento

Não

formasPagtoCondicoes.idRetaguarda

string

Identificador da condição na retaguarda

Não

formasPagtoCondicoes.idRetaguardaFormaPagto

string

Identificador da forma de pagamento na retaguarda

Não

formasPagtoCondicoes.idRetaguardaCondicaoPagto

string

Identificador da condição de pagamento na retaguarda

Não

formasPagtoCondicoes.situacao

integer

Situação da condição de pagamento

0 - Inativo, 1 - Ativo

Não

formasPagtoDadosComplementares

Lista de objetos

Lista de Dados complementares da forma de pagamento

Não

formasPagtoDadosComplementares.idRetaguarda

string

Identificador do dado complementar na reguardar

Não

formasPagtoDadosComplementares.idRetaguardaFormaPagto

string

Identificador da forma de pagamento na retaguarda

Não

formasPagtoDadosComplementares.idRetaguardaDadoComplementarPagto

string

Identificador do dado complementar pagamento na retaguarda

Não

formasPagtoDadosComplementares.situacao

integer

Situação do dado complementar

0 - Inativo, 1 - Ativo

Não

formasPagtoDadosComplementares.ordem

integer

Ordem do dado complementar

Não

formasPagtoOperadoras

Lista de objetos

Lista de operadoras da forma de pagamento

Não

formasPagtoOperadoras.idRetaguarda

string

Identificador da operadora na retaguarda

Não

formasPagtoOperadoras.idRetaguardaFormaPagto

string

Identificador da forma de pagamento na retaguarda

Não

formasPagtoOperadoras.idRetaguardaOperadoraPagto

string

Identificador da Operadora pagamento na retaguarda

Não

formasPagtoOperadoras.situacao

integer

Situação da operadora

0 - Inativo, 1 - Ativo

Não

formaPagtoModeloFiscal

Lista de objetos

Lista de modelos fiscais

Não

formaPagtoModeloFiscal.idRetaguarda

string

Identificador do modelo na retaguarda

Não

formaPagtoModeloFiscal.idRetaguardaFormaPagto

string

Identificador da forma de pagamento na retaguarda

Não

formaPagtoModeloFiscal.modeloFiscal

string

Modelo fiscal

Não

formaPagtoModeloFiscal.codigoFiscal

string

Código fiscal

Não

formaPagtoModeloFiscal.descricaoFiscal

string

Descrição fiscal

Não

formaPagtoModeloFiscal.situacao

integer

Situação do modelo fiscal

0 - Inativo, 1 - Ativo

Não

idInquilino

string

Identificador do inquilino

Sim

idRetaguarda

string

Identificador da forma de pagamento na retaguarda

Tamanho máximo: 100 caracteres

Sim

idProprietario

string

Identificador do proprietário

Sim

loteOrigem

string

Identificador do lote

Sim

Retornos

Deck of Cards

id	retornos

Card

label	200 - Ok

Column

width	50%

Exemplo de body de retorno

{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

Column

width	50%

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

Card

label	400 - Bad Request

Column

width	50%

Exemplo de body de retorno

{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
}

Column

width	50%

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

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

Requisição

Exemplo de body da requisição

Definições dos campos do body

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos do retorno

Requisição

Exemplo de body da requisição

Definições dos campos

do body

Retornos

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos do retorno

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

Requisição

Exemplo de body da requisição

Definições dos campos do body

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos do retorno

Requisição

Exemplo de body da requisição

Definições dos campos

do body

Retornos

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos do retorno