Skip to main content
GET
List proformas

Authorizations

Authorization
string
header
required

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

Query Parameters

number
string

Filter by document number.

clientId
integer

Filter by client.

paymentStatus
enum<string>

Filter by payment status.

Available options:
paid,
unpaid,
partially_paid,
overdue,
will_not_be_paid
issueDateFrom
string<date>

Issue date from.

issueDateTo
string<date>

Issue date to.

dueDateFrom
string<date>

Due date from.

dueDateTo
string<date>

Due date to.

totalFrom
number<float>

Minimum total amount without VAT.

totalTo
number<float>

Maximum total amount without VAT.

withoutInvoice
boolean

When true, only proformas that do not yet have a linked final invoice are returned.

sortBy
enum<string>
default:issueDate

Field used for sorting.

Available options:
number,
issueDate,
dueDate,
total,
totalWithVat
sortDirection
enum<string>
default:desc

Sorting direction.

Available options:
asc,
desc
perPage
integer
default:10

Number of results per page.

Required range: 1 <= x <= 500
page
integer
default:1

Page number.

Required range: x >= 1

Response

Paginated proforma list in preview shape.

data
object[]

List of proforma preview objects for the current page.

paginator
object

Pagination information for the current result set.