API Docs
Get Invoices
Contents
This API returns a list of Invoices.
Resource URL
GET /almaws/v1/acq/invoices/
API Description
URL Parameters
None
Querystring Parameters
Parameter | Type | Required | Description |
---|---|---|---|
q | xs:string | Optional. Default: all | Search 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) |
limit | xs:int | Optional. Default: 10 | Limits the number of results. Optional. Valid values are 0-100. Default value: 10. |
offset | xs:int | Optional. Default: 0 | Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned. |
view | xs:string | Optional. | Invoice view. If view=brief, invoices will be returned without lines. |
expand | xs:string | Optional. Default: none | This parameter allows for expanding on some information. Currently only one option is available: attachments. |
base_status | xs:string | Optional. | Invoice base status. Possible values are ACTIVE, CLOSED. All by default. |
invoice_workflow_status | xs:string | Optional. | Invoice workflow status. Possible codes are listed in 'InvoiceStatus' code table. All by default. |
owner | xs:string | Optional. | Invoice owner. Can be the institution code or a library code. See Get libraries API. All by default. |
creation_form | xs:string | Optional. | Invoice creation form. Possible codes are listed in 'InvoiceCreationForm' code table. All by default. |
Body Parameters
None
Output
This method returns a Invoices
object. See doc
Possible Error Codes
Code | Message |
---|---|
402119 | General error. |
412400 | Invoice X not found. |
401873 | Request failed: X |