Documentation Index

Fetch the complete documentation index at: https://www.bloxs.io/llms.txt

Use this file to discover all available pages before exploring further.

Get sales invoices service filtered and paged

Prev Next
Post
/api/v1/invoices/salesinvoiceservices/filter

Get a paged list of existing sales invoice services, optionally filtered to the given parameters.

Get Sales Invoice Services Filtered and Paged (POST)

Retrieves a paged, optionally filtered list of existing sales invoice services.

A developer calls this endpoint to search for sales invoice services matching one or more criteria (for example by owner, relation, supply date, or payment method), or to retrieve the full set of sales invoice services in manageable pages when no filter is needed.


Request Fields

Field

Type

Required

Description

paging.pageSize

integer, 1 to 1000, nullable

Optional

The number of sales invoice services to return per page. Defaults to 100 when not given.

paging.pageNumber

integer, 1 to 9999, nullable

Optional

The page number to retrieve. Defaults to 1 when not given.

sorting.columnName

string, nullable

Optional

The name of the field to sort the results by.

sorting.order

integer (enum), nullable

Optional

The sort direction. Allowed values: 0 = Ascending, 1 = Descending.

filter.reference

string, nullable

Optional

Filters on the sales invoice service's internal identifier (Reference/Code).

filter.ownerReference

string, nullable

Optional

Filters on the owner whose financial administration the service belongs to.

filter.relationReference

string, nullable

Optional

Filters on the relation (customer) the service is delivered to.

filter.supplyDate.from

string (date-time), nullable

Optional

Inclusive lower bound for filtering on supply date, formatted as ISO 8601. If omitted, there is no lower bound.

filter.supplyDate.to

string (date-time), nullable

Optional

Inclusive upper bound for filtering on supply date, formatted as ISO 8601. If omitted, there is no upper bound.

filter.paymentMethod

integer (enum), nullable

Optional

Filters on the payment method. Allowed values: 1 = DirectDebit, 2 = BankTransfer.

filter.totalAmountExcl.from

number (double), nullable

Optional

Inclusive lower bound for filtering on the total amount excluding VAT. If omitted, there is no lower bound.

filter.totalAmountExcl.to

number (double), nullable

Optional

Inclusive upper bound for filtering on the total amount excluding VAT. If omitted, there is no upper bound.

filter.totalAmountVAT.from

number (double), nullable

Optional

Inclusive lower bound for filtering on the total VAT amount. If omitted, there is no lower bound.

filter.totalAmountVAT.to

number (double), nullable

Optional

Inclusive upper bound for filtering on the total VAT amount. If omitted, there is no upper bound.

filter.totalAmountIncl.from

number (double), nullable

Optional

Inclusive lower bound for filtering on the total amount including VAT. If omitted, there is no lower bound.

filter.totalAmountIncl.to

number (double), nullable

Optional

Inclusive upper bound for filtering on the total amount including VAT. If omitted, there is no upper bound.


Response Fields

Field

Type

Required

Description

paging.pageSize

integer, 1 to 1000, nullable

Optional

The page size used to produce this result set.

paging.pageNumber

integer, 1 to 9999, nullable

Optional

The page number returned in this result set.

sorting.columnName

string, nullable

Optional

The field the results are sorted by.

sorting.order

integer (enum), nullable

Optional

The sort direction applied. Allowed values: 0 = Ascending, 1 = Descending.

salesInvoiceServices

array of objects, nullable

Optional

The list of sales invoice services matching the filter for this page. See sub-fields below.

salesInvoiceServices.reference

string, nullable

Optional

The internal identifier (Reference/Code) of the sales invoice service.

salesInvoiceServices.externalIdentifier

string, nullable

Optional

The external API identifier of the sales invoice service, if any.

salesInvoiceServices.salesContractReference

string, nullable

Optional

The internal identifier of the sales contract this service is linked to, if applicable.

salesInvoiceServices.ownerReference

string, nullable

Optional

The internal identifier of the owner whose financial administration this service belongs to.

salesInvoiceServices.relationReference

string, nullable

Optional

The internal identifier of the relation (customer) this service is delivered to.

salesInvoiceServices.supplyDate

string (date)

Optional

The date the service was supplied, formatted as ISO 8601 (YYYY-MM-DD).

salesInvoiceServices.workflowState

integer (enum)

Optional

The approval workflow state of this sales invoice service. Allowed values: 1 = Draft, 2 = OnHold, 3 = Cancelled, 4 = ApprovalWorkflow, 7 = Final, 9 = Disapproved, 10 = OwnerApprovalWorkflow, 11 = DisapprovedByOwner.

Security
Body parameters
Expand All
object
paging
object (PagingInfo)
pageSize
integer (int32) | null
Minimum1
Maximum1000
pageNumber
integer (int32) | null
Minimum1
Maximum9999
sorting
object (SortingInfo)
columnName
string | null
order
integer (int32)

Ascending = 0 Descending = 1

filter
object (SalesInvoiceServiceSearchRequestFilter)
reference
string | null
ownerReference
string | null
relationReference
string | null
supplyDate
object (CompareFilterModelDateTime)
from
string (date-time) | null
to
string (date-time) | null
paymentMethod
integer (int32) | null

DirectDebit = 1 BankTransfer = 2 Withdrawal = 3 Cash = 4 iDEAL = 5

totalAmountExcl
object (CompareFilterModelDecimal)
from
number (double) | null
to
number (double) | null
totalAmountVAT
object (CompareFilterModelDecimal)
from
number (double) | null
to
number (double) | null
totalAmountIncl
object (CompareFilterModelDecimal)
from
number (double) | null
to
number (double) | null
Responses
200

OK

Expand All
object
paging
object (PagingInfo)
pageSize
integer (int32) | null
Minimum1
Maximum1000
pageNumber
integer (int32) | null
Minimum1
Maximum9999
sorting
object (SortingInfo)
columnName
string | null
order
integer (int32)

Ascending = 0 Descending = 1

salesInvoiceServices
Array of object (SalesInvoiceServiceSearchResultFilter) | null
object
reference
string | null
externalIdentifier
string | null
salesContractReference
string | null
ownerReference
string | null
relationReference
string | null
supplyDate
string (date)
workflowState
integer (int32)

Draft = 1 OnHold = 2 Cancelled = 3 ApprovalWorkflow = 4 Final = 7 Disapproved = 9 OwnerApprovalWorkflow = 10 DisapprovedByOwner = 11