Invoices

Search for invoices

Search for invoices.

post/api/Invoices/Search

Request

  • Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
  • URL: https://api.omnium.no/api/Invoices/Search
  • Auth: API key in header Authorization

Request body

takeinteger

Paged search - max number of invoices to return

pageinteger

Paged search - page

invoiceIdstring nullable

Search Invoices by Id

invoiceTypesstring[] nullable

Search Invoices by invoice types

emailstring nullable

Search Invoices by Email

phonestring nullable

Search Invoices by Phone

customerNamestring nullable

Search Invoices by CustomerName

customerIdstring nullable

Search Invoices by CustomerId

orderIdstring nullable

Search Invoices by OrderId

projectIdstring nullable

Search Invoices by ProjectId

querystring nullable

Free text search Invoices (search applies to fields Id, OrderId, ProjectId, CustomerName, CustomerId, InvoiceNumber, Kid and ExternalIds)

isPaidboolean nullable

Search Invoices by payment statust

createdFromstring date-time nullable

Search Invoices by CreatedDate

createdTostring date-time nullable

Search Invoices by CreatedDate

sortOrderstring nullable

Sort result. Available options [CreatedAscending, CreatedDescending, ModifiedAscending, ModifiedDescending, InvoiceDueDateAscending, InvoiceDueDateDescending]

marketIdsstring[] nullable

Limit search by market IDs

storeIdsstring[] nullable

Limit search by store IDs

includeTotalsboolean

Include the totals field in the response

Response

Invoices found and returned

totalHitsinteger

Total number of hits

scrollIdstring nullable

The Scroll ID is used when fetching large amounts of data. Whenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents

isValidboolean

Deprecated

Changes

No recorded changes to this operation across all 1 revision of this API.