Atualização de Títulos - inncash/inncash-docs Wiki

Introdução

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.


Webservice para teste dos Webhooks

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


Eventos

Liberação de Títulos (title_release)

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
}

Dados bancários (bank_data)

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_number":"0015478",
      "account_digit":"1",
      "agency":"1256",
      "agency_digit":"1",
      "general_code": "55040699904",
      "provider_name": "Teste",
      "type": "provider"
   },
   "event":"bank_data",
   "company_id":15
}

Acréscimo (increase)

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
}

Decréscimo (decrease)

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
}

Data do fluxo de caixa (cash_flow_date)

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
}

Forma de pagamento (payment_form)

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
}

Forma de pagamento do fornecedor (provider_payment_form)

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
}

Valor do InnCash (inncash_value)

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
}

Código de barras (barcode)

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
}

Link do bolepix (bolepix_url)

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_payable"
   },
   "event":"bolepix_url",
   "company_id":15
}

Chave QRCODE (qrcode_key)

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
}

Chave Pix (pix_key)

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. No contas a pagar será passado account_payable e no fornecedor será passado account_receivable.

{
   "id":"22fcb8350704cb26447b694edc369252",
   "data":{
      "key": "3RRFFKO5KO34L3",
      "type": "account_payable"
   },
   "event":"pix_key",
   "company_id":15
}

Descrição dos campos

Todos os campos são obrigatórios