Atualização de Títulos - inncash/inncash-docs GitHub Wiki
Os eventos serão disparados ao Webhook do cliente pelo InnCash quando ações específicas forem executadas dentro da plataforma, e o cliente precisa tratar cada um dos eventos fazendo as ações necessárias no ERP. Para facilitar os testes e o desenvolvimento, fornecemos um webservice para que o cliente possa executar as requisições que irão disparar os Webhooks cadastrados na plataforma.
Patch: URL_BASE/erps
Na requisição 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-Id: 1.
Esse webservice recebe como parâmetro o mesmo corpo de requisição que será enviada ao cliente via Webhook.
O InnCash irá fazer uma requisição ao webhook cadastrado pelo cliente via POST, e para marcar a integração como sucesso deve receber um status code 200
Este método tem o objetivo de atualizar o conteúdo do campo de data de liberação no título tanto no contas a pagar quanto no contas a receber, onde será diferenciado pelo atributo type
. No contas a pagar será passado account_payable
e no contas a receber será passado account_receivable
.
{
"id":"22fcb8350704cb26447b694edc369252",
"data":{
"date_release": "2021-12-01",
"type": "account_payable"
},
"event":"title_release",
"company_id":15
}
Este método tem o objetivo de atualizar o conteúdo dos dados bancários dentro do cadastro do fornecedor.
{
"id":"22fcb8350704cb26447b694edc369252",
"data":{
"bank":"001",
"account_type": "1",
"account_number":"0015478",
"account_digit":"1",
"agency":"1256",
"agency_digit":"1",
"type": "provider"
},
"event":"bank_data",
"company_id":15
}
Este método tem o objetivo de atualizar o conteúdo dos dados bancários dentro do cadastro do fornecedor no caso de TED de titularidade diferente, portanto possui campos extras para especificar o nome e cpf/cnpj do titular.
{
"id":"22fcb8350704cb26447b694edc369252",
"data":{
"bank":"001",
"account_type": "1",
"account_number":"0015478",
"account_digit":"1",
"agency":"1256",
"agency_digit":"1",
"general_code": "55040699904",
"provider_name": "Teste",
"type": "provider"
},
"event":"bank_data_with_different_holder",
"company_id":15
}
Este método tem o objetivo de atualizar o conteúdo do acréscimo do título tanto no contas a pagar quanto no contas a receber, onde será diferenciado pelo atributo type
. No contas a pagar será passado account_payable
e no contas a receber será passado account_receivable
.
{
"id":"22fcb8350704cb26447b694edc369252",
"data":{
"addition_balance": 10.50,
"added_value": 10.50,
"type": "account_receivable"
},
"event":"increase",
"company_id":15
}
Este método tem o objetivo de atualizar o conteúdo do decréscimo do título tanto no contas a pagar quanto no contas a receber, onde será diferenciado pelo atributo type
. No contas a pagar será passado account_payable
e no contas a receber será passado account_receivable
.
{
"id":"22fcb8350704cb26447b694edc369252",
"data":{
"decrease_balance": 10.50,
"decrease_value": 10.50,
"type": "account_payable"
},
"event":"decrease",
"company_id":15
}
Este método tem o objetivo de atualizar o conteúdo da data de fluxo do título no contas a pagar, no contas a receber e nos itens do pedido de venda, onde será diferenciado pelo atributo type
. No contas a pagar será passado account_payable
, contas a receber será passado account_receivable
e no pedido de venda será sale_order
.
{
"id":"22fcb8350704cb26447b694edc369252",
"data":{
"cash_flow": "2021-12-01",
"type": "sale_order"
},
"event":"cash_flow_date",
"company_id":15
}
Este método tem o objetivo de atualizar o conteúdo da forma de pagamento dentro do título tanto para o contas a pagar quanto para o contas a receber, onde será diferenciado pelo atributo type
. No contas a pagar será passado account_payable
e no contas a receber será account_receivable
.
{
"id":"22fcb8350704cb26447b694edc369252",
"data":{
"payment_form": "001",
"type": "account_payable"
},
"event":"payment_form",
"company_id":15
}
Este método tem o objetivo de atualizar o conteúdo da forma de pagamento dentro do cadastro do fornecedor ou cliente, onde será diferenciado pelo atributo type
. No fornecedor será passado account_payable
e no cliente será account_receivable
.
{
"id":"22fcb8350704cb26447b694edc369252",
"data":{
"payment_form": "001"
"type": "account_receivable"
},
"event":"provider_payment_form",
"company_id":15
}
Este método tem o objetivo de atualizar o conteúdo do campo valor(campo customizado) do título tanto no contas a pagar quanto no contas a receber, onde será diferenciado pelo atributo type
. No contas a pagar será passado account_payable
e no contas a receber será passado account_receivable
.
{
"id":"22fcb8350704cb26447b694edc369252",
"data":{
"inncash_value": 10.50,
"type": "account_payable"
},
"event":"inncash_value",
"company_id":15
}
Este método tem o objetivo de atualizar o conteúdo do campo código de barras do título no contas a pagar no ERP do cliente.
{
"id":"22fcb8350704cb26447b694edc369252",
"data":{
"barcode": "3RRFFKO5KO34L3",
"type": "account_payable"
},
"event":"barcode",
"company_id":15
}
Este método tem o objetivo de atualizar o conteúdo do link do bolepix gerado no InnCash para o contas a receber no ERP do cliente.
{
"id":"22fcb8350704cb26447b694edc369252",
"data":{
"slip_url": "3RRFFKO5KO34L3",
"type": "account_receivable"
},
"event":"bolepix_url",
"company_id":15
}
Este método tem o objetivo de atualizar o conteúdo do QRCODE(campo customizado) gerado no InnCash para o contas a pagar no ERP do cliente.
{
"id":"22fcb8350704cb26447b694edc369252",
"data":{
"key": "3RRFFKO5KO34L3",
"type": "account_payable"
},
"event":"qrcode_key",
"company_id":15
}
Este método tem o objetivo de atualizar o conteúdo da chave PIX(campo customizado) gerado no InnCash para dentro do contas a pagar e dentro do cadastro do fornecedor, onde será diferenciado pelo atributo type. Para o fornecedor o type será provider
e no cliente será passado como customer
.
{
"id":"22fcb8350704cb26447b694edc369252",
"data":{
"key": "3RRFFKO5KO34L3",
"type": "provider"
},
"event":"pix_key",
"company_id":15
}
Este método tem o objetivo de atualizar o conteúdo da data de vencimento dentro do título tanto para o contas a pagar quanto para o contas a receber, onde será diferenciado pelo atributo type
. No contas a pagar será passado account_payable
e no contas a receber será account_receivable
.
{
"id":"22fcb8350704cb26447b694edc369252",
"data":{
"security_due_date": "2022-02-02",
"type": "account_payable"
},
"event":"change_security_due_date",
"company_id":15
}
Este método tem o objetivo de atualizar o conteúdo de dados de darf e GPS dentro do título tanto para o contas a pagar quanto para o contas a receber, onde será diferenciado pelo atributo type
. No contas a pagar será passado account_payable
e no contas a receber será account_receivable
.
{
"id":"22fcb8350704cb26447b694edc369252",
"data":{
"period":"12/2022",
"code": "12121221",
"fees":"100.00",
"value_rent":"1256.00",
"added_value":"100.00",
"document": "55040699904",
"type": "account_payable",
},
"event":"update_darf_and_gps",
"company_id":15
}
Este método tem o objetivo de atualizar o conteúdo dos dados do fornecedor dentro do cadastro do fornecedor no caso de TED de titularidade diferente, portanto possui campos extras para especificar o nome e cpf/cnpj do titular.
{
"id":"22fcb8350704cb26447b694edc369252",
"data":{
"general_code":"10101010101",
"provider_name": "TESTE SISTEMA",
"type": "provider"
},
"event":"supplier_with_different_holder",
"company_id":15
}
Este método tem o objetivo de atualizar o conteúdo do nosso numero no titulo a receber quando quem gera essa informação é a instituição financeira.
{
"id":"22fcb8350704cb26447b694edc369252",
"data":{
"our_number":"10101010101",
"type": "provider"
},
"event":"our_number",
"company_id":15
}
Este método tem o objetivo de atualizar o conteúdo do cnpj/cpf no titulo a pagar para enviar para o banco a informação
{
"id":"22fcb8350704cb26447b694edc369252",
"data":{
"document":"10101010101",
"type": "provider"
},
"event":"change_provider_document",
"company_id":15
}
Todos os campos são obrigatórios
Tipo | Nome | Descrição |
---|---|---|
String | id | ID único do título gerado pelo cliente no momento de integração |
Int | company_id | Identificador da empresa fornecido pela Innova no momento de implantação |
String | type | Tipo da atualização (account_payable, account_receivable, sale_order, customer, provider) |
Date | date_release | Data de liberação do pagamento |
Float | decrease_value | Valor do decréscimo |
Float | decrease_balance | Saldo do decréscimo |
Float | added_value | Valor do acréscimo |
Float | addition_balance | Saldo do acréscimo |
Date | cash_flow | Data fluxo caixa |
String | payment_form | Método de pagamento do título |
String | customer_payment_form | Método de pagamento do cliente |
Float | InnCash_value | Valor do InnCash |
String | barcode | Código de barra |
String | agency_digit | Digito da Agência |
String | agency | Agência |
String | account_type | Tipo da conta (1 - Corrente, 2 - Poupança) |
String | account_digit | Dígito da Conta |
String | account_number | Número da conta |
String | bank | Banco |
String | key | Chave PIX ou QR Code (dependendo do evento) |
String | slip_url | Link/Url do borderô |
Date | security_due_date | Data de vencimento do título |