Saldo Bancario - inncash/inncash-docs GitHub Wiki

Introdução

Web service responsável pelas as operações relacionadas a saldo bancário. Existem dois endereços nesse web service, um sendo referente atualização/criação de dados, e outro referente a exclusão. Pontos de atenção:

  1. Nas requisições será necessário especificar o identificador da empresa por meio do "company_id" (fornecido pela Innova no momento de implantação). Ele deverá ser enviado no header da requisição com esse formato: Company-Ids: []
  2. O campo "refresh_all" quando ativo irá excluir todos os registros da tabela para a empresa específica e importar novamente do zero. Essa opção deve ser utilizada no momento de implantação para testes, não é recomendável utilizar em produção.

Requisições

Post: URL_BASE/bank-balances

Corpo da requisição :

{	
    "refresh_all": false,
    "data": [
        {
             "id": "3B18FBC187D8E7978C8510BF894C0FE0",
             "agency": "00001",
             "bank_code": "000",
             "account": "0123456789",
             "current_balance_date": "2018-02-14",
             "currency": "00",
             "current_balance": 181985.796153,
             "previous_balance_date": null,
             "previous_balance": 418123.105811858,
             "balance_reconciled": 0.572264,
             "group_name":"saldo_bancario",
        }
    ]
}

Campos

Tipo Nome Descrição Obrigatório Tamanho
String id Identificador único do registro. X 254
String agency Código da agência do agente cobrador. X 5
String bank_code Código do agente cobrador para o controle de saldos. X 3
String account Número da conta corrente da empresa no agente cobrador. X 10
Date current_balance_date Data do saldo atual da empresa no agente cobrador armazenado neste arquivo. X
String currency Segunda moeda do saldo bancario. X 2
Float current_balance Saldo atual da empresa no agente cobrador. Este saldo deverá estar atualizado a cada transação bancária. X decimal(17, 2)
Date previous_balance_date Data do saldo anterior da empresa no a-gente cobrador armazenado neste arquivo.
Float previous_balance Saldo anterior da empresa no agente cobrador. X decimal(17, 2)
Float balance_reconciled Valor do saldo bancário reconciliado. É composto apenas pelos movimentos bancários já conciliados. X decimal(17, 2)
String table_company_code Nome da Tabela origem no ERP 20
String group_name Nome da Tabela origem no ERP 20

Delete: URL_BASE/bank-balances/{id}

O "id" é o campo que identificador que que define o registro

Resposta HTTP

Código Mensagem Descrição
200 Operação realizada com sucesso
422 Data invalid Ocorre quando alguma informação obrigatória deixa de ser enviada
404 Configurações de empresa necessárias não encontradas Dentro do Inncash, a configuração para essa tabela não foi encontrada, entre em contato com o administrador do sistema.
500 Erro interno do servidor Erro interno no servidor
⚠️ **GitHub.com Fallback** ⚠️