Ready to Learn?Ex Libris products all provide open APIs


Get Invoices


This API returns a list of Invoices.

Resource URL
GET /almaws/v1/acq/invoices/
Try it now!

The full WADL documentation is available here.

URL Parameters None

Query string Parameters

ParameterTypeRequiredDescription
qxs:string Optional. Default: allSearch query. Optional. Searched fields: invoice_number, vendor_code, additional_pol_reference, invoice_reference_number, pol_number, pol_title, po_number, vendor_name, all. Note that some combinations of search fields cannot be used together. (see Brief Search)
limitxs:int Optional. Default: 10 Limits the number of results. Optional. Valid values are 0-100. Default value: 10.
offsetxs:int Optional. Default: 0 Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned.
viewxs:string Optional. Invoice view. If view=brief, invoices will be returned without lines.
base_statusxs:string Required Invoice base status. Possible values are ACTIVE, CLOSED
invoice_workflow_statusxs:string Required Invoice workflow status. Possible codes are listed in 'InvoiceStatus' code table
ownerxs:string Required Invoice owner. Can be the institution code or a library code. See Get libraries API.
creation_formxs:string Required Invoice creation form. Possible codes are listed in 'InvoiceCreationForm' code table

Body Parameters None

Output This method returns a Invoices object.
For detailed documentation see here.

Possible Error Codes
CodeMessage
402119General error.
402400Invoice X not found.
401873Request failed: X