Skip to main content
POST
Create proforma

Authorizations

Authorization
string
header
required

Bearer token created for a specific company in Integrations → API.

Headers

Idempotency-Key
string

Optional request identifier for safe retries. Use a unique value for each create request you want to retry safely.

Example:

"invoice-create-2026-03-03-001"

Body

application/json

Payload used to create a proforma. The usual happy path is clientId plus items; the backend can resolve many other values automatically. You must send either clientId or client.

clientId
integer | null
required

Existing client ID. This is the recommended way to create a proforma. If you also send the client object, it is applied as a sparse snapshot override for this specific document.

Example:

101

items
object[]
required

Proforma line items. This field stays required at all times.

Required array length: 1 - 100 elements

Payload for a single proforma line item. Three modes are supported: a manual item, priceListItemId + quantity, or priceListItemId with sparse override fields. quantity is always required. If you omit priceListItemId, you must also send name, unitPrice, and vatRate. unitId is optional; when you omit it for a manual item, the backend defaults to unit 1 (piece / Unit::Piece). If you send priceListItemId, the backend can hydrate the name, unit, unit price, and VAT rate from the price list item, and the payload then acts only as a sparse override. Per-item uuid is not part of the request contract; if you send it, the backend ignores it. warehouseAllocations are not supported for proformas.

number
string | null

Manual proforma number. If omitted, the backend generates it from the numbering series. If you send number, do not send numericalSeriesId in the same payload.

Required string length: 1 - 20
Example:

"20260001"

orderId
integer | null

Optional ID of the order the proforma is created from.

Example:

501

quotationId
integer | null

Optional ID of the quotation the proforma is created from.

Example:

601

client
object | null

Sparse client payload. When clientId is sent, it overrides the client snapshot for this document only. When clientId is omitted, the backend uses it to match or create the client.

businessCaseId
integer | null

Optional business case ID. When sent, it must be available in the token scope and to the client resolved as the final clientId.

Example:

701

numericalSeriesId
integer | null

Numbering series ID. If omitted together with number, the primary proforma series is used. If you send numericalSeriesId, do not send manual number in the same payload.

Example:

12

bankAccountId
integer

Bank account ID to use on the document. It must be available in the token scope. If omitted, the primary company bank account is used. If the company has no primary bank account configured, the endpoint returns a 422 validation error on bankAccountId.

Example:

201

issueDate
string<date>

Issue date in Y-m-d format. It must be after 2009-01-01 and before a date one year in the future. If omitted, today's date is used.

Example:

"2026-03-03"

dueDateDays
integer

Number of due days. Precedence is payload → client default → company document settings.

Required range: 0 <= x <= 1000
Example:

14

variableSymbol
integer

Variable symbol. Allowed values have 1 to 10 digits. If omitted, the backend derives it from the final document number.

Required range: 0 <= x <= 9999999999
Example:

20260001

constantSymbol
integer | null

Constant symbol. Allowed values have 1 to 4 digits. Precedence is payload → client default → null.

Required range: 0 <= x <= 9999
Example:

308

specificSymbol
integer | null

Specific symbol. Allowed values have 1 to 10 digits. Precedence is payload → client default → null.

Required range: 0 <= x <= 9999999999
Example:

55

discountType
enum<string> | null

Document-level discount type.

Available options:
percentage,
fixed
Example:

"percentage"

discountValue
number<float> | null

Document-level discount value.

Required range: x >= 0
Example:

10

transferTaxLiability
boolean

Reverse-charge tax liability flag. If omitted, false is used.

Example:

false

deliveryMethodId
integer

Delivery method ID from the delivery method reference table. Precedence is payload → client default → company document settings.

Example:

1

paymentMethodId
integer

Payment method ID from the payment method reference table. Precedence is payload → client default → company document settings.

Example:

1

currencyId
integer

Currency ID from the currency reference table. Precedence is payload → client default → company document settings.

Example:

1

languageId
integer

Language ID from the language reference table. Precedence is payload → client default → company document settings.

Example:

1

qrTypeId
integer

QR type ID from the QR type reference table. If omitted, the company document settings value is used.

Example:

1

note
string | null

Note shown on the document. Precedence is payload → client default → company document settings.

Maximum string length: 3000
Example:

"Thank you for your order."

textAboveItems
string | null

Text shown above the line items. Precedence is payload → client default → company document settings.

Maximum string length: 3000
Example:

"Thank you for working with us."

Response

Proforma created.

Proforma.

id
integer
Example:

401

uuid
string
Example:

"6b1b8c9e-66e6-4fb5-b2db-6d7c7f0f8f19"

type
string
Example:

"proforma"

number
string
Example:

"20260001"

webDokladUrl
string<uri>

Absolute URL of the public web document for this proforma.

Example:

"https://app.fintoro.sk/web-doklad/proforma/4f3f8a95-5c4a-4c8b-9e6c-8a0c1a5df3a1"

pdfDownloadUrl
string<uri>

Absolute URL of the Fintoro API endpoint that downloads this proforma PDF as an attachment.

Example:

"https://app.fintoro.sk/api/public/v1/proformas/401/pdf"

company
object

Supplier snapshot stored directly on this document.

clientId
integer | null

Live ID of the client linked to the proforma. Returns null when the contact has been deleted; the document's client snapshot is preserved.

Example:

101

client
object

Historical client snapshot stored directly on this document.

bankAccount
object

Bank account linked to the proforma as a live relation loaded through soft delete.

payments
object[]

Payments linked to this proforma ordered from newest to oldest.

variableSymbol
integer
Example:

20260001

constantSymbol
integer | null
Example:

308

specificSymbol
integer | null
Example:

55

issueDate
string<date>
Example:

"2026-03-03"

dueDate
string<date>
Example:

"2026-03-17"

businessCaseId
integer | null

Optional business case ID. When sent, it must belong to the client selected on the document.

Example:

701

discountType
string | null
Example:

"percentage"

discountValue
number<float> | null
Example:

10

transferTaxLiability
boolean
Example:

false

numericalSeriesId
integer | null
Example:

12

deliveryMethodId
integer

Delivery method ID from the delivery method reference table.

Example:

1

paymentMethodId
integer

Payment method ID from the payment method reference table.

Example:

1

currencyId
integer

Currency ID from the currency reference table.

Example:

1

languageId
integer

Language ID from the language reference table.

Example:

1

qrTypeId
integer

QR type ID from the QR type reference table.

Example:

1

note
string | null
Example:

"Thank you for your order."

textAboveItems
string | null
Example:

"Thank you for working with us."

itemsTotal
number<float>
Example:

200

itemsTotalWithVat
number<float>
Example:

240

alreadyPaid
number<float>
Example:

0

total
number<float>
Example:

200

totalWithVat
number<float>
Example:

240

toBePaid
number<float>
Example:

240

willBePaid
boolean
Example:

true

status
enum<string>
Available options:
paid,
unpaid,
partially_paid,
overdue,
will_not_be_paid
Example:

"unpaid"

hasVat
boolean
Example:

true

items
object[]