TOTVS Varejo PDV Omni

Árvore de páginas

O FORMA DE PAGAMENTO poderá ter a seguintes informações:

    Pagamento_Forma_Mestre

    Descrição

    A tabela de forma de pagamento mestre representa o vinculo entre os botões disponíveis para seleção de pagamento em tela do PDV e a forma de pagamento no banco.
    Para o Android, a pagamento_forma_mestre corresponde exatamente ao botão apresentado, ou seja, caso seja inserido mais um registro no banco será apresentado mais um botão na tela.
    Para o UWP os botões são fixos, a mestre é usada somente para o vinculo da forma com o banco, então caso seja adicionado mais uma mestre é necessário mapeá-la na tela.
    Por padrão, na instalação do PDV OMNI já é criado os mestres CRÉDITO, DÉBITO, DINHEIRO, POS, CHEQUE, TROCA, OUTROS, GIFT E QR Code. Porém o QR Code só fica habilitado quando a parametrização para esse mestre está correta.

    Informação

    Coluna

    Obrigatório

    Tipo

    Tamanho

    Descrição
    Data de cadastro data_cadastro Sim Data
    		Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente.
    Descrição da mestre descricao Sm Texto 30 Descrição da mestre. Essa descrição será apresentada no botão na tela de pagamentos do Android.
    Ordem de prioridade da mestre ortem Sim Inteiro
    		Ordem posicional em que o botão deve ser apresentado. Por exemplo, se a ordem for "10" em uma lista de 10 opções, esse mestre será o ultimo da lista a ser apresentado.
    Situação situacao Sim Inteiro

    Define se a mestre em questão está ativo ou inativo.

    • 0 - Inativo
    • 1 - Ativo
    Tipo de forma de pagamento tipo Sim Inteiro
    		Tipo de pagamento 
    • Outros = 0,
    • Dinheiro = 1,
    • TefCredito = 2,
    • TefDebito = 3,
    • Cheque = 4,
    • Pos = 5,
    • Troca = 6,
    • Fidelidade = 7,
    • CartaoPresente = 8,
    • Cliente = 9,
    • QRCode = 10,
    • Todos = 11
    Data de atualização data_atualizacao Sim Data
    		Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi atualizado localmente.
    Identificação no retaguarda id_retaguarda Não Texto 100



    Pagamento_Forma

    Informação

    Coluna

    Obrigatório

    Tipo

    Tamanho

    Descrição
    Descrição da forma de pagamento descricao Sim Texto 50 Descrição da forma de pagamento cadastrada no ERP/Retaguarda
    Descrição fiscal da forma de pagamento descricao_fiscal Sim Texto 30 Descrição fiscal da forma de pagamento, porém não é utilizada pra a impressão do cupom, somente informativo.

    		codigo_impressora Sim Texto 30 Defasado. O valor é sempre 0.
    Configuração se a forma permite o pagamento do valor total da venda pagamento_valor_total Não Inteiro
    		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.
    Configuração se a forma permite gerar troco permite_troco Sim Inteiro
    		Configuração da forma de pagamento para que a mesma permita gerar troco. Ou seja, se o carrinho tiver o valor de R$100,00 e a forma de pagamento DINHEIRO não permitir troco, você não irá conseguir fechar a venda com o pagamento de R$101,00 em DINHEIRO, pois não é permitido retornar R$1,00 de troco utilizando essa forma de pagamento.
    Configuração da forma que será gerada de troco, caso a forma permita id_forma_pagamento_troco Não Inteiro
    		Caso a forma de pagamento permita troco, o campo id_forma_pagamento configura em qual forma ela realiza o troco. Por exemplo, se a forma de pagamento TROCA permite troco e está configurada para realizar o troco em VALE TROCA, quando pago um valor acima do total da venda em TROCA a diferença do valor não será em DINHEIRO e sim em VALE TROCA.
    Configuração o valor mínimo de recebimento que a forma de pagamento permite valor_minimo_aceito Não Numérico
    		Configuração para definir um valor minimo para determinada forma de pagamento. Ou seja, caso a forma de pagamento DINHEIRO esteja configurada para aceitar um valor minímo de R$50,00 e você tente informar um pagamento de R$40,00 no PDV, ele não irá permitir, pois o valor minímo para o dinheiro é R$50,00
    Código da forma de pagamento no sistema externo que cadastrou (Retaguarda/ERP) codigo_sistema_externo Sim Texto 50 Utilizado no SELFCHECKOUT para geração do QRCode para o pagamento de carteira digital
    Situação situacao Sim Inteiro

    Define se a forma de pagamento em questão está ativo ou inativo.

    • 0 - Inativo
    • 1 - Ativo
    Data de cadastro data_cadastro Sim Data
    		Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente.
    Data de atualização data_atualizacao Sim Data
    		Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi atualizado localmente.
    Identificação no retaguarda id_retaguarda Não Texto 100

    		codigo_modalidade_pagamento Não Inteiro
    		Defasado
    Tipo de pagamento tipo Não Inteiro
    		Tipo de pagamento 
    • Outros = 0,
    • Dinheiro = 1,
    • TefCredito = 2,
    • TefDebito = 3,
    • Cheque = 4,
    • Pos = 5,
    • Troca = 6,
    • Fidelidade = 7,
    • CartaoPresente = 8,
    • Cliente = 9,
    • QRCode = 10,
    • Todos = 11
    ID da pagamento_forma_mestre id_pagamento_forma_mestre Não Inteiro
    		Vinculo entre a forma de pagamento e a pagamento mestre
    Configuração se a forma de pagamento é para clientes tipo_cliente Não Inteiro
    		Identifica se a forma de pagamento é uma forma utilizada para clientes cadastrados, como por exemplo, promissoria ou crédito empresa



    Pagamento_Forma_Modelo_Fiscal

    Informação

    Coluna

    Obrigatório

    Tipo

    Tamanho

    Descrição
    Situação situacao Sim Inteiro

    Define se o vinculo fiscal em questão está ativo ou inativo.

    • 0 - Inativo
    • 1 - Ativo
    Data de cadastro data_cadastro Sim Data
    		Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente.
    Data de atualização data_atualizacao Sim Data
    		Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi atualizado localmente.
    ID da pagamento_forma id_pagamento_forma Sim Inteiro
    		Vinculo entre o modelo fiscal e a forma de pagamento
    Identificação do modelo fiscal que o registro é válido modelo_fiscal Sim Inteiro

    Configuração do modelo fiscal da loja

    • 1 SAT/MFE
    • 2- NFCE/NFe
    Código fiscal codigo_fiscal Não Texto 2 Para emissão da XML da venda, esse campo é utilizado para o preenchimento da TAG tPag do grupo pag
    Descrição fiscal descricao_fiscal Sim Texto 30
    Identificação no retaguarda id_retaguarda Não Texto 100 Descrição da forma de pagamento apresentado no cupom fiscal



    Pagamento_Operadora

    Pagamento_Operadora

    A tabela pagamento_operadora possui vinculo tanto com a forma de pagamento quanto as condições de pagamento.
    O vinculo entre a pagamento_operadora e a pagamento_condicao ocorre através da pagamento_condicao_operadora, onde é informado os IDs de vinculo.
    O vinculo entre a pagamento_operadora e a pagamento_forma ocorre através da pagamento_forma_operadora, onde é informado os IDs de vinculo.

    Informação

    Coluna

    Obrigatório

    Tipo

    Tamanho

    Descrição
    Descrição descricao Sim Texto 100 Descrição da bandeira do cartão
    Situação situacao Sim Inteiro 1

    Define se a operadora em questão está ativo ou inativo.

    • 0 - Inativo
    • 1 - Ativo
    Data de cadastro data_cadastro Sim Data
    		Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente.
    Data de atualização data_atualizacao Sim Data
    		Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi atualizado localmente.
    Identificação no retaguarda id_retaguarda Não Texto 100
    Código TEF codigo_tef Não Texto 30 Código TEF da operadora de cartões
    Administradora administradora Não Texto 100 Código da administradora da operadora de cartões
    Tipo de transação tipo_transacao Sim Inteiro

    Configuração se a transação utilizada por determinada operadora é débito ou crédito

    • 0 - Débito
    • 1 - Crédito


    Pagamento_Operadora_Bin

    Informação

    Coluna

    Obrigatório

    Tipo

    Tamanho

    Descrição
    Início das BINs inicio Sim Inteiro
    		Inicio do intervalo de BINs permitidos para determinada bandeira
    Fim das BINs fim Sim Inteiro
    		Final do intervalo de BINs permitidos para determinada bandeira
    Data de cadastro data_cadastro Sim Data
    		Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente.
    Data de atualização data_atualizacao Sim Data
    		Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi atualizado localmente.

    		id_pagamento_operadora Não Inteiro
    		O vinculo entre o intervalo de BINs de cartões com a bandeira de cartão
    Identificação no retaguarda id_retaguarda Não Texto 100
    Tipo de atributo tipo_atributo Não Inteiro

    Tipo de atributo do registros

    • 0 = Bin
    • 1 = Bandeira
    • 2 = Rede
    • 3 = TEF Discado, usado também para carteira digital (mercadopago, pix, shipay).
    • Quando for carteira digital, terá somente o TipoAtributo 3, se existir o TipoAtributo 1, não usar como carteira digital
    Situação situacao Sim Inteiro

    Define se a bin em questão está ativo ou inativo.

    • 0 - Inativo
    • 1 - Ativo


    Pagamento_Condicao

    Pagamento_Condicao

    A tabela pagamento_condicao possui vinculo tanto com a operadora quanto a forma de pagamento em si.
    O vinculo entre a pagamento_condicao e a pagamento_operadora ocorre através da pagamento_condicao_operadora, onde é informado os IDs de vinculo.
    O vinculo entre a pagamento_condicao e a pagamento_forma ocorre através da pagamento_forma_condicao, onde é informado os IDs de vinculo.

    Informação

    Coluna

    Obrigatório

    Tipo

    Tamanho

    Descrição
    Descrição da condição descricao Sim Texto 50

    Descrição da condição de pagamento.

    *Condições relacionados ao produto eletrônico possui um texto padronizado diferente do cadastrado, onde o nome é formado por:
    Caso a operação seja débito será iniciado com "PRE DATADO" e caso seja diferente de débito será "PARCELADO". Na sequência virá o nome do produto, número de parcelas e o texto "PARCELAS".
    Por exemplo: "PARCELADO ELO CRED (C)-5 parcelas"
    Dias entre parcelas dias_entre_parcelas Não Inteiro
    		Dado recebido no retagaurda/ERP. Posteriormente esse dado é gravado no objeto Financeiro.Objects.Cartao na mensagem do financeiro integrado com o TOTVS Live
    Número máximo de parcelas numero_maximo_parcelas Não Inteiro
    		Dado recebido no retagaurda/ERP. No PDV esse dado é utilizado para preenchimento de lista de parcelas disponívels para seleção e finalização da venda.
    Percentual mínimo de entrada percentual_minimo_entrada Não Inteiro
    		Dado recebido no retaguarda/ERP, porém não utilizado no PDV.
    Prazo máximo para primeira parcela prazo_maximo_primeira_parcela Não Inteiro
    		Dado recebido no retaguarda/ERP, porém não utilizado no PDV.
    Solicita a data das demais parcelas solicita_data_demais_parcelas Não Inteiro
    		Dado recebido no retaguarda/ERP, porém não utilizado no PDV.
    Solicita a data da primeira parcela solicita_data_primeira_parcela Não Inteiro
    		Dado recebido no retaguarda/ERP, porém não utilizado no PDV.
    Situação situacao Sim Inteiro

    Define se a condição em questão está ativo ou inativo.

    • 0 - Inativo
    • 1 - Ativo
    Data de cadastro data_cadastro Sim Data
    		Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente.
    Data de atualização data_atualizacao Sim Data
    		Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi atualizado localmente.
    Identificação no retaguarda id_retaguarda Não Texto 100
    Dado complementar dado_complementar Não Inteiro
    		Defasado
    Descrição do dado complementar dado_complementar_descricao Não Texto 30 Defasado
    Dia fixo para o pagamento dia_fixo_pagamento Não Inteiro
    		Dado recebido no retaguarda/ERP e utilizado pelo PDV para realizar o calculo das parcelas.
    Quantidade de dias de carência para o primeiro pagamento dias_carencia_primeiro_vencimento Não Inteiro
    		Dado recebido no retaguarda/ERP e utilizado pelo PDV para realizar o calculo das parcelas.
    Configuração se o número de parcelas é fixo fixa_numero_parcelas Não Inteiro
    		Dado recebido no retaguarda/ERP e utilizado pelo PDV formatar a apresentação das parcelas.
    Quantidade de parcelas quantidade_parcelas Não Inteiro
    		Dado recebido no retaguarda/ERP e utilizado pelo PDV formatar a apresentação das parcelas.
    Tipo de arredondamento tipo_arredondamento Não Inteiro
    		Defasado
    • Arredonda primeira parcela = 0
    • Arredonda ultima parcela = 1
    Tipo de vencimento para o parcelamento tipo_vencimento_parcelamento Não Inteiro
    • Dado recebido no retaguarda/ERP e utilizado pelo PDV para realizar o calculo das parcelas.
      Dias corridos entre parcelas = 0
    • Dia fixo mensal = 1
    • Dia fixo semanal = 2
    • Dia fixo quinzenal = 3
    Configuração se vence em dia útil vence_dia_util Não Inteiro
    		Defasado
    Configuração do valor mínimo de parcela valor_minimo_parcela Sim Numérico 10 Dado recebido no retaguarda/ERP e utilizado pelo PDV formatar a apresentação das parcelas


    Pagamento_Dado_Complementar

    Pagamento_Dado_Complementar

    A tabela pagamento_dado_complementar possui vinculo com a forma de pagamento.
    O vinculo entre a pagamento_dado_complementar e a pagamento_forma ocorre através da pagamento_forma_dado_complementar, onde é informado os IDs de vinculo.

    Informação

    Coluna

    Obrigatório

    Tipo

    Tamanho

    Descrição
    Identificação no retaguarda id_retaguarda Não Texto 100
    Descrição do dado complementar descricao Não Texto 30 Descrição do dado complementar que será apresentado na tela do PDV
    Tipo de dado complementar tipo Não Inteiro
    		Valor fixo como 1.
    Configuração se o dado é obrigatório obrigatorio Sim Inteiro
    		Valor fixo como 1.
    Tamanho do dado permitido tamanho Não Inteiro
    		Valor fixo como 25.
    Tipo campo TEF tipo_campo_tef Não Inteiro
    		Defasado
    Situação situacao Sim Inteiro

    Define se o dado em questão está ativo ou inativo.

    • 0 - Inativo
    • 1 - Ativo
    Data de cadastro data_cadastro Sim Data
    		Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente.
    Data de atualização data_atualizacao Sim Data
    		Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi atualizado localmente.

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

    • Endpoint:
      • /api/retaguarda/v2/FormaPagtos
      • /api/retaguarda/v3/FormaPagtos
      • /api/retaguarda/v3/dadosdinamicos/down/18/1
    • 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

    Requisição

    Exemplo de body da requisição

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

            "clienteConsumidor": bool
        }
    ]

    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 Tamanho Máximo: 2 caracteres
    formaPagtoModeloFiscal.descricaoFiscal string Descrição fiscal Não Tamanho Máximo: 30 caracteres
    formaPagtoModeloFiscal.idRetaguarda string Identificador do modelo na retaguarda Não Tamanho Máximo: 100 caracteres
    formaPagtoModeloFiscal.idRetaguardaFormaPagto string Identificador da forma de pagamento na retaguarda Não Tamanho Máximo: 100 caracteres
    formaPagtoModeloFiscal.modeloFiscal string Modelo fiscal Não Tamanho Máximo: 30 caracteres
    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 Tamanho Máximo: 100 caracteres
    formasPagtoCondicoes.idRetaguardaCondicaoPagto string Identificador da condição de pagamento na retaguarda Não Tamanho Máximo: 100 caracteres
    formasPagtoCondicoes.idRetaguardaFormaPagto string Identificador da forma de pagamento na retaguarda Não Tamanho Máximo: 100 caracteres
    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 Tamanho Máximo: 100 caracteres
    formasPagtoDadosComplementares.idRetaguardaDadoComplementarPagto string Identificador do dado complementar pagamento na retaguarda Não Tamanho Máximo: 100 caracteres
    formasPagtoDadosComplementares.idRetaguardaFormaPagto string Identificador da forma de pagamento na retaguarda Não Tamanho Máximo: 100 caracteres
    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 Tamanho Máximo: 100 caracteres
    formasPagtoOperadoras.idRetaguardaFormaPagto string Identificador da forma de pagamento na retaguarda Não Tamanho Máximo: 100 caracteres
    formasPagtoOperadoras.idRetaguardaOperadoraPagto string Identificador da Operadora pagamento na retaguarda Não Tamanho Máximo: 100 caracteres
    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 Tamanho Máximo: 100 caracteres
    idRetaguardaFormaPagTroco string Identificador da forma de pagamento troco na retaguarda

    Não

    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 Tamanho Máximo: 50 caracteres
    clienteConsumidor bool Habilita forma de pagamento para aquela forma de pagamento Não true/false

    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

    A versão V3.2 não é compatível com o legado da V2. Caso seja necessário utilizar a V3 do sync (dados dinâmicos) mantendo a compatibilidade com a V2, recomenda-se a utilização da versão V3.1.

    Requisição

    Exemplo de body da requisição

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

            "clienteConsumidor": bool
        }
    ]

    Definições dos campos do body

    Campo

    Tipo

    Descrição

    Observações

    Obrigatório
    descricao string Descrição 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

    Não
    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
    clienteConsumidor bolean

    Habilita forma de pagamento para aquele cliente

    		 true/false Não

    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
    • Sem rótulos