Consulta de lançamentos

A consulta de lançamentos, pode ser efetuada usando os parâmetros de filtragem e paginação da v0, que devolve uma coleção de lançamentos. Por omissão são devolvidas todas as relações incluindo não só as linhas de cada lançamento, mas também as outras relações, podendo-se definir qual a informação a incluir nos parâmetros.

get

Responses

200

OK

application/json

get

/accounting_transactions

HTTPcURLJavaScriptPython

GET /accounting_transactions HTTP/1.1
Accept: */*

200

OK

{
  "data": []
}

Sendo a consulta de um lançamento específico efetuada de forma individual usando o identificador interno do lançamento:

get

Path parameters

idintegerRequired

Identificador do lançamento a obter

Responses

200

OK

application/json

get

/accounting_transactions/{id}

HTTPcURLJavaScriptPython

GET /accounting_transactions/{id} HTTP/1.1
Accept: */*

200

OK

{
  "data": {
    "type": "accounting_transactions",
    "id": "1",
    "attributes": {
      "status": "draft",
      "transaction_date": "2024-01-01",
      "document_date": "2023-12-10",
      "description": "Lançamento novo via API",
      "external_reference": "D20236712",
      "currency_conversion_rate": 1.21,
      "third_party_control_id": "CLIENTE",
      "third_party_entity_id": 20,
      "created_at": "2024-01-01 10:20:30.123456",
      "finalized_at": null,
      "journal_entry": null,
      "document_no": null,
      "accounting_document_series_no": 1,
      "debit_total_fiscal_currency": 0,
      "credit_total_fiscal_currency": 0,
      "debit_total_document_currency": 0,
      "credit_total_document_currency": 0,
      "accountable_id": null,
      "accountable_document_type": null,
      "accountable_document_no": null
    },
    "relationships": {
      "accounting_document_series": {
        "data": null
      },
      "accounting_document_type": {
        "data": {
          "type": "accounting_document_types",
          "id": "DP"
        }
      },
      "currency": {
        "data": {
          "type": "currency",
          "id": "1"
        }
      },
      "journal": {
        "data": {
          "type": "journals",
          "id": "BNC"
        }
      },
      "lines": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ]
      },
      "user": {
        "data": {
          "type": "users",
          "id": "1"
        }
      }
    }
  }
}

Também é possível consultar apenas linhas de lançamento, usando os critérios de filtragem e paginação referidos:

get

Responses

200

OK

application/json

get

/accounting_transaction_lines

HTTPcURLJavaScriptPython

GET /accounting_transaction_lines HTTP/1.1
Accept: */*

200

OK

{
  "data": []
}

Sendo também possível efetuar a consulta de uma linha de lançamento específica efetuada de forma individual usando o identificador interno da linha do lançamento:

get

Path parameters

idintegerRequired

Identificador do lançamento a obter

Responses

200

OK

application/json

get

/accounting_transaction_lines/{id}

HTTPcURLJavaScriptPython

GET /accounting_transaction_lines/{id} HTTP/1.1
Accept: */*

200

OK

{
  "data": {
    "type": "accounting_transaction_lines",
    "id": "1",
    "attributes": {
      "seqno": 0,
      "transaction_id": 1,
      "account_id": 11001,
      "description": "Linha de lançamento nova via API",
      "debit_amount": 10.5,
      "credit_amount": 20,
      "debit_expression": "9+1.5",
      "credit_expression": "10*2",
      "cost_dimension_id": 1
    },
    "relationships": {
      "account": {
        "data": {
          "type": "general_ledger",
          "id": "1"
        }
      },
      "transaction": {
        "data": {
          "type": "accounting_transactions",
          "id": "1"
        }
      },
      "vat_code": {
        "data": {
          "type": "vat_codes",
          "id": "1"
        }
      },
      "cost_dimension": {
        "data": {
          "type": "cost_dimensions",
          "id": "0101"
        }
      },
      "transaction_line_cash_flows": [],
      "transaction_line_costs": []
    }
  }
}