GetInvoices

post

https://{yourlidiaurl}/order/query/invoices

Queries and retrieves invoices matching the specified criteria.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The invoice query filters and pagination settings.

invoiceIds

array | null

Gets or sets a list of invoice IDs to filter by.

invoiceIds

orderIds

array | null

Gets or sets a list of order IDs to filter invoices by.

orderIds

deliveryIds

array | null

Gets or sets a list of delivery IDs to filter invoices by.

deliveryIds

orderProcessIds

array | null

Gets or sets a list of order process IDs to filter invoices by.

orderProcessIds

scopes

array of objects | null

Gets or sets a list of invoice scopes to filter by.

scopes

Allowed:

lineIds

array | null

Gets or sets a list of line IDs to filter invoices by.

lineIds

invoiceNumbers

array of strings | null

Gets or sets a list of invoice numbers to filter by.

invoiceNumbers

types

array of objects | null

Gets or sets a list of invoice types to filter by.

types

Allowed:

currencies

array of strings | null

Gets or sets a list of currency codes to filter invoices by.

currencies

issuerIds

array | null

Gets or sets a list of issuer IDs to filter invoices by.

issuerIds

fromParties

array of objects | null

Gets or sets a list of sender party identifiers to filter by.

fromParties

Allowed:

recipientIds

array | null

Gets or sets a list of recipient IDs to filter invoices by.

recipientIds

toParties

array of objects | null

Gets or sets a list of receiver party identifiers to filter by.

toParties

Allowed:

fromDate

date-time | null

Gets or sets the from date.

toDate

date-time | null

Gets or sets the to date.

minPrice

string

^-?(?:0|[1-9]\d*)(?:\.\d+)?$

Gets or sets the min price.

maxPrice

string

^-?(?:0|[1-9]\d*)(?:\.\d+)?$

Gets or sets the max price.

state

array of objects | null

Gets or sets a list of invoice states to filter by.

state

Allowed:

includeInvoicePropertyKeys

array of strings | null

Gets or sets a list of invoice property keys to include in the response.

includeInvoicePropertyKeys

uploaderPrefixes

array of strings | null

Gets or sets a list of uploader prefixes to filter invoices by.

uploaderPrefixes

fromUpdateDate

string | null

Gets or sets the from update date.

toUpdateDate

string | null

Gets or sets the to update date.

environment

string | null

Gets or sets the environment identifier (e.g., Production, Staging).

applicationIP

string | null

Gets or sets the IP address of the calling application.

userToken

string | null

Gets or sets the user token for authentication context.

sessionId

string | null

Gets or sets the session identifier of the current user session.

userId

string

^-?(?:0|[1-9]\d*)$

Gets or sets the numeric user identifier.

userIP

string | null

Gets or sets the IP address of the requesting user.

envelope

string | null

Gets or sets the envelope parameter for response shaping.

threadId

string | null

Gets or sets the thread identifier for request tracing and correlation.

includes

array of strings | null

Gets or sets the list of related entities to include in the response (e.g., Lines, Properties, Tags).

includes

searchKey

string | null

Gets or sets the search keyword used for full-text or partial matching.

pageIndex

string

^-?(?:0|[1-9]\d*)$

Gets or sets the page index for pagination (1-based).

pageSize

string

^-?(?:0|[1-9]\d*)$

Gets or sets the number of records per page for pagination.

sorting

string | null

Gets or sets the sorting expression (e.g., "Created desc", "Name asc").

status

array of objects | null

Gets or sets the list of entity statuses to filter by.

status

Headers

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Response

200

A paginated list of invoices.

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here!