TOTVS Varejo PDV Omni

Árvore de páginas

Versões comparadas

Versão antiga 1

changes.mady.by.user Erik Lopes Vitelli

Gravado em

comparado com

Nova versão 2

changes.mady.by.user Erik Lopes Vitelli

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

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
titleExemplo de body da requisição

[
    {
        "descricao": "string",
        "unidadeMedidadescricaoFiscal": "string",
        "descontoMaximo": "string",
        "arredondaTruncapermiteTroco": 0,
        "codigoProdutoidRetaguardaFormaPagTroco": "string",
        "codigoAlternativovalorMinimoAceito": "string",
        "origemProduto": 0,
        "situacao": 0,
        "imagem"codigoSistemaExterno": "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,
                "unidadeMedidaidRetaguardaFormaPagto": "string"
            }
        ],
        "produtoKits": [
            {
                "idRetaguardaProduto": "string",
                "idRetaguardaProdutoKit"idRetaguardaDadoComplementarPagto": "string",
                "descricao": "string",
                "quantidadeVendaKit": 0,
                "tipoValorKit": 0,
                "situacao": 0,
                "valorDesconto": "string",
                "novoValorUnitario": "string"
            }
        ],
        "produtosSimilares": [
            {
                "idRetaguardaProduto": "string",
                "idRetaguardaSimilar": "string",
                "situacaoordem": 0
            }
        ],
        "produtosSugestoesformasPagtoOperadoras": [
            {
                "idRetaguardaProdutoidRetaguarda": "string",
                "idRetaguardaSugestaoidRetaguardaFormaPagto": "string",
                "situacao": 0
            }
        ],
        "codigosProduto": [
            {
                "codigo": "string",
                "descricaoidRetaguardaOperadoraPagto": "string",
                "idRetaguarda": "string",
                "dataAtualizacao": "2024-03-28T13:13:11.127Z",
                "dataCadastro": "2024-03-28T13:13:11.127Z",
                "situacao": 0
            }
        ],
        "impostosformaPagtoModeloFiscal": [
            {
                "idRetaguarda": "string",
                "idProprietarioidRetaguardaFormaPagto": "string"
            }
        ],
        "ncms": [
            {
                "idRetaguardamodeloFiscal": "string",
                "idProprietariocodigoFiscal": "string"
            }
        ],
        "pisCofins": [
            {
                "idRetaguarda"descricaoFiscal": "string",
                "idProprietario": "string"
            }
        ],
        "fcps": [
            {
                "valorBaseFcp": "string",
                "percentualFcp": "string",
                "codigoBeneficioFiscal": "string",
                "motivoDesoneracaoIcms": 0,
                "descontaDesoneracaoNf": true,
                "idProprietario": "string"situacao": 0
            }
        ],
        "quantidadeMovimentacao": 0,
        "idInquilino": "string",
        "idRetaguarda": "string",
        "idProprietario": "string",
        "loteOrigem": "string"
    }
]

Expandir
titleDefinição dos campos de requisição
do produtounidadeMedidaSituação do produto

Campo

Tipo

Descrição

Observações

descricaostringDescrição
da forma de pagamento
descricaoFiscalstring
Unidade de medida do produtodescontoMaximostringDesconto máximo aplicado ao produto
Descrição fiscal da forma de pagamento
permiteTroco


idRetaguardaFormaPagTrocostringIdentificador da forma de pagamento troco na retaguarda
valorMinimoAceitostringValor mínimo aceita para a forma de pagamento
codigoSistemaExternostringCódigo Sistema Externo
situacaointegerSituação da forma de pagamento arredondaTruncaintcodigoProdutostringCódigo do produtocodigoAlternativostringCódigo alternativo do produtoorigemProdutointOrigem do produtosituacaoint (0 - Inativo, 1 - Ativo)
imagemcodigoModalidadePagamentostringURL com a imagem do produtotipoProdutointfracionadobooleanIndica se o produto é vendido fracionadocnpjFornecedorstringCNPJ do fornecedor do produtoescalaRelevantebooleancstIcmsstringCST ICMS do produtopercentualReducaoIcmsstringPercentual de redução ICMSaliquotaIcmsstringAliquota ICMSvlicmsretstringceststringencomendabooleanIndica se o produto é uma encomendaintegerCódigo da modalidade de pagamento
tipointegerTipo da forma de pagamento
tipoClienteintegerTipo cliente
formasPagtoCondicoespesoLiquidofloatPeso liquido do produtopesoBrutofloatPeso bruto do produtoassociacaoProdutosClassificacaoLista de objetosLista de classificação do produtocondições de forma de pagamento
formasPagtoCondicoesassociacaoProdutosClassificacao.idRetaguardastringIdentificador da classificação condição na retaguarda
associacaoProdutosClassificacaoformasPagtoCondicoes.idRetaguardaProdutoidRetaguardaFormaPagtostringIdentificador do produto na retaguardaassociacaoProdutosClassificacao.idRetaguardaClassificacaoProdutostringassociacaoProdutosClassificacao.ordemintassociacaoProdutosClassificacao.situacaointda forma de pagamento na retaguarda
formasPagtoCondicoes.idRetaguardaCondicaoPagtoprodutoEmbalagenslista de objetos

Lista de embalagens do produto

produtoEmbalagens.codigoBarrasstringCódigo de barras da embalagemprodutoEmbalagens.descricaostringDescrição da embalagemprodutoEmbalagens.idProdutoRetaguardastringIdentificador do produto na retaguardaprodutoEmbalagens.idRetaguardastringIdentificador da embalagem condição de pagamento na retaguardaprodutoEmbalagens.pesoBrutofloatPeso bruto da embalagemprodutoEmbalagens.pesoLiquidofloatPeso liquido da embalagemprodutoEmbalagens.quantidadeintQuantidade de produtos na embalagemprodutoEmbalagens.situacaointprodutoEmbalagens.unidadeMedidastringUnidade de medida da embalagemprodutoKitsLista de objetosLista de kitsprodutoKits.idRetaguardaProdutostringIdentificador do produto na retaguardaprodutoKits.idRetaguardaProdutoKitstringIdentificador do kit na retaguardaprodutoKits.descricaostringDescrição do kitprodutoKits.quantidadeVendaKitintprodutoKits.tipoValorKitintprodutoKits.situacaointprodutoKits.valorDescontostringprodutoKits.novoValorUnitariostringprodutosSimilaresLista de objetosLista de produtos similaresprodutosSimilares.idRetaguardaProdutostringIdentificador do produto na retaguardaprodutosSimilares.idRetaguardaSimilarstringIdentificador do produto similar na retaguardaprodutosSimilares.situacaointprodutosSugestoesLista de objetosLista de sugestôesprodutosSugestoes.idRetaguardaProdutostringIdentificador do produto na retaguardaprodutosSugestoes.idRetaguardaSugestaostringIdentificador da sugestão na retaguardaprodutosSugestoes.situacaointcodigosProdutoLista de objetosLista de códigos do produtocodigosProduto.codigostringCódigo do produtocodigosProduto.descricaostringDescrição do códigocodigosProduto.idRetaguardastringIdentificador do código na retaguardacodigosProduto.dataAtualizacaostringData atualização do códigocodigosProduto.dataCadastrostringData cadastro do códigocodigosProduto.situacaointimpostosLista de objetosLista de impostos do produtoimpostos.idRetaguardastringIdentificador do imposto na retaguardaimpostos.idProprietariostringIdentificador do proprietárioncmsLista de objetosLista de NCMsncms.idRetaguardastringIdentificador do NCM na retaguardancms.idProprietariostringIdentificador do proprietário
formasPagtoCondicoes.situacaointegerSituação da condição de pagamento (0 - Inativo, 1 - Ativo)
formasPagtoDadosComplementaresLista de objetosLista de Dados complementares da forma de pagamento
formasPagtoDadosComplementares.idRetaguardastringIdentificador do dado complementar na reguardar
formasPagtoDadosComplementares.idRetaguardaFormaPagtostringIdentificador da forma de pagamento na retaguarda
formasPagtoDadosComplementares.idRetaguardaDadoComplementarPagtostringIdentificador do dado complementar pagamento na retaguarda
formasPagtoDadosComplementares.situacaointegerSituação do dado complementar (0 - Inativo, 1 - Ativo)
formasPagtoDadosComplementares.ordemintegerOrdem do dado complementar
formasPagtoOperadorasLista de objetosLista de operadoras da forma de pagamento
formasPagtoOperadoras.idRetaguardastringIdentificador da operadora na retaguarda
formasPagtoOperadoras.idRetaguardaFormaPagtostringIdentificador da forma de pagamento na retaguarda
formasPagtoOperadoras.idRetaguardaOperadoraPagtostringIdentificador da Operadora pagamento na retaguarda
formasPagtoOperadoras.situacaointegerSituação da operadora (0 - Inativo, 1 - Ativo)
formaPagtoModeloFiscalpisCofinsLista de objetosLista de PisCofinsmodelos fiscais
pisCofinsformaPagtoModeloFiscal.idRetaguardastringIdentificador do PisCofin modelo na retaguarda
pisCofinsformaPagtoModeloFiscal.idProprietarioidRetaguardaFormaPagtostringIdentificador do proprietáriofcpsLista de objetosLista de FCPsda forma de pagamento na retaguarda
formaPagtoModeloFiscal.modeloFiscalstringModelo fiscal
formaPagtoModeloFiscal.codigoFiscalstringCódigo fiscal
formaPagtoModeloFiscal.descricaoFiscalstringDescrição fiscal
formaPagtoModeloFiscal.situacaointegerSituação do modelo fiscal (0 - Inativo, 1 - Ativo)fcps.valorBaseFcpstringValor base do FCPfcps.percentualFcpstringPercentual do FCPfcps.codigoBeneficioFiscalstringCódigo de benefício fiscalfcps.motivoDesoneracaoIcmsintfcps.descontaDesoneracaoNfbooleanfcps.idProprietariostringIdentificador do proprietárioquantidadeMovimentacaofloat
idInquilinostringIdentificador do inquilino
idRetaguardastringIdentificador do produto da forma de pagamento na retaguarda
idProprietariostringIdentificador do proprietário
loteOrigemstring

Identificador do lote

que os dados serão enviados


Expandir
titleDefinição dos campos de retorno
Expandir
title200 - Ok

Campo

Tipo

Descrição

SuccessboolIndica se a criação do compartilhamento foi feita com sucesso
MessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
DataobjetoObjeto compartilhamento criado
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo da requisição
NumberOfRecordsintnúmero de dados inseridos
Expandir
title400 - Bad Request

Campo

Tipo

Descrição

codestringCódigo de erro
messagestringMensagem do erro
detailedMessagestringDetalhamento do erro
helpUrlstringurl de ajuda
TotalTimestringTempo total de busca
detailslista de objetoLista de objeto de erros
details.guidstringIdentificador do erro
details.codestringCódigo do erro
details.messagestringMensagem do erro 
details.detailedMessagestringDetalhamento do erro