2. Início
  4. Bloco de inserções
  6. Quitação financeira
  8. Versão 1.00

Versão 1.00

Estrutura de envio

NomeNívelObrigatórioTipo de dadoDescrição
parcelas0SimEstrutural
parcela1SimEstrural
id_externo1NãoAtributo de elemento (Texto)Utilizado para fazer referência a um registro externo
id_parcela2SimInteiroID do registro da parcela.
valor_total2SimRealValor da soma total dos métodos de pagamentos informados.
metodos_pagamento2SimEstrutural
metodo3SimEstrututal
id_tipo_pagamento4SimInteiroID do tipo de pagamento utilizado no método
valor4SimRealValor abatido pelo método
data_vencimento4SimDataData de vencimento do método. Em caso de controle de
- Cheques: Data para depósito
- Cartão de crédito: Data do recebimento
- Depósito em conta/Transferência: Data da operação
id_operadora_cartao4Não

Sim: Quitação com cartão de crédito		InteiroID da operadora de operadora de cartão utilizada para o lançamento no controle de lançamentos de cartão de crédito.
doc_nsu4Não

Sim: Quitação com cartão de crédito		Texto(30)DOC ou NSU (número sequencial único). Valor utilizado para conferência dos lançamentos de cartão de crédito.
cod_autorizacao4Não

Sim: Quitação com cartão de crédito		Texto(30)Código de autorização. Valor utilizado para conferência dos lançamentos de cartão de crédito.
qtd_parcelas4Não

Sim: Quitação com cartão de crédito		InteiroQuantidade de parcelas utilizada para a quitação do método.
emitente4Não

Sim: Quitação com cheques		Texto(80)Nome do emitente do cheque
emitente_cgc4Não

Sim: Quitação com cheques		Texto(21)CPF ou CNPJ do emitente do cheque
pessoa_fisica4Não

Sim: Quitação com cheques		LógicoDefine o tipo de pessoa emitente do cheque: física ou jurídica.
cod_banco4Não

Sim: Quitação com cheques		Texto(5)Código do banco no BCB
agencia_cheque4Não

Sim: Quitação com cheques		Texto(20)Número da agência do cheque
conta_cheque4Não

Sim: Quitação com cheques		Texto(15)Número da conta do cheque
numero_cheque4Não

Sim: Quitação com cheques		Texto(20)Número do cheque
data_emissao4Não

Sim: Quitação com cheques		DataData de emissão do cheque
observacao_cheque4Não

Sim: Quitação com cheques		Texto(254)Observações gerais informadas no cheque
id_conta_bancaria4NãoInteiroID da conta bancária a ser utilizada para os lançamentos (cheques, depósito em conta ou transferências). Se não informado, o sistema irá assumir a conta bancária padrão.

Exemplos de envio

  • Quitação da parcela 1687501 com o valor de 750.00
  • Métodos utilizados
    • 450,00 em 7x no cartão de crédito
    • 300,00 em cheque com data de depósito para 20/12/2016
<parcelas token="tkn-vinhasoft-001" id_empresa="1" versao="1.00">
   <parcela id_externo="integ_1687501">
      <id_parcela>1687501</id_parcela>
      <valor_total>750.00</valor_total>
      <metodos_pagamento>
         <metodo>
            <id_tipo_pagamento>4</id_tipo_pagamento>
            <valor>450.00</valor>
            <data_vencimento>2016-10-25T00:00:00</data_vencimento>
            <id_operadora_cartao>1</id_operadora_cartao>
            <doc_nsu>000504</doc_nsu>
            <cod_autorizacao>0009996663</cod_autorizacao>
            <qtd_parcelas>7</qtd_parcelas>
         </metodo>
         <metodo>
            <id_conta_bancaria>1</id_conta_bancaria>
            <id_tipo_pagamento>2</id_tipo_pagamento>
            <valor>300.00</valor>
            <data_vencimento>2016-12-20T00:00:00</data_vencimento>
            <emitente>João das Estradas</emitente>
            <emitente_cgc>368.215.255-67</emitente_cgc>
            <pessoa_fisica>true</pessoa_fisica>
            <cod_banco>001</cod_banco>
            <agencia_cheque>18171-7</agencia_cheque>
            <conta_cheque>181268-1</conta_cheque>
            <numero_cheque>00010134-X</numero_cheque>
            <data_emissao>2016-10-25T00:00:00</data_emissao>
            <observacao_cheque>Depositar apenas na data combinada. tel.: 19 3515-1515</observacao_cheque>
         </metodo>
      </metodos_pagamento>
   </parcela>
</parcelas>
  • Quitação das parcelas 1687541 e 1687551
  • As parcelas são consideradas como registros distintos que foram resultados do lançamento do documento no financeiro
  • Neste cenário, a condição de pagamento praticada foi configurada para a geração de duas parcelas no financeiro do documento
  • Parcela 1687541
    • Método utilizado
      • 77.16 em depósito bancário
  • Parcela 1687551
    • Método utilizado
      • 77.16 em 10x no cartão de crédito
<parcelas token="tkn-vinhasoft-001" id_empresa="1" versao="1.00">
   <parcela id_externo="54744">
      <id_parcela>1687541</id_parcela>
      <valor_total>77.16</valor_total>
      <metodos_pagamento>
         <metodo>
            <id_conta_bancaria>1</id_conta_bancaria>
            <id_tipo_pagamento>332</id_tipo_pagamento>
            <valor>77.16</valor>
            <data_vencimento>2016-10-25T00:00:00</data_vencimento>
         </metodo>
      </metodos_pagamento>
   </parcela>
   <parcela id_externo="54745">
      <id_parcela>1687551</id_parcela>
      <valor_total>77.16</valor_total>
      <metodos_pagamento>
         <metodo>
            <id_tipo_pagamento>4</id_tipo_pagamento>
            <valor>77.16</valor>
            <data_vencimento>2016-10-25T00:00:00</data_vencimento>
            <id_operadora_cartao>1</id_operadora_cartao>
            <doc_nsu>000433</doc_nsu>
            <cod_autorizacao>000456214</cod_autorizacao>
            <qtd_parcelas>10</qtd_parcelas>
         </metodo>
      </metodos_pagamento>
   </parcela>
</parcelas>
  • Quitação da parcela 49561 com o valor total de 176.81
  • Neste cenário, foram utilizados 2 cartões de crédito como método de pagamento:
    • 100.00 em 5x
    • 76.81 em 3x
  • Cada tag “metodo” dentro de “metodos_pagamento” representa uma das várias formas de pagamento de uma mesma parcela.
  • Em condições de pagamento classificadas como “cartão de crédito”, se devidamente configuradas, irão gerar apenas uma parcela no controle de parcelas do sistema. As “prestações” geradas pelo controle cartão de cartão de crédito devem ser informadas na tag “qtd_parcelas” e serão tratadas no controle de parcelas de cartão de crédito, dentro do ERP.
<parcelas token="tkn-vinhasoft-001" id_empresa="1" versao="1.00">
  <parcela id_externo="35prc">
    <id_parcela>495651</id_parcela>
    <valor_total>176.81</valor_total>
    <metodos_pagamento>
      <metodo>
        <id_tipo_pagamento>3</id_tipo_pagamento>
        <valor>100.00</valor>
        <data_vencimento>2016-05-29T10:20:01-03:00</data_vencimento>
        <id_operadora_cartao>11</id_operadora_cartao>
        <doc_nsu>000501</doc_nsu>
        <cod_autorizacao>000009750</cod_autorizacao>
        <qtd_parcelas>5</qtd_parcelas>
      </metodo>
      <metodo>
        <id_tipo_pagamento>3</id_tipo_pagamento>
        <valor>76.81</valor>
        <data_vencimento>2016-05-29T10:20:01-03:00</data_vencimento>
        <id_operadora_cartao>11</id_operadora_cartao>
        <doc_nsu>000501</doc_nsu>
        <cod_autorizacao>000009750</cod_autorizacao>
        <qtd_parcelas>3</qtd_parcelas>
      </metodo>
    </metodos_pagamento>
  </parcela>
</parcelas>

Exemplos de retorno

  • Cenário onde a parcela 1687501 encontrava-se em aberto e a 1687551 já havia sido quitada em uma requisição anterior
<retorno>
   <registros>
      <registro>
         <id>integ_1687501</id>
         <id_gerado>0</id_gerado>
         <status>1</status>
         <mensagens>
            <mensagem>
               <id>17</id>
               <descricao>Registro atualizado com sucesso.</descricao>
            </mensagem>
         </mensagens>
      </registro>
      <registro>
         <id>integ_1687551</id>
         <id_gerado>0</id_gerado>
         <status>0</status>
         <mensagens>
            <mensagem>
               <id>60</id>
               <descricao>Não foi possível a quitação da parcela. O status é diferente de "Aberto". Status atual: Quitada</descricao>
            </mensagem>
         </mensagens>
      </registro>
   </registros>
   <status>0</status>
</retorno>
Este artigo foi útil para você? Sim Não