Acquisitions

The Acquisitions API allows access to acquisitions related information, as described in the map below.

 

Alma provides a set of Web services for handling acquisitions information, enabling you to quickly and easily manipulate acquisitions details. These Web services can be used by external systems – such as subscription agent systems – to retrieve or update acquisitions data.

Funds

APIPath
Retrieve funds
GET /almaws/v1/acq/funds
Retrieve Fund
GET /almaws/v1/acq/funds/{fund_id}

PO Lines

APIPath
Retrieve PO-Lines
GET /almaws/v1/acq/po-lines
Create PO-Line
POST /almaws/v1/acq/po-lines
Cancel PO-Line
DELETE /almaws/v1/acq/po-lines/{po_line_id}
Get PO-Line
GET /almaws/v1/acq/po-lines/{po_line_id}
Update PO-Line
PUT /almaws/v1/acq/po-lines/{po_line_id}
Get PO-Line Items
GET /almaws/v1/acq/po-lines/{po_line_id}/items
Receive New Item
POST /almaws/v1/acq/po-lines/{po_line_id}/items
Receive an Existing Item
POST /almaws/v1/acq/po-lines/{po_line_id}/items/{item_id}

Vendors

APIPath
Retrieve vendors
GET /almaws/v1/acq/vendors
Create Vendor
POST /almaws/v1/acq/vendors
Delete Vendor
DELETE /almaws/v1/acq/vendors/{vendorCode}
Get Vendor
GET /almaws/v1/acq/vendors/{vendorCode}
Update Vendor
PUT /almaws/v1/acq/vendors/{vendorCode}
Get Vendor Invoices
GET /almaws/v1/acq/vendors/{vendorCode}/invoices
Get Vendor PO Lines
GET /almaws/v1/acq/vendors/{vendorCode}/po-lines

Invoices

APIPath
Create Invoice
POST /almaws/v1/acq/invoices
Get Invoices
GET /almaws/v1/acq/invoices/
Get Invoice
GET /almaws/v1/acq/invoices/{invoice_id}
Invoice Service
POST /almaws/v1/acq/invoices/{invoice_id}
Get Invoice Lines
GET /almaws/v1/acq/invoices/{invoice_id}/lines
Create Invoice Line
POST /almaws/v1/acq/invoices/{invoice_id}/lines
Get Invoice Line
GET /almaws/v1/acq/invoices/{invoice_id}/lines/{invoice_line_id}
Update Invoice Line
PUT /almaws/v1/acq/invoices/{invoice_id}/lines/{invoice_line_id}

Licenses

APIPath
Create License
POST /almaws/v1/acq/licenses
Get Licenses
GET /almaws/v1/acq/licenses/
Delete License
DELETE /almaws/v1/acq/licenses/{license_code}
Get License
GET /almaws/v1/acq/licenses/{license_code}
Update License
PUT /almaws/v1/acq/licenses/{license_code}
Get Licenses Amendments
GET /almaws/v1/acq/licenses/{license_code}/amendments
Create License Amendment
POST /almaws/v1/acq/licenses/{license_code}/amendments
Delete License Amendment
DELETE /almaws/v1/acq/licenses/{license_code}/amendments/{amendment_code}
Get License For Code and Amendment
GET /almaws/v1/acq/licenses/{license_code}/amendments/{amendment_code}
Update License Amendment
PUT /almaws/v1/acq/licenses/{license_code}/amendments/{amendment_code}

OpenAPI Specification

For information about the OpenAPI standard, see the OpenAPI Initiative. You can also read about OpenAPI support in Ex Libris APIs.

OpenAPI Specification

Download the OpenAPI specification for these APIs in JSON or YAML format:

Swagger Codegen

Download an SDK powered by the Swagger Code Generator:

Download SDK
Swagger Editor

The Swagger Editor provides a side-by-side view of the specification and the Swagger UI console. It's an easy way to explore the standard and learn by playing.

View this API specification in the Swagger Editor

 

AcquisitionsVendorsFundsLicensesPO LinesInvoicesPO LinesInvoicesAmendmentsItems