Movimento Bancario - inncash/inncash-docs GitHub Wiki

Introdução

Web service responsável pelas as operações relacionadas a movimento 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:

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: []
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-transactions

Corpo da requisição :

{	
    "refresh_all": false,
    "data": [
        {
             "id": "3B18FBC187D8E7978C8510BF894C0FE0",
             "origin_branch": "010101",
             "date": "1976-09-27",
             "type": "NF",
             "currency": "01",
             "value": 267245.102910648,
             "financial_nature_code": "818887496",
             "ccd": "Fugiat.",
             "debt_value_class": null,
             "bank_code": "000",
             "debt_agency_code": "0000",
             "account_code": "0000000000",
             "bank_check_number": null,
             "document_number": null,
             "due_date": null,
             "receivable_payable": "P",
             "recipient": null,
             "history": null,
             "document_type": "VL",
             "currency_value_2": 63.6766558,
             "prefix": null,
             "number": null,
             "installment": null,
             "customer_supplier_code": null,
             "store_code": "0001",
             "typing_date": "1982-11-11",
             "low_reason": null,
             "sequence": null,
             "available_date": "1981-10-02",
             "supplier_code": null,
             "document_reconciled": null,
             "origin_id": null,
             "status": null,
             "ccc": null,
             "credit_class_value": null,
             "debit_accounting_item": "Corporis.",
             "credit_accounting_item": null,
             "currency_rate": 0,
             "bank_authentication": null,
             "erp_sequential": "1317062068",
             "favored_name": "Miss Cordie Altenwerth MD",
             "favored_document": "00000000000000",
             "barcode": "000000000000000000000000000000000000000000000000",
             "modality": "1",
             "favored_bank_code": "001",
             "favored_agency": "00001",
             "favored_agency_digit": "1",
             "favored_account_number": "0000000001",
             "favored_account_digit": "1",
             "agreement_code":"12121",
             "table_company_code":"01",
             "group_name":"cost_center",
             "branch_token":"123456789",
             "company_token":"123456789",
             "data_origin":"DATA-SYNC",
             "company_id":"35"
        }
    ]
}

Campos

Tipo	Nome	Descrição	Obrigatório	Tamanho
String	id	Identificador único do registro.	X	254
String	origin_branch	Filial de origem do movimento.	X	6
Date	date	Data da movimentação financeira.	X
String	type	Tipo de movimento, CH=Cheque, EF=Em efetivo, TF=Depósito.	X	3
String	currency	Tipo da Moeda. Identifica a forma monetária que foi transacionada a movimentação financeira.	X	2
Float	value	Valor do documento que está sendo lançado no movimento de caixa.	X	decimal(17, 2)
String	financial_nature_code	Código da natureza do documento lançado manualmente no movimento de caixa.	X	10
String	ccd	Neste local poderá ser informado o centro de custo a débito (extra contábil) para posterior contabilização.	X	9
String	debt_value_class	Classe de valor contábil débito. Digite um código válido ou utilize.		9
String	bank_code	Código que identifica o agente cobrador do movimento do caixa.	X	3
String	debt_agency_code	Código que identifica a agência do agente cobrador referente a movimentação do caixa.	X	5
String	account_code	Número da conta-corrente da empresa no agente cobrador.	X	10
String	bank_check_number	Número do cheque utilizado na movimentação bancária.		15
String	document_number	Número do documento que deu origem a movimentação de caixa.		50
Date	due_date	Data do vencimento da movimentação bancária. Se for cheque pré-datado, o sistema gera um título a receber.
String	receivable_payable	Campo que define se o movimento do caixa é a crédito ou a débito.	X	1
String	recipient	Descrição referente ao beneficiário do movimento de caixa.		30
String	history	Descrição referente ao documento que está sendo lançado no movimento de caixa.		40
String	document_type	Tipo de título envolvido na movimentação (DP).	X	2
Float	currency_value_2	Valor na Moeda 2 do movimento de caixa.	X	decimal(14, 2)
String	prefix	Prefixo do título do documento lança do manualmente no movimento do caixa.		3
String	number	Número do título lançado manualmente nomovimento de caixa.		9
String	installment	Parcela do título do documento manual lançado no movimento de caixa.		3
String	customer_supplier_code	Código do cliente/fornecedor utilizado no movimento do caixa.		11
String	store_code	Loja do Cliente/Fornecedor.	X	4
Date	typing_date	Data da digitação do movimento.	X
String	low_reason	Identifica qual o motivo de uma determinada baixa.		3
String	sequence	Sequencia de baixas de um determinado título. Identifica quantas baixas parciais um título sofreu no sistema.		2
Date	available_date	Data da disponibilização (Data da Baixa + Retenção Bancária).	X
String	supplier_code	Código do fornecedor desta movimentação.		11
String	document_reconciled	Identificador de documento reconciliado.		1
String	origin_id	Identificação origem do movimento.		32
String	status	Campo que que marca os registros deleta-dos da movimentação do caixa, inibindo ocancelamento por usuários.		1
String	ccc	Neste local poderá se informado o cen- tro de custo a crédito (extra contábil) para posterior contabilização.		9
String	credit_class_value	Classe valor contábil crédito. Digite um código válido ou utilize.		9
String	debit_accounting_item	Item contábil débito. Digite um código válido ou utilize.	X	9
String	credit_accounting_item	Item contábil crédito. Digite um código válido ou utilize.		9
Float	currency_rate	Taxa contratada na moeda do título.	X	decimal(11, 6)
String	bank_authentication	Autenticação bancária.		25
String	erp_sequential	Sequencial do ERP.	X	20
String	favored_name	Nome favorecido.		60
String	favored_document	CNPJ/CPF favorecido.		14
String	barcode	Código de barra.		48
String	modality	Modalidade.		5
String	favored_bank_code	Código do banco favorecido.		3
String	favored_agency	Agência favorecido.		5
String	favored_agency_digit	Dígito da agência favorecido.		1
String	favored_account_number	Número da conta favorecido.		12
String	favored_account_digit	Dígito da conta favorecido.		1
String	agreement_code	Codigo do convenio		1
String	table_company_code	Nome da Tabela origem no ERP		20
String	group_name	Nome da Tabela origem no ERP		20
String	branch_token	Id único da filial na tabela de bancos por cliente		40
String	company_token	Id único da empresa na tabela de bancos por cliente		10
String	data_origin	Conteudo da origem que veio os dados para o inncash		40
String	company_id	id da empresa no inncash		20

Delete: URL_BASE/bank-transactions/{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