Conta Pagar - inncash/inncash-docs GitHub Wiki

Introdução

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

Corpo da requisição :

{	
    "refresh_all": false,
    "data": [
        {
             "id": "3B18FBC187D8E7978C8510BF894C0FE0",
             "supplier_code": "Corporis.",
             "supplier_store_code": "0001",
             "financial_nature_code": "Harum.",
             "number": "2093686541",
             "installments": "001",
             "prefix": "001",
             "balance": 9758.8,
             "cashflow_date": "2004-11-16",
             "type": "NCC",
             "emission_date": "1997-03-30",
             "due_date": "1981-10-24",
             "real_due_date": "1991-05-28",
             "value": 17011.2,
             "iss": 164.20079744,
             "irrf": 17333.07,
             "bank_code": null,
             "post_date": "1973-01-01",
             "history": null,
             "currency": 6,
             "bordero_number": null,
             "increase_value": 6284399.40075,
             "cashflow": "S",
             "currency_rate": 82271.0,
             "increase_balance": 188.699820833,
             "decrease_value": 735436570.26,
             "decrease_balance": 26766.630201253,
             "origin_branch": "010101",
             "inncash_value": 252615473.6011,
             "payment_method": "001",
             "debt_collector_code": null,
             "cnab_id": null,
             "barcode": null,
             "origin": null,
             "cofins_value": null,
             "pis": null,
             "csll_value": null,
             "release_value": null,
             "pix": null,
	     "carrier":"001",
             "release_date":"2023-01-01",
	     "input_value":"12121.20",
	     "reference_number":"12121",
	     "credit_document":"1212",
	     "period":"03/2023",
             "bank":"001",
	     "account":"1234",
	     "agency":"12",
             "document_rec":"1231",
	     "document_for":"1212121212",
	     "fees":"100.00",
        }
    ]
}

Campos

Tipo	Nome	Descrição	Obrigatório	Tamanho
String	id	Identificador único do registro	X	254
String	supplier_code	Código do fornecedor.	X	11
String	supplier_store_code	Código que identifica a loja do Cliente.	X	6
String	financial_nature_code	Codigo da natureza.	X	20
String	number	Número do título.	X	12
String	installments	Parcela do título.		3
String	prefix	Prefixo do título.	X	3
Double	balance	Saldo à receber.	X
Date	cashflow_date	Data do fluxo de caixa.	X
String	type	Tipo do título.	X	3
Date	emission_date	Data de emissão do título.	X
Date	due_date	Vencimento do título.	X
Date	real_due_date	Vencimento real do título.	X
Float	value	Valor do título.	X	decimal(16, 2)
Float	iss	Valor do ISS.	X	decimal(16, 2)
Float	irrf	Valor do IRRF.	X	decimal(16, 2)
String	bank_code	Código do banco de pagamento.		3
Date	post_date	Data de contabilização do título.	X
String	history	Informar um breve comentário sobre o título.		150
Int	currency	Moeda do título.	X	2
String	bordero_number	Número do bordero ao qual esse título foi anexado para envio a banco.		6
Float	increase_value	Valor de acréscimo.	X	decimal(16, 2)
String	cashflow	Fluxo de caixa.		1
Float	currency_rate	Taxa da moeda.	X	decimal(16, 2)
Float	increase_balance	Saldo do acréscimo.	X	decimal(16, 2)
Float	decrease_balance	Saldo do decréscimo.	X	decimal(16, 2)
String	origin_branch	Filial de origem.	X	8
Float	inncash_value	Valor do Inncash		decimal(16, 2)
String	payment_method	Forma de pagamento.	X	3
String	debt_collector_code	Código do portador.		3
String	cnab_id	Identificador CNAB.		10
String	barcode	Codigo de barras.		48
String	origin	Origem do título.		8
Float	cofins_value	Valor COFINS.		decimal(14, 2)
Float	pis	Valor do PIS.		decimal(14, 2)
Float	csll_value	Valor do CSLL.		decimal(14, 2)
Float	release_value	Valor liberado.		decimal(12, 2)
String	pix	PIX.		254
String	carrier	Portador		4
String	release_date	Data de baixa		10
String	input_value	Valor imposto		decimal(16, 2)
String	reference_number	Numero de referencia		20
String	bank	Banco		3
String	account	Conta		20
String	agency	Agencia		10
String	document_rec	Documento de recebimento		20
String	document_for	CGC/CPF do fornecedor		14
Float	fees	Multa		20
String	period	Período DARF/GPS		20
String	company_id	id da empresa no inncash		20

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