Presence API - FINANCEIRO

Presence API - FINANCEIRO

FINANCEIRO

Este módulo é responsável por listar os títulos financeiros do sistema.

Parâmetros

Nome
Obrigatório
Tipo
Descrição
tipo
Sim
String
Tipo do registro, "R" = Receber, "P" = à Pagar.
controle_titulo
Sim quando não informado os parametros data_atualizacao, data_vencimento, data_emissao ou data_lancamento
Integer
Número interno do título cadastrado no sistema.
data_atualizacao_iniSim quando não informado controle_titulo ou quando informado data_atualizacao_fim
Data (AAAA-MM-DDT00:00:00)Data de alteração do Título
data_atualizacao_fim
Sim quando não informado controle_titulo ou quando informado data_atualizacao_ini
Data (AAAA-MM-DDT00:00:00)
Data de alteração do Título
data_vencimento_ini
Sim quando informado data_vencimento_fim ou quando não informado controle_titulo
Data (AAAA-MM-DDT00:00:00)
Data de vencimento do Título
data_vencimento_fim
Sim quando informado data_vencimento_ini ou quando não informado controle_titulo
Data (AAAA-MM-DDT00:00:00)
Data de vencimento do Título
data_emissao_ini
Sim quando informado data_emissao_fim ou quando não informado controle_titulo
Data (AAAA-MM-DDT00:00:00)
Data de emissão do Título
data_emissao_fim
Sim quando informado data_emissao_ini ou quando não informado controle_titulo
Data (AAAA-MM-DDT00:00:00)
Data de emissão do Título
data_lancamento_ini
Sim quando informado data_lancamento_fim ou quando não informado controle_titulo
Data (AAAA-MM-DDT00:00:00)
Data de registro do Título
data_lancamento_fim
Sim quando informado data_lancamento_ini ou quando não informado controle_titulo
Data (AAAA-MM-DDT00:00:00)
Data de registro do Título

BODY
  1. {
  2.     "tipo" : "R",
  3.     "controle_titulo" : 452575
  4. }
      OU
      1. {
      2.     "tipo" : "R",
      3.     "data_atualizacao_ini" : "2022-01-01",
      4.     "data_atualizacao_fim" : "2022-03-01"
      5. }
            OU
            1. {
            2.     "tipo" : "R",
            3.     "data_vencimento_ini" : "2022-01-01",
            4.     "data_vencimento_fim" : "2022-03-01"
            5. }
            OU
            1. {
            2.     "tipo" : "R",
            3.     "data_emissao_ini" : "2022-01-01",
            4.     "data_emissao_fim" : "2022-03-01"
            5. }
            OU
            1. {
            2.     "tipo" : "P",
            3.     "data_lancamento_ini" : "2022-01-01",
            4.     "data_lancamento_fim" : "2022-03-01"
            5. }


            JSON de Retorno


            Nome
            Tipo
            Descrição
            Origem
            String
            Tipo do Título: à Pagar ou Receber
            ctrlTitulo
            Integer
            código interno de registro do título
            tipoResponsavel
            String
            tipo do destinatário: Cliente, Fornecedor, etc.
            idLoja
            String
            Código da loja no sistema
            lojaNome
            String
            Nome da Loja 
            lojaNomeFantasia
            String
            Nome Fantasia da Loja
            grupoFranquia
            Integer
            código do grupo de franquias da loja
            descricaoFranquia
            String
            Nome do grupo de franquias da loja
            controleFuncionario
            Integer
            código interno do funcionário
            codigoFornecedor
            Integer
            código interno do fornecedor
            codigoRepresentante
            Integer
            código interno do representante
            codigoPlanoContas
            String
            Código do Plano de Contas do título
            descricaoPlanoContas
            String
            Descricao do Plano de Contas do titulo
            codigoCarteira
            String
            código da carteira financeira do titulo
            descricaoCarteira
            String
            descricao da carteira financeira do titulo
            situacaoCodigo
            Integer
            codigo da situacao do titulo no sistema
            situacaoDescricao
            String
            descricao da situacao do titulo no sistema
            codigoCentroCusto
            String
            codigo do centro de custo do titulo
            descricaoCentroCusto
            String
            descricao do centro de custo do titulo
            numeroNf
            IntegerNumero da nota fiscal do titulo
            dataLancamento
            Data (AAAA-MM-DDT00:00:00)Data de lançamento do titulo. Padrão ISO8601.
            dataEmissao
            Data (AAAA-MM-DDT00:00:00)
            Data de emissão do título. Padrão ISO8601.
            dataVencimento
            Data (AAAA-MM-DDT00:00:00)
            Data de vencimento atual do titulo. Padrão ISO8601.
            dataVencimentoOriginal
            Data (AAAA-MM-DDT00:00:00)
            Data de vencimento original do título. Padrão ISO8601.
            codigoMoeda
            String
            Código da moeda utilizada no título
            descontoPercentual
            Real
            Percentual de desconto do titulo
            descontoValor
            Real
            Valor de desconto do titulo
            multaPercentual
            Real
            Percentual de multa do título
            multaValor
            Real
            Valor de multa do título
            valorTotalNf
            Real
            Valor total da Nota Fiscal
            valorParcela
            Real
            Valor da parcela do título
            saldo
            Real
            Saldo em aberto no título
            observacao
            String
            Observações
            numeroAuxiliar
            String
            Código auxiliar para identificação do título
            lote
            String
            número do lote
            codigoContaCorrente
            String
            código da conta corrente do titulo
            dataAtualizacao
            Data (AAAA-MM-DDT00:00:00)
            Data da atualização do título. Padrão ISO8601.
            contaContabilDebito
            String
            Código da conta contábil de débito
            contaContabilCredito
            String
            C[odigo da conta contábil de crédito
            exportado
            String
            Identifica se o título foi Exportado 'S' ou 'N'
            numParcela
            Integer
            número da parcela do título
            atualizado
            String
            Identifica se o título sofreu atualizações
            seriePedido
            String
            Série da loja que gerou o título
            parcelasVendas
            Integer
            Exibe o número total de parcelas
            tipoTitulo
            String
            Código do tipo de titulo (E/N - fiscal ou R - romaneio) no sistema
            tituloTipo
            String
            Descrição do tipo de título
            origemTitulo
            String
            à Pagar ou Receber
            codigoResponsavel
            String
            Identifica o destinatário do título
            fornecedorRazaoSocial
            String
            razão social do fornecedor
            codigoCompletoCliente
            String
            código completo do cliente
            clienteLojaResponsavel
            String
            Código da Loja onde o cliente foi cadastrado
            clienteCodigoResponsavel
            String
            Código interno do cliente na loja responsavel
            razaoSocialResponsavel
            String
            Razao Social do cliente
            nomeFantasiaResponsavel
            String
            Nome Fantasia do cliente
            calculoSaldoReceber
            Real
            Valor a receber
            calculoSaldoPagar
            Real
            Valor a Pagar
            calculoValorReceber
            Real
            Valor a Receber
            CalculoValorPagar
            Real
            Valor a Pagar
            controleNf
            String
            codigo interno da NF
            banco
            String
            código do banco
            agencia
            String
            numero da agencia
            digitoAgencia
            String
            digito da agencia
            contaBanco
            String
            numero da conta
            descricao
            String
            descrição da conta
            chequeBanco
            Integer
            código do cheque
            chequeAgencia
            String
            numero da agencia do cheque
            chequeConta
            String
            numero da conta do cheque
            chequeNumero
            String
            numero do cheque
            chequeDigitoAgencia
            String
            numero do digito da agencia do cheque
            chequeDigitoConta
            String
            numero do digito da conta do cheque
            modalidade
            String
            Modalidade do pagamento (Cartão de crédito, boleto, etc)
            totalParcelas
            Integer
            quantidade total de parcelas
            boletoCentroCusto
            String
            código do centro de custo do boleto
            boletoCentroCustoDescricao
            String
            descricao do centro de custo do boleto
            boletoIdRemessa
            String
            codigo do arquivo de remessa do boleto
            boletoIdRetorno
            String
            codigo do arquivo de retorno do boleto
            boletoEstado
            String
            descricao da situação do boleto
            boletoSituacaoEnvio
            String
            descricao da situação de envio do boleto
            boletoNossoNumero
            String
            Nosso numero
            codigoAuxiliarFidelidade
            String
            código auxiliar do fidelidade do cliente
            codigoAuxiliarCliente
            Integer
            codigo auxiliar do cliente
            codigoExternoResponsavel
            String
            codigo do cliente na plataforma
            codigoFranqueadora
            String
            código da franqueadora
            fantasiaFranqueadora
            String
            nome fantasia da franqueadora
            codigoMatriz
            String
            código da matriz
            fantasiaMatriz
            String
            nome fantasia da matriz
            clienteAtivo
            String
            'S' para Ativo, 'N' para Inativo
            clienteCredito
            String
            'L' para Liberado, 'B' para Bloqueado
            dadosBoleto
            String
            Dados boleto
            bancoPagamento
            String
            Banco do pagamento
            tipoPagamento
            String
            Tipo do Pagamento
            modalidadePagamento
            String
            Modalidade do pagamento
            cpfCnpjResponsavel
            String
            CPF ou CNPJ do cliente
            email
            String
            Email do cliente
            dataLiquidacao
            Data (AAAA-MM-DDT00:00:00)
            Se liquidado, a data de liquidação do título
            tipoLiquidacao
            String
            Se liquidado, o tipo de liquidação do título
            valorPagamento
            Real
            Se liquidado, o valor de liquidação do título


            1. {
            2.     "status": "ok",
            3.     "serverTime": "2022-03-22T18:46:27.000Z",
            4.     "versionCode": 6,
            5.     "method": "FINANCEIRO",
            6.     "data": [
            7.         {
            8.             "origem": "Receber",
            9.             "ctrlTitulo": 452575,
            10.             "tipoResponsavel": "Cliente",
            11.             "idLoja": "24",
            12.             "lojaNome": "JOGE 24",
            13.             "lojaNomeFantasia": "JOGE FLAMBOYANT SHOPPING",
            14.             "grupoFranquia": 0,
            15.             "descricaoFranquia": null,
            16.             "controleFuncionario": null,
            17.             "codigoFornecedor": null,
            18.             "codigoRepresentante": null,
            19.             "codigoPlanoContas": "200.100.009",
            20.             "descricaoPlanoContas": "CREDITO MASTERCARD",
            21.             "codigoCarteira": "01",
            22.             "descricaoCarteira": "BANCO",
            23.             "situacaoCodigo": "0",
            24.             "situacaoDescricao": "Importado",
            25.             "codigoCentroCusto": "",
            26.             "descricaoCentroCusto": null,
            27.             "numeroNf": 20648,
            28.             "dataLancamento": "2021-12-21 00:00:00.000",
            29.             "dataEmissao": "2021-12-21 00:00:00.000",
            30.             "dataVencimento": "2022-03-22 00:00:00.000",
            31.             "dataVencimentoOriginal": "2022-03-22 00:00:00.000",
            32.             "codigoMoeda": "",
            33.             "descontoPercentual": 0,
            34.             "descontoValor": 0,
            35.             "multaPercentual": 0,
            36.             "multaValor": 0,
            37.             "valorTotalNf": 114.04,
            38.             "valorParcela": 114.04,
            39.             "saldo": 114.04,
            40.             "observacao": "",
            41.             "numeroAuxiliar": "CONSOLIDACAO",
            42.             "lote": "",
            43.             "codigoContaCorrente": null,
            44.             "dataAtualizacao": "2021-12-21 23:00:14.000",
            45.             "contaContabilDebito": "",
            46.             "contaContabilCredito": "",
            47.             "exportado": "N",
            48.             "numParcela": 3,
            49.             "atualizado": "",
            50.             "seriePedido": null,
            51.             "parcelasVendas": 4,
            52.             "tipoTitulo": "E",
            53.             "tituloTipo": "ECF",
            54.             "origemTitulo": "Receber",
            55.             "codigoResponsavel": "99.494168",
            56.             "fornecedorRazaoSocial": null,
            57.             "codigoCompletoCliente": "99. ",
            58.             "clienteLojaResponsavel": "99",
            59.             "clienteCodigoResponsavel": 494168,
            60.             "razaoSocialResponsavel": "KARINE BRASIL",
            61.             "nomeFantasiaResponsavel": "KARINE BRASIL",
            62.             "calculoSaldoReceber": 114.04,
            63.             "calculoSaldoPagar": 0,
            64.             "calculoValorReceber": 114.04,
            65.             "calculoValorPagar": 0,
            66.             "controleNf": "20648",
            67.             "banco": null,
            68.             "agencia": null,
            69.             "digitoAgencia": null,
            70.             "contaBanco": null,
            71.             "descricao": null,
            72.             "chequeBanco": 0,
            73.             "chequeAgencia": "",
            74.             "chequeConta": "000000008",
            75.             "chequeNumero": "",
            76.             "chequeDigitoAgencia": "",
            77.             "chequeDigitoConta": "",
            78.             "modalidade": "Cartão de Crédito",
            79.             "totalParcelas": 3,
            80.             "boletoCentroCusto": null,
            81.             "boletoCentroCustoDescricao": null,
            82.             "boletoIdRemessa": null,
            83.             "boletoIdRetorno": null,
            84.             "boletoEstado": null,
            85.             "boletoSituacaoEnvio": null,
            86.             "boletoNossoNumero": null,
            87.             "codigoAuxiliarFidelidade": "0",
            88.             "codigoAuxiliarCliente": 0,
            89.             "codigoExternoResponsavel": "89832647134",
            90.             "codigoFranqueadora": ".0",
            91.             "fantasiaFranqueadora": "",
            92.             "codigoMatriz": ".0",
            93.             "fantasiaMatriz": "",
            94.             "clienteAtivo": "S",
            95.             "clienteCredito": "L",
            96.             "dadosBoleto": "N",
            97.             "bancoPagamento": null,
            98.             "tipoPagamento": null,
            99.             "modalidadePagamento": null,
            100.             "cpfCnpjReponsavel": "89832647134",
            101.             "email": "kkbbrasil@yahoo.com.br",
            102.            "dataLiquidacao": null,
            103.            "tipoLiquidacao": null,
            104.            "valorPagamento": null
            105.         }
            106.     ]
            107. }







              • Related Articles

              • Presence API - Página Inicial

                Essa API permite o consumo de informações disponíveis nos sistemas Presence através de chamadas de serviço, bem como a inserção de dados nos sistemas. Para ter acesso aos métodos já existentes, ou solicitação da criação de novos métodos, consulte as ...
              • Presence API - INCLUIR_PRODUTO

                Inclusão de Produtos (Atualização e Inclusão) Este módulo é responsável por incluir produtos na base da dados. Parâmetros Campos Tipo Obrigatório Descrição codigo string(8) Não para inclusão, sim para alteração, quando codigoExterno ou codigoLegado ...
              • Presence API - NFE

                Nota Fiscal Este módulo é responsável por listar as notas fiscais da base da dados. Parâmetros Nome Obrigatório Tipo Descrição data_at SIM quando não informado demais campos. Data (AAAA-MM-DDT00:00:00) Data de atualização dos dados. Padrão ISO8601. ...
              • Presence API - INCLUIR_PEDIDO

                Inclusão de Pedidos (Somente Inclusão) Este módulo é responsável por incluir pedidos na base da dados. BODY Pedido Nome Obrigatório Tipo Descrição codigoPedidoExterno Sim String Código do pedido na plataforma dataEmissão Não Data ...
              • Presence API - VENDAS_PAGAMENTOS

                Pagamentos das Vendas Este módulo é responsável por listar os tipos de pagamentos das vendas da base da dados. Parâmetros Nome Obrigatório Tipo Descrição loja Não Texto(2) Código da Loja dt_mov Não Texto Data de movimento da venda. Padrão ISO8601. ...