QUiCK Public API documentation
HU EN
Glossary

Naming dictionary

A Hungarian–English mapping of terms used in the QUiCK API. The goal is for the docs, the code, and everyday conversation to all use the same language.

No matching terms.

Accounting assignment

assignments

One accounting breakdown line of a document. In the QUiCK Public API this is the assignment: it ties an amount to an expense or revenue type, a VAT category and — with advanced accounting — a ledger number.

"assignments": [{ "expense_type": 12, "net_amount": "25000.00", "vat": 3 }]

Accounting identifier enabled

enable_accounting_id

The flag in the company-info response indicating that accounting identifiers are in use.

"enable_accounting_id": true

Accounting note

note

A bookkeeping note attached to the document. Only applied when advanced accounting is enabled.

"note": "Havi bérleti díj"

Accounting period end

accounting_period_end

The last day of the accounting (fulfilment) period for continuous services.

"accounting_period_end": "2026-07-31"

Accounting status

accounting_status

The bookkeeping processing state of the document. This is the field to mirror in your own system during incremental sync.

"accounting_status": "pending"

Amount (salary, tax)

amount

The amount on salary and tax items. Distinct from the financial fields of documents (net / VAT / gross).

"amount": 450000

Approved

is_approved

Indicates whether the expense has been approved. Set in bulk through /1/expenses/approve/ and /1/expenses/unapprove/.

?is_approved=true

Audit XML export

audit_xml

The endpoint producing the XML export used for tax authority and audit reporting.

GET /2/audit-xml/

Authentication header

Authorization

The mandatory header on every call, prefixed with Token. A token is bound to exactly one company. A missing or invalid token returns 401; a lack of permission returns 403.

Authorization: Token 9c4f2e7a8b1d43f0a6e5c2b9d8f70123

Bank account number

account_number

The bank account number of the partner or the cash account. On documents it also appears denormalised as partner_account_number.

"account_number": "12345678-00000000-00000000"

Base64 content

content

The file content of the uploaded document, Base64-encoded. A single call accepts at most 5 items.

"content": "JVBERi0xLjcK..."

Bulk error list

errors

Per-item error messages from a bulk operation. On create operations the id field of the error object is the zero-based position in the submitted array — not a record identifier.

"errors": [ { "id": 0, "errors": ["..."] } ]

Cash account / bank account

account

A cash register or bank account — the API calls it a paid-through. Its current balance also appears in the pulse summary.

GET /1/accounts/

Category direction

type

The direction of a VAT category: cost — expense (incoming invoice), revenue — income (outgoing invoice).

"type": "cost"

Company VAT category

company_vat_category_id

The identifier of the company-specific VAT category on an assignment line. Name, code, percentage and VAT territory are populated automatically from the master record.

"company_vat_category_id": 5

Company scope header

Quick-Company-Id

An optional header that selects the target company explicitly. If you omit it, the company is inferred from the token — the usual case. If the value is not the token's company, the response is 403.

Quick-Company-Id: 4821

Company tax number

tax_account_number

The tax number of your own company in the company-info response. Do not confuse it with the partner's tax_number field.

"tax_account_number": "12345678-2-42"

Correction invoice

corrective_invoice

A partial amendment of an earlier invoice — for example correcting a wrong quantity or amount. The document type is indicated by invoice_class; the correction invoice has the value 4.

"invoice_class": 4

Created at

created

The time the document entered the system. For incremental sync this is the field to filter on, combining date_field=created with from_date.

"created": "2026-07-14T08:12:00Z"

Creation source

source

A free-text source marker you can pass in the POST /2/expenses/create/ request. It defaults to public_api; a custom label can identify your own integration.

"source": "public_api"

Current balance

current_balance

The current balance of a cash account or bank account, as a decimal string. Returned by the pulse summary.

"current_balance": "1284500.00"

Customer

is_customer

Indicates whether the partner acts as a customer. One partner can be both a customer and a vendor.

"is_customer": true

Date field selector

date_field

Selects which date field the period filter applies to — for example created, fulfilled_at or due_at. Essential for incremental sync.

?date_field=created

Default currency

default_currency_name

The default currency of the company. A document in a different currency also carries an exchange rate.

"default_currency_name": "HUF"

Denormalised partner data

partner_name

The partner data stored on the document (partner_name, partner_tax_number, partner_city, partner_zip_code, partner_address, partner_country, partner_account_number). Listing therefore needs no separate partner lookup.

"partner_name": "Teszt Szállító Kft."

Document

document

An uploaded file (PDF or image) that can be attached to an expense or an income. Handling: GET /1/documents/, attach via /1/documents/attach/, detach via /1/documents/detach/.

GET /1/documents/

Document image (artifact)

artifact

The image or PDF attachment belonging to an expense or income. Its presence is signalled by has_artifact; read them from /1/artifacts/expense/ and /1/artifacts/income/.

GET /1/artifacts/expense/

Document intake email address

document_email

An email address belonging to the company; files sent here enter the system as documents.

"document_email": "bizonylat@pelda.hu"

Document type

invoice_class

The type of the document as an integer code: 0 — invoice, 1 — storno invoice, 2 — advance invoice, 3 — final invoice, 4 — correction invoice.

"invoice_class": 0

Document type

document_type

The type classification of documents (contract, bank statement, …). Its master data is read from /2/document-types/, and it can also filter the document list.

GET /2/document-types/

EU VAT number

eu_tax_number

The Community VAT number used for intra-EU trade, with a country prefix (for example HU12345678). The VAT territory of a document is indicated by the vat_area field: HU, EU or 3RD.

"vat_area": "EU"

Error message field

_error

Every error response from the API returns this single text field. There is no error code and no per-field error list — branch your code on the HTTP status code.

{ "_error": "Authentication credentials were not provided." }

Exchange rate

exchange_rate

The conversion rate applied when the currency differs from HUF, as a decimal string.

"exchange_rate": "395.4200"

Exchange rate date

exchange_date

The date of the exchange rate used for the conversion (ISO 8601, YYYY-MM-DD).

"exchange_date": "2026-07-14"

Excluded from accounting

excluded_from_accounting

The document is deliberately excluded from bookkeeping (for example a mistaken submission or a non-deductible item).

"excluded_from_accounting": false

Expense (incoming invoice)

expense

An invoice received from an external vendor, waiting to be booked. In the QUiCK Public API this is the expense resource: it is created by uploading the document, after which the system extracts its data.

GET /1/expenses/

Expense intake email address

expense_email

An email address belonging to the company: incoming invoices sent here appear automatically as expenses. An alternative to uploading through the API.

"expense_email": "koltsegek@pelda.hu"

Expense type

expense_type

The cost category (cost centre) on an assignment. Its catalogue is managed under /2/expense-types/ and can be synchronised with an external ERP.

"expense_type": 12

Exported

is_exported

Indicates whether the item has already been included in an accounting export. Set through the /1/expenses/export/ endpoint.

?is_exported=false

External id

external_id

A field for storing an identifier from an external system — use it to link a QUiCK record to a record in your own system.

"external_id": "ERP-2026-0042"

Failed ids

failed_ids

The identifiers of the items the bulk operation could not process. The detailed reason is in the errors array.

"failed_ids": [90232]

Field selection

fields

Limits which fields the response returns. On large lists it reduces the amount of data transferred.

?fields=id,invoice_number

File name

filename

The file name of the uploaded document; a required field alongside the Base64 content.

"filename": "szamla.pdf"

Filing date

filing_date

The time the document was filed. Together with the filing number it belongs to document management.

"filing_date": "2026-07-14T09:00:00Z"

Filing number

filing_number

The filing number assigned by the system, identifying the document in document management.

"filing_number": "2026/00123"

Fulfilment date

fulfilled_at

The date the economic event actually took place, which determines when VAT becomes chargeable. In the API this is the fulfilled_at field; it can also be used for filtering via date_field=fulfilled_at.

"fulfilled_at": "2026-07-01"

Gross amount

gross_amount

The amount including VAT, in the currency of the document. The API returns it as a decimal string, alongside the net and VAT amounts.

"gross_amount": "31750.00"

Has document image

has_artifact

Indicates whether an image or PDF attachment belongs to the item. Without one, bookkeeping usually cannot be completed.

"has_artifact": true

Identifier

id

The unique integer identifier of every resource. There is no type prefix, and identifiers of different resource types are independent of each other.

"id": 90231

Identifier list

ids

The input of bulk operations: the identifiers of the affected records (for example approval, deletion, export).

"ids": [90231, 90232]

Income (outgoing invoice)

income

A sales invoice issued by the business. In the QUiCK Public API this is the income resource, available through the list and update endpoints.

GET /1/incomes/

Incomplete

incomplete

Marks a document with incomplete data — typically recognition could not fill every field and human completion is needed.

"incomplete": true

Intake origin

origin

Indicates how the document entered the system: upload — file upload, public_api — public API, email — email intake, quick_browser_addon — browser add-on.

"origin": "public_api"

Invoice issue date

issued_at

The date the invoice was issued according to the document (ISO 8601). Keep it distinct from the fulfilment date and the payment due date.

"issued_at": "2026-07-14"

Invoice number

invoice_number

The invoice number as printed on the document by the issuer. It can also be used to filter lists.

"invoice_number": "INV-2026-001"

Item title

title

The title of salary and tax items. On salary items it may be a date, marking the posting period.

"title": "2026-07-01"

Ledger number

ledger_number_id

The identifier of the ledger number on an assignment line. Name and code are filled in automatically from the master record. Only applied when advanced accounting is enabled.

"ledger_number_id": 41

Monthly salary

monthly_salary

A monthly salary summary. Read with GET /1/monthly-salaries/ or GET /2/monthly-salaries/.

GET /1/monthly-salaries/

Monthly tax

monthly_tax

A monthly tax summary used for tax returns. Read with GET /1/monthly-taxes/ or GET /2/monthly-taxes/.

GET /1/monthly-taxes/

Net amount

net_amount

The amount excluding VAT, in the currency of the document. The API returns it as a decimal string to avoid floating-point rounding errors.

"net_amount": "25000.00"

Next page

next

The full URL of the next page, or null when there are no more items. Following it is the most reliable way to walk a whole list.

"next": "https://api.quick.riport.co.hu/1/expenses/?page=2"

Ordering

ordering

Orders results by a field; a - prefix means descending order (for example -created).

?ordering=-created

Page number

page

The number of the requested page in paginated lists (starting at 1). QUiCK uses page-number pagination, not cursor-based pagination.

?page=2

Page size

page_size

The number of items returned per page. A larger value means fewer requests but a slower response; 50–200 is usually optimal.

?page_size=100

Pagination cursor

cursor

The opaque pointer used by /2/ pagination, carried in the response's next / previous link. Follow it verbatim: the value is not meant to be constructed or decoded, and nothing should depend on its internal structure.

?cursor=cD0yMDI2LTA4LTAxKzEwJTNBMTIlM0EwMA%3D%3D

Partner

partner

A customer or a vendor of the business. One partner can be both at the same time — the is_customer and is_vendor fields indicate which. Partner records can be reconciled by tax number (tax_number).

GET /1/partners/

Partner id

partner_id

The identifier of the partner master record. When sending a document it takes precedence over inline partner data.

"partner_id": 5501

Payment

payment

A financial transaction that always belongs to a cash account or bank account, and can be linked to documents through its transactions.

GET /1/payments/

Payment due date

due_at

The day by which the invoice must be settled. In the API this is the due_at field; payment state is tracked separately in paid_status (1 — unpaid, 2 — paid, 3 — instalment).

"due_at": "2026-07-15"

Payment method

payment_method

How the document is settled: transfer — bank transfer, cash — cash, card — bank card, cod — cash on delivery.

"payment_method": "transfer"

Payment source

paid_through

The identifier of the cash account or bank account the document was settled from.

"paid_through": 12

Payment status

paid_status

The settlement state of the document as an integer code: 1 — unpaid, 2 — paid, 3 — instalment.

"paid_status": 1

Period end

to_date

The end date of the period filter, applied to the date field selected by date_field.

?to_date=2026-07-31

Period start

from_date

The start date of the period filter. date_field decides which date field it applies to. When syncing, use a small overlap so boundary items are not missed.

?from_date=2026-07-01

Planned payment date

planned_payment_date

The day settlement is planned for — the basis of liquidity planning. It may differ from the legally binding payment due date.

"planned_payment_date": "2026-07-25"

Previous page

previous

The full URL of the previous page in a paginated response, or null when you are on the first page.

"previous": null

Processed

is_processed

Indicates whether processing of the document has finished. Usable as a list filter.

?is_processed=true

Processed ids

processed

In the POST /2/expenses/create/ response, the identifiers of the expenses accepted for processing.

"processed": [90231]

Pulse (balance summary)

pulse

A lightweight summary endpoint returning the balances of the company's cash and bank accounts. An ideal first call to verify the token and the connection.

GET /1/pulse/

Result list

results

The field holding the data of a paginated response; together with next / previous it forms the pagination envelope. On /1/ endpoints it is an array and comes with a count; on /2/ endpoints it is also an array but without count (cursor pagination). The one exception is GET /2/expenses/, where results is an object: the invoices live under expenses, alongside the reference lists needed to resolve them.

"results": [ { "id": 90231 } ]

Revenue type

revenue_type

The revenue category (cost centre) on an assignment. Its catalogue is managed under /2/revenue-types/.

"revenue_type": 8

Review done

review_done

Marks the income as reviewed when updating it. Applied with advanced accounting enabled.

"review_done": true

Salary

salary

A salary item in the company's payroll posting. Managed through /1/salaries/create/, /1/salaries/update/ and /1/salaries/delete/, and the same operations in v2.

POST /1/salaries/create/

Secondary id

secondary_id

An additional external reference identifier for cross-system lookups (for example an ERP document number).

"secondary_id": "SAP-778812"

Seen at

user_saw

The time a user first opened the document. Useful for filtering out new, not yet reviewed items.

"user_saw": "2026-07-14T10:30:00Z"

Simple tags

simple_tags

A list of text-only tag identifiers on the document. When sent, the list replaces the existing set.

"simple_tags": [12]

Storno invoice

storno

The complete voiding of an earlier invoice. The document type is indicated by the invoice_class field; the storno invoice has the value 1.

"invoice_class": 1

Success count

success_count

The number of successful items in a bulk operation. Its counterpart is failure_count; on a partial success both can be greater than zero.

"success_count": 4

Successful ids

success_ids

The identifiers of the items the bulk operation processed successfully.

"success_ids": [90231]

Tag

tag

A freely defined tag on documents and accounting assignments. Managed under /2/tags/; lists can be filtered with with_tag_ids and without_tag_ids.

"tags": [3, 7]

Tax code

tax_code

Master data of the tax codes used for tax returns.

GET /1/tax-codes/

Tax number

tax_number

The Hungarian tax number of the partner in xxxxxxxx-y-zz format. It is the partner's tax_number field; on expenses and incomes it also appears denormalised as partner_tax_number.

"tax_number": "12345678-2-42"

Total count

count

The number of all items matching the filter — not just those on the current page. Use it to calculate the number of pages. Present only in the /1/ pagination envelope; the cursor pagination of /2/ endpoints returns no total.

"count": 128

VAT amount

vat_amount

The VAT content of a document or assignment, as a decimal string. Together with the net and gross amounts it forms a consistent triple.

"vat_amount": "6750.00"

VAT ledger number

vat_ledger_number_id

The identifier of the ledger number for the VAT content of an assignment line. Also only applied with advanced accounting enabled.

"vat_ledger_number_id": 42

VAT percentage

percent

The percentage rate of a VAT category in the master data. Documents carry the category identifier, not this value.

"percent": 27.0

VAT period handling

enable_vat_period

The flag indicating that VAT period handling is enabled for the company. It determines whether the accounting period fields are meaningful.

"enable_vat_period": true

VAT rate

vat_rate

The VAT rate applied to a line. On an assignment the vat field holds the VAT category identifier; the categories (code, percentage, VAT territory) are read from /2/accounting/vat-categories/.

GET /2/accounting/vat-categories/

VAT territory

vat_area

The VAT territorial classification of the document: HU — domestic, EU — intra-Community, 3RD — third country.

"vat_area": "EU"

Vendor

is_vendor

Indicates whether the partner acts as a vendor. A required field on the partner record.

"is_vendor": true