Relatórios

É possível obter a informação de relatórios de contabilidade via API.

Os diferentes tipos de relatório são obtidos através de um pedido individual de um recurso que apenas tem atributos e cujo identificador é ignorado.

Na resposta, embora não apareça o relacionamento, ou relationships, com as linhas de detalhe do relatório, estas linhas são automaticamente incluídas na resposta, independentemente de no URL ser passado o parâmetro include=lines para a sua inclusão.

Balancetes

Para obter um balancete deve ser usado um pedido GET sobre o recurso trial_balance_period, como referido anteriormente, pode ser usado qualquer identificador, e por coerência deve-se pedir a inclusão das linhas do relatório, como por exemplo:

/api/trial_balance_period/0?include=lines

get

Path parameters

idstringRequired

Identificador temporário do relatório, apenas necessário pelo tipo de recurso

Query parameters

includestringOptional

Inclusão das linhas do relatório, não é possível excluir

Example: lines

filter[first_account]integerOptional

De conta

Example: 11

filter[last_account]integerOptional

Até conta

Example: 14

filter[period_month]integerRequired

Mês inicial

Example: 1

filter[end_period_month]integerOptional

Mês final

Example: 12

filter[level]integerOptional

Grau de detalhe das contas, usar 20 para incluir todas as contas de movimento

Example: 12

filter[balance_type_id]stringOptional

Tipo de saldos: Soma dos saldos (balance_of_accounts) ou Saldo das somas (account_balance)

Example: balance_of_accounts|account_balance

filter[taxonomy_reference]stringOptional

Taxonomia, nulo por omissão

Example: S|M|O

filter[general_ledger_type]stringOptional

Tipo de plano, nulo por omissão

Example: base_|micro_|independent_|small_|nonprofit_

filter[balance_sheet_structure_ids]stringOptional

Lista de identificadores de categorias do balanço, separadas por vírgula

Example: 010203,010204

filter[profit_and_loss_structure_ids]stringOptional

Lista de identificadores de descrições de demonstração de resultados, separados por vírgula

Example: 0114,0115

filter[include_zeroes]booleanOptional

Incluir saldo final a zero, verdadeiro por omissão

Example: true

filter[only_opening_balance]booleanOptional

Apenas movimentos de abertura, falso por omissão

Example: false

filter[include_opening_balance]booleanOptional

Incluir movimentos de abertura, verdadeiro por omissão

Example: true

filter[include_closing]booleanOptional

Incluir apuramentos de fecho, verdadeiro por omissão

Example: true

filter[include_yearly_balance]booleanOptional

Incluir apuramentos de resultados, verdadeiro por omissão

Example: true

filter[show_short_descriptions]booleanOptional

Mostrar descrições reduzidas, falso por omissão

Example: false

filter[hide_third_party_accounts]booleanOptional

Não mostrar contas de terceiros, verdadeiro por omissão

Example: true

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /trial_balance_period/{id}?filter[period_month]=1 HTTP/1.1
Host: 
Accept: */*

200

OK

{
  "data": {
    "type": "trial_balance_period",
    "id": "0",
    "attributes": {
      "company_tax_registration_number": "999999990",
      "company_name": "Empresa de Teste de Relatórios",
      "fiscal_year": "Exercício de 2024",
      "first_account": "11",
      "last_account": "12"
    }
  },
  "included": []
}

Exemplo de informação de uma linha do balancete:

    "included": [
        {
            "type": "trial_balance_lines",
            "id": 12,
            "attributes": {
                "account_id": "12",
                "account_description": "Depósitos à ordem",
                "debit1_amount": 0,
                "credit1_amount": 234.00,
                "debit2_amount": 31500.00,
                "credit2_amount": 3000.00,
                "debit3_amount": 31500.00,
                "credit3_amount": 3234.00,
                "debit_balance": 28266.00,
                "credit_balance": null,
                "cumulative_debit": 28266.00,
                "cumulative_credit": 0,
                "movement_balance": 28266.00,
                "group_id": 1,
                "class": 1,
                "level": 2,
                "db_bss_descr": null,
                "cr_bss_descr": null,
                "pnl_descr": null,
                "is_integrator": true
            }
        },

Extratos de contas

Para obter um extrato de contas deve ser usado um pedido GET sobre o recurso account_statement, como referido acima, pode ser usado qualquer identificador, e por coerência deve-se pedir a inclusão das linhas do relatório, como por exemplo:

/api/account_statement/0?include=lines

get

Path parameters

idstringRequired

Identificador temporário do relatório, apenas necessário pelo tipo de recurso

Query parameters

includestringOptional

Inclusão das linhas do relatório, não é possível excluir

Example: lines

filter[first_account]integerOptional

De conta

Example: 11

filter[last_account]integerOptional

Até conta

Example: 14

filter[start_date]stringRequired

Data inicial

Example: 2024-01-01

filter[end_date]stringOptional

Data final

Example: 2024-03-31

filter[include_zeroes]booleanOptional

Incluir saldo final a zero, false por omissão

Example: true

filter[has_transactions]booleanOptional

Com movimentos, false por omissão

Example: true

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /account_statement/{id}?filter[start_date]=2024-01-01 HTTP/1.1
Host: 
Accept: */*

200

OK

{
  "data": {
    "type": "account_statement",
    "id": "0",
    "attributes": {
      "company_tax_registration_number": "999999990",
      "company_name": "Empresa de Teste de Relatórios",
      "start_date": "2024-01-01",
      "end_date": "2024-12-31",
      "first_account": "11",
      "last_account": "12"
    }
  },
  "included": []
}

Exemplo de informação de uma linha do extrato:

    "included": [
        {
            "type": "account_statement_lines",
            "id": "12999-0",
            "attributes": {
                "account_id": "12999",
                "account_description": "Depósitos à ordem-Outros bancos",
                "detail_order": 0,
                "initial_debit": 0.00,
                "initial_credit": 25.90,
                "final_debit": 0.00,
                "final_credit": 51.80,
                "balance_amount": -25.90,
                "journal_id": null,
                "journal_entry": null,
                "transaction_date": null,
                "document_no": null,
                "transaction_id": null,
                "description": "Saldo inicial",
                "full_description": null,
                "accountable_document_no": null,
                "debit_final_amount": 0.00,
                "credit_final_amount": 25.90,
                "movement_amount": -25.90,
                "external_reference": null,
                "suggestion_type": null,
                "document_date": null,
                "third_party_name": null,
                "third_party_tax_number": null,
                "jrxml_full_description_and_third_party_name": null
            }
        },

Extratos de diários

Para obter um extrato de contas deve ser usado um pedido GET sobre o recurso journal_statement, como referido acima, pode ser usado qualquer identificador, e por coerência deve-se pedir a inclusão das linhas do relatório, como por exemplo:

/api/journal_statement/0?include=lines

get

Path parameters

idstringRequired

Identificador temporário do relatório, apenas necessário pelo tipo de recurso

Query parameters

includestringOptional

Inclusão das linhas do relatório, não é possível excluir

Example: lines

filter[start_date]stringRequired

Data inicial

Example: 2024-01-01

filter[end_date]stringOptional

Data final

Example: 2024-03-31

filter[journal_list]stringOptional

Diários a incluir, separados por vírgula

Example: CMP,VND

filter[has_transactions]booleanOptional

Com movimentos, false por omissão

Example: true

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /journal_statement/{id}?filter[start_date]=2024-01-01 HTTP/1.1
Host: 
Accept: */*

200

OK

{
  "data": {
    "type": "journal_statement",
    "id": "0",
    "attributes": {
      "company_tax_registration_number": "999999990",
      "company_name": "Empresa de Teste de Relatórios",
      "start_date": "2024-01-01",
      "end_date": "2024-12-31",
      "journal_list": "CMP,VND"
    }
  },
  "included": []
}

Exemplo de informação de uma linha do extrato:

    "included": [
        {
            "type": "journal_statement_lines",
            "id": "CMP-0",
            "attributes": {
                "journal_id": "CMP",
                "journal_name": "Compras",
                "detail_order": 0,
                "initial_debit": 0,
                "initial_credit": 0,
                "final_debit": 150.93,
                "final_credit": 150.93,
                "journal_entry": null,
                "transaction_date": null,
                "document_no": null,
                "accountable_document_no": null,
                "transaction_id": null,
                "account_id": null,
                "description": "Saldo inicial",
                "debit_final_amount": 0,
                "credit_final_amount": 0,
                "vat_code_id": null,
                "movement_amount": 0,
                "external_reference": null,
                "suggestion_type": null,
                "document_date": null,
                "third_party_name": null,
                "third_party_tax_number": null,
                "jrxml_description_and_third_party_name": "Saldo inicial"
            }
        },