Histórico da Página

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 18 = Produto FormaPagto

Expandir

title	Exemplo de body da requisição

[
{
"descricao": "string",
"unidadeMedidadescricaoFiscal": "string",
"descontoMaximo": "string",
"arredondaTruncapermiteTroco": 0,
"codigoProdutoidRetaguardaFormaPagTroco": "string",
"codigoAlternativovalorMinimoAceito": "string",
"origemProduto": 0,
"situacao": 0,
"imagemcodigoSistemaExterno": "string",
"tipoProdutosituacao": 0,
"fracionadocodigoModalidadePagamento": true0,
"cnpjFornecedor": "string",
"escalaRelevante": true,
"cstIcms": "string",
"percentualReducaoIcms": "string",
"aliquotaIcms": "string",
"vlicmsret": "string",
"cest": "string",
"encomenda": true,
"pesoLiquido": tipo": 0,
"pesoBrutotipoCliente": 0,
"associacaoProdutosClassificacaoformasPagtoCondicoes": [
{
"idRetaguarda": "string",
"idRetaguardaProdutoidRetaguardaFormaPagto": "string",
"idRetaguardaClassificacaoProdutoidRetaguardaCondicaoPagto": "string",
"ordem": 0,
"situacao": 0
}
],
"produtoEmbalagensformasPagtoDadosComplementares": [
{
"codigoBarras ": "string",
"descricao": "string",
"idProdutoRetaguarda": "string",
"idRetaguarda": "string",
"pesoBruto": 0,
"pesoLiquido": 0,
"quantidade": 0,
"situacao": 0,
"unidadeMedida": "string"
}
],
"produtoKits": [
{
"idRetaguardaProdutoidRetaguardaFormaPagto": "string",
"idRetaguardaProdutoKit": "string",
"descricaoidRetaguardaDadoComplementarPagto": "string",
"quantidadeVendaKit": 0,
"tipoValorKit": 0,
"situacao": 0,
"valorDesconto": "string",
"novoValorUnitario": "string"
}
],
"produtosSimilares": [
{
"idRetaguardaProduto": "string",
"idRetaguardaSimilar": "string",
"situacao": ordem": 0
}
],
"produtosSugestoesformasPagtoOperadoras": [
{
"idRetaguardaProdutoidRetaguarda": "string",
"idRetaguardaSugestaoidRetaguardaFormaPagto": "string",
"situacao": 0
}
],
"codigosProduto": [
{
"codigo": "string",
"descricao": "string",
"idRetaguardaidRetaguardaOperadoraPagto": "string",
"dataAtualizacao": "2024-03-28T13:13:11.127Z ",
"dataCadastro": "2024-03-28T13:13:11.127Z",
"situacao": 0
}
],
"impostosformaPagtoModeloFiscal": [
{
"idRetaguarda": "string",
"idProprietario": "string"
}
],
"ncms": [
{
"idRetaguardaidRetaguardaFormaPagto": "string",
"idProprietariomodeloFiscal": "string"
}
],
"pisCofins": [
{
"idRetaguarda"codigoFiscal": "string",
"idProprietariodescricaoFiscal": "string"
}
],
"fcps": [
{
"valorBaseFcp": "string",
"percentualFcp": "string",
"codigoBeneficioFiscal": "string",
"motivoDesoneracaoIcms"situacao": 0,
"descontaDesoneracaoNf": true,
"idProprietario": "string"
}
],
"quantidadeMovimentacao ": 0,
"idInquilino": "string",
"idRetaguarda": "string",
"idProprietario": "string",
"loteOrigem": "string"
}
]

Expandir

title	Definição dos campos de requisição

do produtoIdentificador do lote que os dados serão enviados

Campo	Tipo	Descrição	Observações
descricao	string	Descrição
unidadeMedida	string	Unidade de medida do produto	descontoMaximo	string	Desconto máximo aplicado ao produto
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	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 condição na retaguarda	Opcional
formasPagtoCondicoesassociacaoProdutosClassificacao.idRetaguardaProdutoidRetaguardaFormaPagto	string	Identificador do produto da forma de pagamento na retaguarda	associacaoProdutosClassificacao.idRetaguardaClassificacaoProduto	string	associacaoProdutosClassificacao.ordem	int	associacaoProdutosClassificacao.situacao	int	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	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 kitsde Dados complementares da forma de pagamento	Opcional
formasPagtoDadosComplementares.idRetaguardaprodutoKits.idRetaguardaProduto	string	Identificador do produto na retaguardadado complementar na reguardar	Opcional
formasPagtoDadosComplementares.idRetaguardaFormaPagtoprodutoKits.idRetaguardaProdutoKit	string	Identificador do kit da forma de pagamento na retaguarda	Opcional
produtoKitsformasPagtoDadosComplementares.descricaoidRetaguardaDadoComplementarPagto	string	Descrição do kit	produtoKits.quantidadeVendaKit	int	produtoKits.tipoValorKit	int	produtoKits.situacao	int	produtoKits.valorDesconto	string	produtoKits.novoValorUnitario	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
formasPagtoOperadorasprodutosSimilares	Lista de objetos	Lista de produtos similaresde operadoras da forma de pagamento	Opcional
formasPagtoOperadoras.idRetaguardaprodutosSimilares.idRetaguardaProduto	string	Identificador do produto da operadora na retaguarda	Opcional
produtosSimilaresformasPagtoOperadoras.idRetaguardaSimilaridRetaguardaFormaPagto	string	Identificador do produto similar da forma de pagamento na retaguarda	produtosSimilares.situacao	int	Opcional
formasPagtoOperadoras.idRetaguardaOperadoraPagto	produtosSugestoes	Lista de objetos	Lista de sugestôes	produtosSugestoes.idRetaguardaProduto	string	Identificador do produto da Operadora pagamento na retaguarda	Opcional
formasPagtoOperadorasprodutosSugestoes.idRetaguardaSugestaosituacao	stringinteger	Identificador da sugestão na retaguarda	produtosSugestoes.situacao	int	Situação da operadora (0 - Inativo, 1 - Ativo)	Opcional
formaPagtoModeloFiscalcodigosProduto	Lista de objetos	Lista de códigos do produtomodelos fiscais	Opcional
formaPagtoModeloFiscal.idRetaguardacodigosProduto.codigo	string	Código Identificador do produto	codigosProduto.descricao	string	Descrição do código	modelo na retaguarda	Opcional
formaPagtoModeloFiscal.idRetaguardaFormaPagtocodigosProduto.idRetaguarda	string	Identificador do código da forma de pagamento na retaguarda	codigosProduto.dataAtualizacao	string	Data atualização do código	Opcional
formaPagtoModeloFiscal.modeloFiscalcodigosProduto.dataCadastro	string	Data cadastro do código	codigosProduto.situacao	int	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	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	inquilino	Obrigatório
pisCofins.idRetaguarda	string	Identificador do PisCofin da forma de pagamento na retaguarda	Obrigatório
pisCofins.idProprietario	string	Identificador do proprietário	fcpsObrigatório
loteOrigem	Lista de objetos	Lista de FCPs	fcps.valorBaseFcp	string	Valor base Identificador 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	lote	Obrigatório para a integração

Expandir

title	TipoFormaPagto

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

Expandir

title	Definição dos campos de retorno

Expandir

title	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

Expandir

title	Body de retorno

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

Expandir

title	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

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave