Resumo - inncash/inncash-docs GitHub Wiki

Documentação Completa de Integrações Inncash - Migração ADVPL

Documento consolidado com todas as integrações, endpoints, bodies e eventos para migração ao ERP ADVPL

📌 Informações Gerais

URLs Base

Ambiente URL
Produção https://api.app.inn.cash
Teste https://api.staging.inn.cash

Headers Obrigatórios

Authorization: Bearer {token}
Company-Ids: [{company_id}]
Content-Type: application/json

Respostas HTTP Padrão

Código Mensagem Descrição
200 - Operação realizada com sucesso
422 Data invalid Informação obrigatória não enviada
404 Configurações não encontradas Configuração da empresa não encontrada no Inncash
500 Erro interno do servidor Erro interno no servidor

🔐 1. Autenticação

Descrição: Autenticação via e-mail e senha para obter token com validade de 24 horas.

Endpoints

Ambiente URL
Produção https://api.app.inn.cash/auth
Teste https://api.staging.inn.cash/auth

Request

Método: POST

{
   "email": "[email protected]",
   "password": "teste123"
}

Response

{
   "data": {
       "token": "1|HJ2ZfYddjIiii14854T2EDF"
   }
}

Uso: Authorization: Bearer 1|HJ2ZfYddjIiii14854T2EDF

🏦 2. Bancos

Endpoint: POST URL_BASE/banks
Delete: DELETE URL_BASE/banks/{id}

Request Body

{
    "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"
        }
    ]
}

Campos

Tipo Nome Descrição Obrigatório Tamanho
String id Identificador único do registro X 254
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 Dígito verificador da conta 1
String name Nome do banco X 70
String short_name Nome reduzido 15
String account_type_customer Tipo de Conta no ERP do Cliente 1
String code_customer Código do banco no ERP 3
String blocked Bloqueado (S/N) 1

📊 3. Centro de Custo

Endpoint: POST URL_BASE/cost-center
Delete: DELETE URL_BASE/cost-center/{id}

Request Body

{
    "refresh_all": false,
    "data": [
        {
            "cost": "6435643",
            "description": "Teste",
            "id": "BAC6E27842123434520A9A488468BBE806C"
        }
    ]
}

Campos

Tipo Nome Descrição Obrigatório Tamanho
String id Identificador único do registro X 254
String cost Código do Centro de Custo X 15
String description Descrição do centro de custo X 70

📑 4. Classe de Valor

Endpoint: POST URL_BASE/value-class
Delete: DELETE URL_BASE/value-class/{id}

Request Body

{
    "refresh_all": false,
    "data": [
        {
            "code": "3",
            "description": "teste",
            "id": "3B18FBC187D8E7978C8510BF894C0FE0"
        }
    ]
}

Campos

Tipo Nome Descrição Obrigatório Tamanho
String id Identificador único do registro X 254
String code Código da classe de valor X 10
String description Descrição da classe de valor X 40

📝 5. Natureza

Endpoint: POST URL_BASE/financial-natures
Delete: DELETE URL_BASE/financial-natures/{id}

Request Body

{
    "refresh_all": false,
    "data": [
        {
            "code": "3",
            "description": "teste",
            "id": "3B18FBC187D8E7978C8510BF894C0FE0"
        }
    ]
}

Campos

Tipo Nome Descrição Obrigatório Tamanho
String id Identificador único do registro X 254
String code Código da Natureza X 30
String description Descrição da Natureza X 70

📋 6. Item Contábil

Endpoint: POST URL_BASE/accounting-items
Delete: DELETE URL_BASE/accounting-items/{id}

Request Body

{
    "refresh_all": false,
    "data": [
        {
            "item": "3",
            "description": "teste",
            "id": "3B18FBC187D8E7978C8510BF894C0FE0"
        }
    ]
}

Campos

Tipo Nome Descrição Obrigatório Tamanho
String id Identificador único do registro X 254
String item Código do Item Contábil X 10
String description Descrição do Item Contábil X 30

👥 7. Cliente

Endpoint: POST URL_BASE/customers
Delete: DELETE URL_BASE/customers/{id}

Request Body

{
    "refresh_all": false,
    "data": [
        {
            "id": "3B18FBC187D8E7978C8510BF894C0FE0",
            "code": "1489409425",
            "store_code": "0001",
            "legal_entity": "F",
            "state_address": "SC",
            "sales_group": "4390dk1",
            "document": "94299378204020",
            "name": "Wolff-Raynor",
            "trade_name": "Koepp Wuckert and Boyle",
            "address": "48300 Ceasar Divide",
            "type": "S",
            "city_address": "Port Sydney",
            "neighborhood_address": "269 Becker Place",
            "receiving_method": "001",
            "billing_address": "919 Schmidt Lights",
            "billing_neighborhood_address": "356 Kemmer Parkway",
            "postal_code": "88000000",
            "billing_postal_code": "88000000",
            "billing_city_address": "Simeonmouth",
            "billing_state_address": "UC",
            "payment_method": "Nj0",
            "ddd_code": "48",
            "telephone": "+17479752821",
            "country": "105",
            "sector": "123",
            "district": "124",
            "group": "001",
            "subgroup": "01",
            "cond": "001",
            "limited": "1325.20",
            "balance_owed": "1325.20",
            "bank1": "001",
            "bank2": "003",
            "risk": "A",
            "class": "A",
            "first_purchase": "10/01/2023",
            "last_purchase": "10/10/2023",
            "telephone_second": "+17479752821",
            "mail": "[email protected]",
            "mail_nfe": "[email protected]",
            "mail_credit_first": "[email protected]",
            "mail_credit_second": "[email protected]",
            "mail_finance": "[email protected]",
            "complement": "teste",
            "blocked": "S",
            "agency_customer": "1234",
            "bank_customer": "001",
            "agency_check_digit": "1",
            "account_check_digit": "1",
            "account_number": "1234567",
            "standard_account_type": "1",
            "nome_bank": "BANCO DO BRASIL",
            "document_customer": "12213515",
            "type_charge": "1",
            "average_purchase": "30",
            "average_delay": "30",
            "type_pix": "1",
            "key_pix": "12121"
        }
    ]
}

Campos Principais

Tipo Nome Descrição Obrigatório Tamanho
String id Identificador único do registro X 254
String code Código do cliente X 11
String store_code Código da loja do Cliente X -
String legal_entity Tipo de pessoa (F/J) X 1
String document CNPJ ou CPF X 14
String name Nome ou razão social X 250
String trade_name Nome reduzido X 250
String address Endereço X 60
String type Tipo de Cliente (L,F,R,S,X) X 1
String state_address UF do cliente 3
String city_address Município 70
String neighborhood_address Bairro 100
String postal_code CEP 10
String receiving_method Método de recebimento 3
String payment_method Método de pagamento 3
String ddd_code DDD 3
String telephone Telefone 20
String mail Email 20
String blocked Status (1=bloqueado, 2=desbloqueado) 1
String type_pix Tipo de PIX 10
String key_pix Chave PIX 40

🏢 8. Fornecedor

Endpoint: POST URL_BASE/suppliers
Delete: DELETE URL_BASE/suppliers/{id}

Request Body

{
    "refresh_all": false,
    "data": [
        {
            "id": "3B18FBC187D8E7978C8510BF894C0FE0",
            "code": "01234567890",
            "store_code": "0123",
            "type": "0",
            "state_address": "sc",
            "document": "01234567890123",
            "name": "Company Name",
            "trade_name": "trade name",
            "address": "some address",
            "neighborhood_address": "neighborhood address",
            "city_address": "city address",
            "bank_code": null,
            "supplier_agency_code": null,
            "financial_nature_code": "0123456789",
            "account_number": null,
            "payment_condition": "000",
            "accounting_account_code": null,
            "payment_method": "000",
            "document_other_ownership": null,
            "name_other_ownership": null,
            "sending_supplier_voucher": null,
            "bank_account_type": null,
            "agency_digit": null,
            "account_digit": null,
            "pix_key": null,
            "pix_type": null
        }
    ]
}

Campos Principais

Tipo Nome Descrição Obrigatório Tamanho
String id Identificador único do registro X 254
String code Código do fornecedor X 11
String store_code Código da loja X 6
String type Tipo do fornecedor X 1
String state_address UF do endereço X 3
String document CNPJ/CPF 14
String name Nome ou razão social X 200
String trade_name Nome fantasia 100
String address Endereço X 60
String city_address Município X 70
String financial_nature_code Natureza do título X 40
String payment_method Método de pagamento X 5
String bank_code Código do banco 3
String supplier_agency_code Código da Agência 5
String account_number Número da conta 15
String agency_digit Dígito da agência 1
String account_digit Dígito da conta 1
String pix_key Chave PIX 254
String pix_type Tipo do PIX 6

📅 9. Feriado

Endpoint: POST URL_BASE/holidays
Delete: DELETE URL_BASE/holidays/{id}

Request Body

{
    "refresh_all": false,
    "data": [
        {
            "id": "3B18FBC187D8E7978C8510BF894C0FE0",
            "date": "2021-10-28"
        }
    ]
}

Campos

Tipo Nome Descrição Obrigatório Tamanho
String id Identificador único do registro X 254
String date Data do feriado (YYYY-MM-DD) X 10

💱 10. Moeda

Endpoint: POST URL_BASE/currencies
Delete: DELETE URL_BASE/currencies/{id}

Request Body

{
    "refresh_all": false,
    "data": [
        {
            "id": "3B18FBC187D8E7978C8510BF894C0FE0",
            "date": "2021-10-29",
            "currency_conversion_rate_1": "1.210000",
            "currency_conversion_rate_2": "1.210000",
            "currency_conversion_rate_3": "1.210000",
            "currency_conversion_rate_4": "1.210000",
            "currency_conversion_rate_5": "1.210000",
            "currency_conversion_rate_6": "1.210000",
            "currency_conversion_rate_7": "1.210000",
            "currency_conversion_rate_8": "1.210000",
            "currency_conversion_rate_9": "1.210000"
        }
    ]
}

Campos

Tipo Nome Descrição Obrigatório Tamanho
String id Identificador único do registro X 254
String date Data de referência X 10
Float currency_conversion_rate_1 Taxa Real X decimal(11,6)
Float currency_conversion_rate_2 Taxa Dólar X decimal(11,6)
Float currency_conversion_rate_3 Taxa UFIR X decimal(11,6)
Float currency_conversion_rate_4 Taxa Euro X decimal(11,6)
Float currency_conversion_rate_5 Taxa Iene X decimal(11,6)
Float currency_conversion_rate_6 Taxa IPCA X decimal(11,6)
Float currency_conversion_rate_7 Taxa Libra X decimal(11,6)
Float currency_conversion_rate_8 Taxa Franco X decimal(11,6)
Float currency_conversion_rate_9 Taxa Peso X decimal(11,6)

💰 11. Conta a Pagar

Endpoint: POST URL_BASE/accounts-payable
Delete: DELETE URL_BASE/accounts-payable/{id}

Request Body

{
    "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.20,
            "irrf": 17333.07,
            "bank_code": null,
            "post_date": "1973-01-01",
            "history": null,
            "currency": 6,
            "bordero_number": null,
            "increase_value": 6284399.40,
            "cashflow": "S",
            "currency_rate": 82271.0,
            "increase_balance": 188.69,
            "decrease_value": 735436570.26,
            "decrease_balance": 26766.63,
            "origin_branch": "010101",
            "inncash_value": 252615473.60,
            "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 Principais

Tipo Nome Descrição Obrigatório Tamanho
String id Identificador único X 254
String supplier_code Código do fornecedor X 11
String supplier_store_code Código da loja X 6
String financial_nature_code Código 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 a 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 X -
Date due_date Vencimento do título X -
Date real_due_date Vencimento real 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)
Date post_date Data de contabilização X -
Int currency Moeda do título X 2
Float increase_value Valor de acréscimo X decimal(16,2)
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
String payment_method Forma de pagamento X 3
String barcode Código de barras 48
String pix PIX 254
Float fees Multa 20
String period Período DARF/GPS 20

💵 12. Conta a Receber

Endpoint: POST URL_BASE/accounts-receivable
Delete: DELETE URL_BASE/accounts-receivable/{id}

Request Body

{
    "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.00,
            "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 Principais

Tipo Nome Descrição Obrigatório Tamanho
String id Identificador único X 254
String customer_code Código do cliente X 11
String store_code Código da loja X 6
Int currency Moeda do título X -
String financial_nature_code Código da natureza X 10
String number Número do título X 12
String installments Parcela 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 -
Date emission_date Data de emissão X -
Date due_date Data de vencimento X -
Date real_due_date Vencimento real X -
Float value Valor original X decimal(16,2)
String situation Situação do título X 3
String receiving_method Método de recebimento X 3
String origin_branch Filial de origem X 10
String status Status (A=Aberto, B=Baixado, R=Reliquidado) 1
String bank_slip_url URL do boleto 254
String pix_key Chave PIX 20

🏧 13. Saldo Bancário

Endpoint: POST URL_BASE/bank-balances
Delete: DELETE URL_BASE/bank-balances/{id}

Request Body

{
    "refresh_all": false,
    "data": [
        {
            "id": "3B18FBC187D8E7978C8510BF894C0FE0",
            "agency": "00001",
            "bank_code": "000",
            "account": "0123456789",
            "current_balance_date": "2018-02-14",
            "currency": "00",
            "current_balance": 181985.79,
            "previous_balance_date": null,
            "previous_balance": 418123.10,
            "balance_reconciled": 0.57,
            "group_name": "saldo_bancario"
        }
    ]
}

Campos

Tipo Nome Descrição Obrigatório Tamanho
String id Identificador único X 254
String agency Código da agência X 5
String bank_code Código do banco X 3
String account Número da conta corrente X 10
Date current_balance_date Data do saldo atual X -
String currency Segunda moeda X 2
Float current_balance Saldo atual X decimal(17,2)
Date previous_balance_date Data do saldo anterior -
Float previous_balance Saldo anterior X decimal(17,2)
Float balance_reconciled Saldo reconciliado X decimal(17,2)
String group_name Nome da tabela origem no ERP 20

💳 14. Movimento Bancário

Endpoint: POST URL_BASE/bank-transactions
Delete: DELETE URL_BASE/bank-transactions/{id}

Request Body

{
    "refresh_all": false,
    "data": [
        {
            "id": "3B18FBC187D8E7978C8510BF894C0FE0",
            "origin_branch": "010101",
            "date": "1976-09-27",
            "type": "NF",
            "currency": "01",
            "value": 267245.10,
            "financial_nature_code": "818887496",
            "ccd": "Fugiat.",
            "debt_value_class": null,
            "bank_code": "000",
            "debt_agency_code": "0000",
            "account_code": "0000000000",
            "bank_check_number": null,
            "document_number": null,
            "due_date": null,
            "receivable_payable": "P",
            "recipient": null,
            "history": null,
            "document_type": "VL",
            "currency_value_2": 63.67,
            "prefix": null,
            "number": null,
            "installment": null,
            "customer_supplier_code": null,
            "store_code": "0001",
            "typing_date": "1982-11-11",
            "low_reason": null,
            "sequence": null,
            "available_date": "1981-10-02",
            "supplier_code": null,
            "document_reconciled": null,
            "origin_id": null,
            "status": null,
            "ccc": null,
            "credit_class_value": null,
            "currency_rate": 0,
            "bank_authentication": null,
            "erp_sequential": "1317062068",
            "favored_name": "Miss Cordie Altenwerth MD",
            "favored_document": "00000000000000",
            "barcode": "000000000000000000000000000000000000000000000000",
            "modality": "1",
            "favored_bank_code": "001",
            "favored_agency": "00001",
            "favored_agency_digit": "1",
            "favored_account_number": "0000000001",
            "favored_account_digit": "1",
            "agreement_code": "12121",
            "group_name": "movimento_bancario"
        }
    ]
}

Campos Principais

Tipo Nome Descrição Obrigatório Tamanho
String id Identificador único X 254
String origin_branch Filial de origem X 10
Date date Data da movimentação X -
String type Tipo de movimento (CH/EF/TF) X 10
String currency Tipo da Moeda X 2
Float value Valor do documento X decimal(17,2)
String financial_nature_code Código da natureza X 10
String bank_code Código do banco X 10
String debt_agency_code Código da agência X 5
String account_code Número da conta X 10
String receivable_payable Crédito/Débito (R/P) X 1
String document_type Tipo de título (DP) X 2
Float currency_value_2 Valor na Moeda 2 X decimal(14,2)
Date typing_date Data da digitação X -
Date available_date Data da disponibilização X -
Float currency_rate Taxa da moeda X decimal(11,6)
String erp_sequential Sequencial do ERP X 20
String barcode Código de barras 48

📄 15. Envio do Arquivo de Pagamento

Endpoint: POST URL_BASE/payrolls/accounts-payable

Request Body

{
    "bank_id": "5a729a27f3ff31e68614fac243408794",
    "customer_ids": ["954bbecdd0105a762a2e77d7f07b9a98", "8a4d3d64a50d45c3cacc88362a344a4a"],
    "payroll_file": "",
    "use_payment_date": false,
    "payment_date": null,
    "van_id": 1
}

Campos

Tipo Nome Descrição Obrigatório Tamanho
String bank_id Identificador do banco X 255
Array customer_ids IDs dos títulos vinculados X -
File payroll_file Arquivo de folha de pagamento X -
Boolean use_payment_date Usar data do pagamento X -
Date payment_date Data do pagamento -
Number van_id Identificador da VAN X -

🔄 16. Atualização de Títulos (Webhooks)

Endpoint de Teste: PATCH URL_BASE/erps
Header: Company-Id: {company_id}

Nota: O InnCash faz requisição POST ao webhook do cliente. Retornar status 200 para sucesso.

16.1 Evento: bank_data - Dados Bancários

Atualiza dados bancários no 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
}

16.2 Evento: bank_data_with_different_holder - Dados Bancários Outra Titularidade

{
    "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
}

16.3 Evento: increase - Acréscimo

Atualiza acréscimo no título (pagar/receber).

{
    "id": "22fcb8350704cb26447b694edc369252",
    "data": {
        "addition_balance": 10.50,
        "added_value": 10.50,
        "type": "account_receivable"
    },
    "event": "increase",
    "company_id": 15
}

16.4 Evento: decrease - Decréscimo

Atualiza decréscimo no título (pagar/receber).

{
    "id": "22fcb8350704cb26447b694edc369252",
    "data": {
        "decrease_balance": 10.50,
        "decrease_value": 10.50,
        "type": "account_payable"
    },
    "event": "decrease",
    "company_id": 15
}

16.5 Evento: cash_flow_date - Data do Fluxo de Caixa

{
    "id": "22fcb8350704cb26447b694edc369252",
    "data": {
        "cash_flow": "20211201",
        "type": "sale_order"
    },
    "event": "cash_flow_date",
    "company_id": 15
}

Tipos válidos: account_payable, account_receivable, sale_order

16.6 Evento: payment_form - Forma de Pagamento do Título

{
    "id": "22fcb8350704cb26447b694edc369252",
    "data": {
        "payment_form": "001",
        "type": "account_payable"
    },
    "event": "payment_form",
    "company_id": 15
}

16.7 Evento: provider_payment_form - Forma de Pagamento do Fornecedor/Cliente

{
    "id": "22fcb8350704cb26447b694edc369252",
    "data": {
        "payment_form": "001",
        "type": "account_receivable"
    },
    "event": "provider_payment_form",
    "company_id": 15
}

16.8 Evento: inncash_value - Valor do InnCash

{
    "id": "22fcb8350704cb26447b694edc369252",
    "data": {
        "inncash_value": 10.50,
        "type": "account_payable"
    },
    "event": "inncash_value",
    "company_id": 15
}

16.9 Evento: barcode - Código de Barras

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

16.10 Evento: bolepix_url - Link do Bolepix

{
    "id": "22fcb8350704cb26447b694edc369252",
    "data": {
        "slip_url": "https://boleto.inn.cash/exemplo-boleto",
        "type": "account_receivable"
    },
    "event": "bolepix_url",
    "company_id": 15
}

16.11 Evento: qrcode_key - Chave QRCODE

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

16.12 Evento: pix_key - Chave PIX

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

Tipos válidos: provider, customer

16.13 Evento: update_darf_and_gps - Dados de DARF e GPS

{
    "id": "22fcb8350704cb26447b694edc369252",
    "data": {
        "period": "2024-06-20",
        "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
}

16.14 Evento: supplier_with_different_holder - Fornecedor Outra Titularidade

{
    "id": "22fcb8350704cb26447b694edc369252",
    "data": {
        "general_code": "10101010101",
        "provider_name": "TESTE SISTEMA",
        "type": "provider"
    },
    "event": "supplier_with_different_holder",
    "company_id": 15
}

16.15 Evento: our_number - Nosso Número

{
    "id": "22fcb8350704cb26447b694edc369252",
    "data": {
        "our_number": "10101010101",
        "type": "account_receivable"
    },
    "event": "our_number",
    "company_id": 15
}

Tabela de Campos dos Eventos de Atualização

Tipo Nome Descrição
String id ID único do título
Int company_id Identificador da empresa
String type Tipo (account_payable, account_receivable, sale_order, customer, provider)
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
Float inncash_value Valor do InnCash
String barcode Código de barras
String agency Agência
String agency_digit Dígito da 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
String slip_url URL do boleto

🏦 17. Conciliação Bancária (Webhooks)

Endpoint de Teste: PATCH URL_BASE/erps

17.1 Evento: conciliation_transfer - Transferência Bancária

{
    "integration_id": "495cafa3-3dcb-4578-aa5c-2b50684fcd7er",
    "event": "conciliation_transfer",
    "id": null,
    "data": {
        "bank_balances": [
            {
                "date": "2022-01-27",
                "bank_id": "454545454s5d45a4sd5a4s5d45as",
                "id": "2a1d2sa1d21as21d2sad1a2s"
            }
        ],
        "movements": {
            "origin": {
                "date": "2021-12-21",
                "amount": 3494.53,
                "document": null,
                "document_type": "C",
                "movement_type": "NF",
                "bank_draft": "INN4394983",
                "bank_code": "001",
                "agency": "10485",
                "currency_tax": null,
                "account": "02145",
                "nature": "54325235",
                "disposition_date": "2021-12-21",
                "cost_center_credit": "4242",
                "cost_center_debit": "5435",
                "value_class_credit": "534",
                "value_class_debit": "34",
                "account_item_credit": "3242",
                "account_item_debit": "42",
                "phase_credit": "123",
                "phase_debit": "123",
                "project_credit": "123",
                "project_debit": "123",
                "accounting_account_credit": "123",
                "accounting_account_debit": "123",
                "history": "",
                "type": "P",
                "branch": "01",
                "prefix": "NF",
                "id": "55ae2a40237f7d6995790ef0f7583ec5"
            },
            "destination": {
                "date": "2021-12-21",
                "amount": 3494.53,
                "document": "INN4394983",
                "document_type": "C",
                "movement_type": "NF",
                "bank_draft": null,
                "bank_code": "033",
                "agency": "104553",
                "currency_tax": null,
                "account": "435390",
                "nature": "5432232",
                "disposition_date": "2021-12-21",
                "cost_center_credit": "4242",
                "cost_center_debit": "5435",
                "value_class_credit": "534",
                "value_class_debit": "34",
                "account_item_credit": "3242",
                "account_item_debit": "42",
                "history": "",
                "type": "P",
                "branch": "01",
                "prefix": "NF",
                "id": "55ae2a40237f7d6995790ef0f7583ec5"
            }
        }
    },
    "company_id": 15
}

17.2 Evento: conciliation_register - Registro Bancário

{
    "integration_id": "495cafa3-3dcb-4578-aa5c-2b50684fcd7er",
    "event": "conciliation_register",
    "id": null,
    "data": {
        "bank_balances": [
            {
                "date": "2022-01-27",
                "bank_id": "454545454s5d45a4sd5a4s5d45as",
                "id": "2a1d2sa1d21as21d2sad1a2s"
            }
        ],
        "movements": {
            "date": "2021-12-21",
            "amount": 3494.53,
            "currency": "M1",
            "document": "INN639502",
            "document_type": "C",
            "movement_type": "NF",
            "bank_draft": null,
            "bank_code": "001",
            "agency": "10485",
            "currency_tax": null,
            "account": "02145",
            "disposition_date": "2021-12-21",
            "cost_center_credit": "4242",
            "cost_center_debit": "5435",
            "value_class_credit": "534",
            "value_class_debit": "34",
            "account_item_credit": "3242",
            "account_item_debit": "42",
            "phase_credit": "123",
            "phase_debit": "123",
            "project_credit": "123",
            "project_debit": "123",
            "accounting_account_credit": "123",
            "accounting_account_debit": "123",
            "nature": "54325235",
            "history": "",
            "type": "P",
            "branch": "01",
            "prefix": "NF",
            "id": "55ae2a40237f7d6995790ef0f7583ec5"
        }
    },
    "company_id": 15
}

17.3 Evento: conciliate - Conciliação Bancária

{
    "integration_id": "495cafa3-3dcb-4578-aa5c-2b50684fcd7er",
    "event": "conciliate",
    "id": null,
    "data": {
        "bank_balances": [
            {
                "date": "2022-01-27",
                "bank_id": "454545454s5d45a4sd5a4s5d45as",
                "id": "2a1d2sa1d21as21d2sad1a2s"
            }
        ],
        "movements": [
            {
                "id": "55ae2a40237f7d6995790ef0f7583ec5",
                "date": "2021-12-21"
            }
        ]
    },
    "company_id": 15
}

17.4 Evento: delete_conciliation - Desconciliação Bancária

{
    "integration_id": "",
    "event": "delete_conciliation",
    "id": null,
    "data": {
        "bank_balances": [
            {
                "date": "2022-01-27",
                "bank_id": "454545454s5d45a4sd5a4s5d45as",
                "id": "2a1d2sa1d21as21d2sad1a2s"
            }
        ],
        "movements": [
            {
                "id": "55ae2a40237f7d6995790ef0f7583ec5"
            }
        ]
    },
    "company_id": 15
}

17.5 Evento: settle_account - Baixa de Título a Receber

{
    "integration_id": "495cafa3-3dcb-4578-aa5c-2b50684fcd7er",
    "event": "settle_account",
    "data": {
        "bank_id": "454545454s5d45a4sd5a4s5d45as",
        "bank": {
            "code": "123",
            "agency": "123",
            "account": "123456"
        },
        "additional_information": {
            "historic": "test",
            "reason": "test",
            "date": "2021-12-21"
        },
        "bank_balances": [
            {
                "date": "2022-01-27",
                "bank_id": "454545454s5d45a4sd5a4s5d45as",
                "id": "2a1d2sa1d21as21d2sad1a2s"
            }
        ],
        "receivables": [
            {
                "id": "123456789101112",
                "tax": 1,
                "assessment": 2.5,
                "discount": 10,
                "received_value": 14
            }
        ],
        "movements": [
            {
                "date": "2022-02-08",
                "amount": 59546787.0,
                "document": null,
                "bank_draft": null,
                "bank_code": "iq8",
                "currency_tax": null,
                "currency": "01",
                "agency": "1947",
                "account": "12010",
                "document_type": null,
                "movement_type": "NF",
                "disposition_date": "2022-02-08",
                "reconciled_document": "x",
                "type": "R",
                "branch": "0101",
                "nature": "Eaque.",
                "number": "495867111",
                "client_code": "105212091",
                "store": "0001",
                "prefix": "1",
                "id": "INN6d947daef7ff4e7582cfa5afb79df54b"
            }
        ]
    },
    "company_id": 15
}

17.6 Evento: generate_advances_from_conciliation - Geração de RA

{
    "integration_id": "495cafa3-3dcb-4578-aa5c-2b50684fcd7er",
    "event": "generate_advances_from_conciliation",
    "id": null,
    "data": {
        "bank_balances": [
            {
                "date": "2022-01-27",
                "bank_id": "454545454s5d45a4sd5a4s5d45as",
                "id": "2a1d2sa1d21as21d2sad1a2s"
            }
        ],
        "movements": {
            "date": "2021-12-21",
            "amount": 3494.53,
            "document": null,
            "document_type": "C",
            "movement_type": "NF",
            "bank_draft": "INN4394983",
            "bank_code": "001",
            "agency": "10485",
            "account": "02145",
            "nature": "54325235",
            "disposition_date": "2021-12-21",
            "type": "P",
            "branch": "01",
            "prefix": "NF",
            "id": "55ae2a40237f7d6995790ef0f7583ec5"
        },
        "advance": {
            "branch": "55ae2a40237f7d6995790ef0f7583ec5",
            "customer_code": "3242",
            "customer_store": "3242",
            "title_number": "3242",
            "prefix": "3242",
            "balance": "3242",
            "value": "3242",
            "type": "3242",
            "agency": "3242",
            "bank": "3242",
            "account": "3242",
            "emission_date": "3242",
            "due_date": "3242",
            "actual_due_date": "3242",
            "historic": "3242",
            "nature": "3242",
            "cost_center": "3242",
            "class_value": "3242",
            "accounting_item": "3242",
            "installment": "3242",
            "id": "3242"
        }
    },
    "company_id": 15
}

📋 18. Conciliação Manual de DDA

Endpoint de Teste: PATCH URL_BASE/erps

Evento: conciliate_direct_debit

{
    "id": "22fcb8350704cb26447b694edc369252",
    "data": {
        "added_value": 1.0,
        "addition_balance": 1.0,
        "barcode": "000000000000000000000000000000",
        "cash_flow": "2022-01-01"
    },
    "event": "conciliate_direct_debit",
    "company_id": 1
}

Nota: Se for acréscimo, usar addition_balance e added_value. Se for decréscimo, usar decrease_balance e decrease_value.

📤 19. Sincronização de Remessas (Webhooks)

19.1 Evento: sync_deleted_vouchers - Borderôs Deletados

{
    "data": [
        {
            "bordero_number": "0000001",
            "type": "accounts_payable",
            "bordero_reference_date": "2023-10-01"
        }
    ],
    "event": "sync_deleted_vouchers",
    "company_id": 15,
    "id": null,
    "integration_id": "2ef09fb5-2c09-4233-9b3d-0386f2741938"
}

Tipos: accounts_payable (pagar) ou accounts_receivable (receber)

19.2 Evento: sync_generated_vouchers - Borderôs Gerados

{
    "data": {
        "bank": "001",
        "agency": "1221",
        "account": "313131",
        "bank_id": "454545454s5d45a4sd5a4s5d45as",
        "bordero_number": "00001",
        "type": "accounts_receivable",
        "wallet": "1",
        "bordero_reference_date": "2023-10-01",
        "titles": [
            {
                "id": "8f81d36afffe387314702c9a01d70ce5",
                "cnab_id": "INN000001"
            },
            {
                "id": "8f81d36afffe387314702c9a01d70ce6",
                "cnab_id": "INN000002"
            }
        ]
    },
    "event": "sync_generated_vouchers",
    "company_id": 15,
    "id": null,
    "integration_id": "2ef09fb5-2c09-4233-9b3d-0386f2741938"
}

19.3 Evento: voucher_maintenance - Manutenção de Borderô

{
    "data": {
        "bank": "001",
        "agency": "1221",
        "account": "313131",
        "bank_id": "454545454s5d45a4sd5a4s5d45as",
        "bordero_number": "00001",
        "type": "accounts_receivable",
        "wallet": "1",
        "bordero_reference_date": "2023-10-01",
        "titles": {
            "id": "8f81d36afffe387314702c9a01d70ce5",
            "cnab_id": "INN000001"
        }
    },
    "event": "voucher_maintenance",
    "company_id": 15,
    "id": null,
    "integration_id": "2ef09fb5-2c09-4233-9b3d-0386f2741938"
}

📥 20. Retornos Bancários (Webhooks)

Evento: sync_bank_payback

{
    "event": "sync_bank_payback",
    "integration_id": "2ef09fb5-2c09-4233-9b3d-0386f2741938",
    "id": null,
    "data": [
        {
            "id": "c51fc2eaa2591bdce2da5e023cce5d92",
            "action": "4",
            "bank_account": "561542",
            "bank_account_digit": "443",
            "settle_history": "Valor pago s /Titulo - INNCASH",
            "bank_agency": "354540",
            "bank_agency_digit": "854",
            "bank_code": "0051",
            "bank_low_reason": null,
            "bank_modality": null,
            "bank_occurrence": "0",
            "branch": "01",
            "cnab_bank_transactions_id": 674,
            "company": "01",
            "company_token": "5e3e36aef934103164ff21847bb9a0e8",
            "date_time": "2021-12-17 14:59:36",
            "provider_account": "null",
            "provider_account_digit": "null",
            "provider_agency": "null",
            "provider_agency_digit": "null",
            "provider_auth": "null",
            "provider_bank": "null",
            "provider_barcode": "null",
            "provider_name": "null",
            "status": "0",
            "title_customer_supplier_cgc": "null",
            "title_payment_receipt_credit_date": "null",
            "title_payment_receipt_customer_supplier": "12105433323",
            "title_payment_receipt_customer_supplier_store": "0001",
            "title_payment_receipt_discount": "0",
            "title_payment_receipt_fine": "0",
            "title_payment_receipt_interest": "0",
            "title_payment_receipt_low_date": "null",
            "title_payment_receipt_number": "000671574",
            "title_payment_receipt_portion": "001",
            "title_payment_receipt_prefix": "1",
            "title_payment_receipt_type": "NF",
            "title_payment_receipt_value": "990",
            "title_payment_receive_effective_tariff": "null",
            "title_payment_receive_idcnab": "0400553582535",
            "title_payment_receive_net_value": "null",
            "title_replaces": "1",
            "title_type_record": "R"
        }
    ],
    "company_id": 15
}

Tipo de título: title_type_record = R (receber) ou P (pagar)

Campos do Retorno Bancário

Campo Tipo Descrição
id string Identificador único da transação
action string Ação do evento (ex: "4" = liquidação)
bank_account string Número da conta bancária
bank_account_digit string Dígito verificador da conta
settle_history string Histórico da liquidação
bank_agency string Agência bancária
bank_agency_digit string Dígito da agência
bank_code string Código do banco
bank_low_reason string/null Motivo da baixa
bank_occurrence string Código da ocorrência
branch string Código da filial
title_payment_receipt_number string Número do título
title_payment_receipt_portion string Parcela do título
title_payment_receipt_prefix string Prefixo do título
title_payment_receipt_type string Tipo de título (ex: "NF")
title_payment_receipt_value decimal Valor original
title_payment_receipt_discount decimal Valor de desconto
title_payment_receipt_fine decimal Valor de multa
title_payment_receipt_interest decimal Valor de juros
title_type_record string "R" = a receber, "P" = a pagar

👤 21. Atualização de Informações do Cliente

Endpoint: PATCH URL_BASE/company-groups/{company_group}/customers

Evento: change_additional_customer_information

{
    "id": "9AC0A15E9A1A01FCBFC7AAB96DCF5A7C",
    "company_id": 10,
    "data": {
        "customer_phone": "9999999999",
        "customer_ddd": "99",
        "customer_invoice_mail": "[email protected]",
        "customer_financial_mail_1": "[email protected]",
        "customer_financial_mail_2": "[email protected]",
        "customer_risk": "D",
        "customer_group": "001",
        "customer_sub_group": "00001",
        "customer_client_class": "G",
        "customer_deadline": "001",
        "customer_limit": 300,
        "customer_credit_history": "test notes"
    }
}

Campos

Tipo Nome Descrição
String id ID único do cliente
Int company_id Identificador da empresa
String customer_phone Telefone do cliente
String customer_ddd DDD do telefone
String customer_invoice_mail Email do Cliente
String customer_financial_mail_1 Email financeiro 1
String customer_financial_mail_2 Email financeiro 2
String customer_risk Grau de Risco
String customer_group Grupo do cliente
String customer_sub_group SubGrupo do cliente
String customer_client_class Classe do Cliente
String customer_deadline Condição de pagamento
Float customer_limit Limite de Crédito
String customer_credit_history Anotações de bloqueio

📊 Resumo das Integrações

Integrações de Envio (ERP → Inncash)

# Integração Endpoint Método
1 Autenticação /auth POST
2 Bancos /banks POST/DELETE
3 Centro de Custo /cost-center POST/DELETE
4 Classe de Valor /value-class POST/DELETE
5 Natureza /financial-natures POST/DELETE
6 Item Contábil /accounting-items POST/DELETE
7 Cliente /customers POST/DELETE
8 Fornecedor /suppliers POST/DELETE
9 Feriado /holidays POST/DELETE
10 Moeda /currencies POST/DELETE
11 Conta a Pagar /accounts-payable POST/DELETE
12 Conta a Receber /accounts-receivable POST/DELETE
13 Saldo Bancário /bank-balances POST/DELETE
14 Movimento Bancário /bank-transactions POST/DELETE
15 Arquivo Pagamento /payrolls/accounts-payable POST

Webhooks (Inncash → ERP)

# Categoria Eventos
1 Atualização de Títulos bank_data, bank_data_with_different_holder, increase, decrease, cash_flow_date, payment_form, provider_payment_form, inncash_value, barcode, bolepix_url, qrcode_key, pix_key, update_darf_and_gps, supplier_with_different_holder, our_number
2 Conciliação Bancária conciliation_transfer, conciliation_register, conciliate, delete_conciliation, settle_account, generate_advances_from_conciliation
3 Conciliação DDA conciliate_direct_debit
4 Sincronização Remessas sync_deleted_vouchers, sync_generated_vouchers, voucher_maintenance
5 Retornos Bancários sync_bank_payback
6 Atualização Cliente change_additional_customer_information

📝 Observações para Migração ADVPL

  1. Token: Implementar renovação automática (expira em 24h)
  2. Company-Ids: Sempre enviar no header
  3. refresh_all: Usar apenas em ambiente de testes
  4. Webhooks: Implementar endpoint para receber POST e retornar 200
  5. Formato de Data: Usar YYYY-MM-DD
  6. IDs: Manter consistência dos identificadores únicos

Documento gerado em: 20 de janeiro de 2026
Versão: 1.0 - Completa