Get journal posts filtered and paged

Prev Next
Post
/api/v1/journalposts/journalpost/filter

Get a paged list of existing journal posts, optionally filtered to the given parameters.

Description

The endpoint retrieves a paged list of existing journal posts from the financial accounting administration, filtered to the given parameters.

Use Case

The user wants to retrieve a full list of journal posts associated with a specific owner. By using the ownerReference the user can retrieve this list. As another example the user can utilize this endpoint to retrieve the reference of a journal post needed to make a GET journal post request.   

Request fields

The request contains the following fields:

FieldDescription
pageSizeThe 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).
pageNumberThis allows the requesting party to specify which of the pages they want to receive.
ColumnNameThe data field based on which sorting is applied. For example, if the results are sorted based on financial year, columnName will contain the value 'financial year'.
orderBased on this value, the property defined in 'columnName' is either sorted ascending (a-z) or descending (z-a).
referenceThis pertains to the reference of the specific sales invoice. This reference can be used to obtain further information regarding the invoice through the INVULLEN
ownerReferenceThis pertains to the reference of the owner of the object.
journalCodeThis pertains to the journal code ode of the journal in which the entry is recorded. Indicates the category or type of transaction.
outputAllWorkflowStates 

1 = Draft

Concept status. Edits are still possible.

2 = OnHold

This means that an invoice is on hold before it can be approved, for example due to a dispute with the supplier.

3 = Cancelled

This invoice was, for example, not needed or created in error.

4 = ApprovalWorkflow

Submitted for approval. For example, the invoice is pending approval by person X. This may involve a simple or extended approval chain of multiple people.

7 = Final

This is the most relevant status for integration partners. Bookings & invoices are then fully processed (and potentially sent).

9 = Disapproved

The invoice has been returned by an approver for adjustments by the creator.

10 = OwnerApprovalWorkflow

Submitted for approval by the owner. The invoice is then awaiting the owner’s approval via the owners’ portal. This is in addition to the normal approval process but is linked to the use of the owners’ portal.

11 = DisapprovedByOwner

Disapproved by the owner. This requires further review.


financialYearFinancial year to which the entry belongs.
financialPeriodIndexIndicates the financial period in which the transaction is recorded. 
createdAt.fromThe creation date. This defines the lower border of the range.
createdAt.toThe creation date. This defines the upper border of the range.
lastModified.fromThe last modified date. This defines the lower border of the range.
lastModified.toThe last modified date. This defines the upper border of the range.


Security
HTTP
Type Bearer

Please enter a valid token

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)
Valid values[ 0, 1 ]
filter
object (JournalPostSearchRequestFilter)
reference
string | null
ownerReference
string | null
journalCode
string | null
outputAllWorkflowStates
boolean
financialYear
integer (int32) | null
financialPeriodIndex
integer (int32) | null
createdAt
object (CompareFilterModelDateTime)
from
string (date-time) | null
to
string (date-time) | null
lastModified
object (CompareFilterModelDateTime)
from
string (date-time) | null
to
string (date-time) | 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)
Valid values[ 0, 1 ]
journalPosts
Array of object (JournalPostSearchResultFilter) | null
object
reference
string | null
ownerReference
string | null
journalCode
string | null
workflowState
integer (int32)
Valid values[ 1, 2, 3, 4, 7, 9, 10, 11 ]
financialYear
integer (int32)
financialPeriodIndex
integer (int32)
createdAt
string (date-time)
lastModified
string (date-time)