API Docs

__METHOD= GET . __PATH= /almaws/v1/acq/invoices/ .

Get Invoices

This API returns a list of Invoices.

Resource URL

GET /almaws/v1/acq/invoices/

API Description

URL Parameters

None

Querystring Parameters

ParameterTypeRequiredDescription
qxs:stringOptional. 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:intOptional. Default: 10Limits the number of results. Optional. Valid values are 0-100. Default value: 10.
offsetxs:intOptional. Default: 0Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned.
viewxs:stringOptional.Invoice view. If view=brief, invoices will be returned without lines.
base_statusxs:stringRequiredInvoice base status. Possible values are ACTIVE, CLOSED
invoice_workflow_statusxs:stringRequiredInvoice workflow status. Possible codes are listed in 'InvoiceStatus' code table
ownerxs:stringRequiredInvoice owner. Can be the institution code or a library code. See Get libraries API.
creation_formxs:stringRequiredInvoice creation form. Possible codes are listed in 'InvoiceCreationForm' code table

Body Parameters

None

Output

This method returns a Invoices object. See doc

Possible Error Codes

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