Bancos - inncash/inncash-docs GitHub Wiki

Introdução

Web service responsável pelas as operações relacionadas a bancos. 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_ids" (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/banks

Corpo da requisição :

{
    "refresh_all": false,
    "data": [
        {
             "code":"3",
             "cash_flow":"1" ,
             "coin":"1",
	     "standard_account_type": "1",
             "account_type":"1",
             "agency":"7448",
             "agency_check_digit":"",
             "account_number":"2067",
             "account_check_digit":"2",
             "name":"BANCO ITAU UNIBANCO",
             "short_name":"ITAU",
             "id":"3B18FBC187D8E7978C8510BF894C0FE0",
             "account_type_customer":"1",
             "code_customer":"001",
             "blocked":"1",
        },
        {
            "code":"237",
            "cash_flow":"1",
            "coin":"1",
	    "standard_account_type": "1",
            "account_type":"1",
            "agency":"1118",
            "agency_check_digit":"5",
            "account_number":"2941",
            "account_check_digit":"6",
            "name":"BRADESCO S/A",
            "short_name":"BRADESCO CC",
            "id":"654B07AE7112314154EFD38E94367D6F",
            "account_type_customer":"1",
            "code_customer":"001",
            "blocked":"1",
        }
    ]
}

Campos

Tipo	Nome	Descrição	Obrigatório	Tamanho
String	code	Código do banco	X	4
String	cash_flow	Fluxo de Caixa		1
Int	coin	Moeda	X	2
String	standard_account_type	Tipo da conta padrão		2
String	account_type	Tipo da conta		2
String	agency	Número da agência	X	7
String	agency_check_digit	Dígito verificador da agência		6
String	account_number	Número da conta	X	10
String	account_check_digit	Digito verificador da conta		1
String	name	Nome do banco	X	70
String	short_name	Nome reduzido		15
String	id	Identificador único do registro	X	254
String	account_type_customer	Tipo de Conta no ERP do Cliente		1
String	code_customer	Codigo do banco no ERP		3
String	blocked	Bloqueado, Sim ou Não		1

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