Post
/api/v1/invoices/salesinvoice/filter
Get a paged list of existing sales invoices, optionally filtered to the given parameters.
Description
Retrieve a paged list of existing sales invoices, filtered to the given parameters.
Use Case
The user needs to identify which sales invoices are currently registered in Bloxs. For example, they may want to retrieve only overdue invoices to initiate payment reminders or debt collection procedures. Alternatively, they may wish to display a specific customer’s open invoices in a portal or during support interactions, using the customer ID as a filter.
Request fields
The request contains the following fields:
| Field | Description |
|---|---|
| pageSize | The maximum number of pages to be returned per request. The default number is 100 and the maximum is 1.000. If more results are returned than specified in the PageSize, the remaining pages are dropped based on the reference (number). |
| pageNumber | This allows the requesting party to specify which of the pages they want to receive. |
| columnName | The data field based on which sorting is applied. For example, if the results are sorted based on ascending name, columnName will contain the value 'name'. |
| order | Based on this value, the property defined in 'columnName' is either sorted ascending (a-z) or descending (z-a). |
| reference | This pertains to the reference of the specific sales invoice. This reference can be used to obtain further information regarding the invoice through the GET operation. |
| ownerReference | This pertains to the reference of the owner of the object. |
| relationReference | This is the reference of the relation associated with the reminder. It can refer to any relation type within the system and is not necessarily a tenant. For example, it may also refer to an owner who has an outstanding debt with another owner. |
| invoiceDate.from | The invoice date. This defines the lower border of the range. |
| invoiceDate.to | The invoice date. This defines the upper border of the range. |
| paymentTermName | Description of the payment term, for example: "Payment must be made by [date]." |
| dueDate.on | Due date of the invoice. This defines the lower border of the range. |
| dueDate.to | Due date of the invoice. This defines the upper border of the range. |
| totalAmountExcl.from | Total amount excluding VAT. The amount is expressed with two decimals. This defines the lower border of the range. |
| totalAmountExcl.to | Total amount excluding VAT. The amount is expressed with two decimals. This defines the upper border of the range. |
| totalAmountVAT.from | Total VAT amount. The amount is expressed with two decimals. This defines the lower border of the range. |
| totalAmountVAT.to | Total VAT amount. The amount is expressed with two decimals. This defines the upper border of the range. |
| totalAmountIncl.from | Total amount including VAT. The amount is expressed with two decimals. This defines the lower border of the range. |
| totalAmountIncl.to | Total amount including VAT. The amount is expressed with two decimals. This defines the upper border of the range. |
| outstandingAmount.from | Total outstanding amount for this month only. This reflects the amount due specifically within the current month and does not include any outstanding balances from previous months. The amount is expressed with two decimals. This defines the lower border of the range. |
| outstandingAmount.to | Total outstanding amount for this month only. This reflects the amount due specifically within the current month and does not include any outstanding balances from previous months. The amount is expressed with two decimals. This defines the upper border of the range. |
| totalOutstandingAmountReacalculateDate.from | The date on which the outstanding debt was last updated. This value is generated by Bloxs. This defines the lower border of the range. |
| totalOutstandingAmountReacalculateDate.to | The date on which the outstanding debt was last updated. This value is generated by Bloxs. This defines the upper border of the range. |
Security
HTTP
Type Bearer
Please enter a valid token
Body parameters
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)
Valid values[
0,
1
]
filter
object (SalesInvoiceSearchRequestFilter)
reference
string | null
ownerReference
string | null
relationReference
string | null
invoiceDate
object (CompareFilterModelDateTime)
from
string (date-time) | null
to
string (date-time) | null
paymentTermName
string | null
dueDate
object (CompareFilterModelDateTime)
from
string (date-time) | null
to
string (date-time) | null
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
outstandingAmount
object (CompareFilterModelDecimal)
from
number (double) | null
to
number (double) | null
outstandingAmountRecalculateDate
object (CompareFilterModelDateTime)
from
string (date-time) | null
to
string (date-time) | null
Responses
200
OK
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)
Valid values[
0,
1
]
salesInvoices
Array of object (SalesInvoiceSearchResultFilter) | null
object
reference
string | null
ownerReference
string | null
relationReference
string | null
invoiceDate
string (date)
paymentTermName
string | null
dueDate
string (date)
totalAmountExcl
number (double)
totalAmountVAT
number (double)
totalAmountIncl
number (double)
outstandingAmount
number (double) | null
outstandingAmountRecalculateDate
string (date-time) | null