Skip to content
Q

Getting started

Getting started

Check the connection, identify your company and upload an expense document — in about five minutes.

In this guide you will verify the connection, read your company details, list partners and finally upload an expense document. The whole flow takes about five minutes.

Prerequisites

  • An active QUiCK account with the Administrator role
  • An API token — see the Authentication page for how to create one
  • A terminal with curl, or any HTTP client (HTTPie, Postman, …)

Export the token as an environment variable so the examples below are runnable:

bash
export QUICK_API_TOKEN="9c4f2e7a8b1d43f0a6e5c2b9d8f70123"

Never commit your token

The API token grants full access to your company's accounting data. It must never end up in version control, a client-side bundle or an error report.

1. Check the connection

Start with GET /1/pulse/ — it validates the token and returns the state of the company's cash and bank accounts:

bash
curl https://api.quick.riport.co.hu/1/pulse/ \
  -H "Authorization: Token $QUICK_API_TOKEN"
json
{
  "summary": 1284500,
  "accounts": [
    {
      "id": 12,
      "name": "Bank – HUF",
      "account_number": "12345678-00000000-00000000",
      "currency": "HUF",
      "current_balance": "1284500.00",
      "last_updated": "2026-07-14T08:12:00Z"
    }
  ]
}

If the response is 401 Unauthorized, the token is wrong or missing — double-check the Authorization header.

2. Identify your company

GET /2/company-info/ returns the base data of the token's company. The id field is your company identifier, which you can pass in the Quick-Company-Id header when needed.

bash
curl https://api.quick.riport.co.hu/2/company-info/ \
  -H "Authorization: Token $QUICK_API_TOKEN"
json
{
  "id": 4821,
  "name": "Riport Applications Kft.",
  "tax_account_number": "12345678-2-42",
  "default_currency_name": "HUF",
  "advanced_accounting": true
}

3. List partners

List endpoints are paginated — control them with the page and page_size query parameters:

bash
curl "https://api.quick.riport.co.hu/1/partners/?page_size=2" \
  -H "Authorization: Token $QUICK_API_TOKEN"
json
{
  "count": 128,
  "next": "https://api.quick.riport.co.hu/1/partners/?page=2&page_size=2",
  "previous": null,
  "results": [
    {
      "id": 5501,
      "name": "Example Customer Ltd.",
      "tax_number": "12345678-2-42",
      "city": "Budapest",
      "zip_code": "1051",
      "is_customer": true,
      "is_vendor": false
    }
  ]
}

4. Upload an expense document

Expenses are recorded by uploading the document itself: POST /2/expenses/create/ expects the file contents Base64-encoded in the content field, together with the file name. A single call accepts at most 5 documents.

bash
CONTENT=$(base64 -i invoice.pdf)

curl -X POST https://api.quick.riport.co.hu/2/expenses/create/ \
  -H "Authorization: Token $QUICK_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d "{
    \"expenses\": [
      { \"filename\": \"invoice.pdf\", \"content\": \"$CONTENT\" }
    ],
    \"source\": \"public_api\"
  }"

The response returns the identifiers of the expenses accepted for processing:

json
{
  "processed": [90231]
}

The system extracts the expense data from the uploaded document; the details can be read afterwards with GET /1/expenses/ or GET /2/expenses/{expenseId}/.

Versions: /1/ and /2/

The /1/ endpoints cover stable read and core operations, while /2/ endpoints provide the extended, often bulk accounting operations (creation, assignments, master data). A single integration is free to mix both.

Next steps