Conta Receber - inncash/inncash-docs GitHub Wiki

Introdução

Web service responsável pelas as operações relacionadas a conta à receber. 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/accounts-receivable

Corpo da requisição :

{	
    "refresh_all": false,
    "data": [
        {
             "id": "3B18FBC187D8E7978C8510BF894C0FE0",
             "customer_code": "11223344556",
             "store_code": "1234",
             "currency": 1,
             "financial_nature_code": "0123456789",
             "number": "012345678912",
             "installments": "000",
             "prefix": "000",
             "balance": 0.000,
             "type": "NF",
             "cashflow_date": "2021-11-10",
             "amount_fine": 0.00,
             "currency_rate": 0.00,
             "increase_balance": 0.00,
             "decrease_balance": 0.00,
             "barcode": null,
             "debt_collector_code": null,
             "depository_agency": null,
             "emission_date": "2021-11-10",
             "due_date": "2021-11-10",
             "real_due_date": "2021-11-10",
             "value": 0.00,
             "cnab_id": null,
             "bank_number": null,
             "bordero_number": null,
             "bordero_emission_date": null,
             "post_date": "2021-11-10",
             "situation": "0",
             "increase_value": 0.00,
             "decrease_value": 0.00,
             "financial_discount": 0.00,
             "account_number": "0123456789",
             "history": null,
             "receiving_method": "000",
             "primary_instruction": null,
             "secondary_instruction": null,
             "origin_branch": "012345",
             "inncash_value": null,
             "release_date": null,
             "order_number": "012356789",
             "last_move_date": null,
             "discount": null,
             "interest": null,
             "net_value": null,
             "selection_identifier": null,
             "status": null,
             "fine": null,
             "settled_date": "2012-02-12",
             "nfe_key": "123456789",
	     "bank_slip_url":"http://url.inncash.bol/teste",
	     "pix_key":"12121212",
             "payment_method":"001",
        }
    ]
}

Campos

Tipo	Nome	Descrição	Obrigatório	Tamanho
String	id	Identificador único do registro.	X	254
String	customer_code	Código do cliente.	X	11
String	store_code	Identifica cada um das lojas do cliente.	X	6
Int	currency	Identifica qual a moeda que está sendo digitado este título.	X
String	financial_nature_code	Código da natureza.	X	10
String	number	Campo que identifica o número do título.	X	12
String	installments	Parcela do título.		3
String	prefix	Prefixo do título.	X	3
Float	balance	Saldo do título.	X
String	type	Tipo do título.	X	10
Date	cashflow_date	Data do fluxo de caixa.	X
Float	amount_fine	Valor da multa no boleto.	X	decimal(15, 2)
Float	currency_rate	Taxa da moeda do título.	X	decimal(11, 6)
Float	increase_balance	Saldo de acréscimos do título.	X	decimal(16, 2)
Float	decrease_balance	Saldo de decréscimos do título.	X	decimal(16, 2)
String	barcode	Código de barras do título.		44
String	debt_collector_code	Código do portador.		4
String	depository_agency	Código do portador.		5
Date	emission_date	Data de emissão do título.	X
Date	due_date	Data do vencimento nominal do título, inclusive a prorrogação.	X
Date	real_due_date	Data do vencimento real do título.	X
Float	value	Valor original do título.	X	decimal(16, 2)
String	cnab_id	Identificador do título no CNAB.		10
String	bank_number	Número do título no agente cobrador.		40
String	bordero_number	Número do borderô.		6
Date	bordero_emission_date	Data da emissão do borderô.
Date	post_date	Data de contabilização do título.	X
String	situation	Tipo de operação bancária na qual o título foi negociado junto ao agente cobrador.	X	3
Float	increase_value	Valor do acréscimo.	X	decimal(16, 2)
Float	decrease_value	Valor do decréscimo.	X	decimal(16, 2)
Float	financial_discount	Desconto financeiro.	X	decimal(5, 2)
String	account_number	Número da conta corrente.		10
String	history	Campo utilizado para informar um breve comentário sobre o título.		150
String	receiving_method	Método de recebimento.	X	3
String	primary_instruction	Deve informar a instrução primária de cobrança.		2
String	secondary_instruction	Deve informar a instrução secundária da cobrança.		2
String	origin_branch	Filial de origem do título.	X	10
Float	inncash_value	Valor do Inncash.		decimal(15, 2)
Date	release_date	Data de liberação.
String	order_number	Número do pedido ao qual originou o título.		10
Date	last_move_date	Data da última movimentação do título.
Float	discount	Valor do desconto concedido por ocasiãoda baixa do título.		decimal(16, 2)
Float	interest	Valor da taxa de permanência cobrada desde títulos em atraso.		decimal(16, 2)
Float	net_value	Valor líquido do título na baixa.		decimal(16, 2)
String	selection_identifier	Campo identificador de seleção.		2
String	status	Status do título. A = Aberto B = Baixado; R = Reliquidado.		1
Float	fine	Valor cobrado a título de multa a cerca de um recebimento em atraso.		decimal(16, 2)
Date	settled_date	Data da baixa do título.
String	nfe_key	Chave da nota fiscal eletrônica.		254
String	bank_slip_url	URL do boleto		254
String	pix_key	Chave PIX		20
String	payment_method	Forma de pagamento		20

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