Acquisitions

Ex Libris Developer Network Alma Documentation REST APIs 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

API	Path
Retrieve funds	GET /almaws/v1/acq/funds
Create Fund	POST /almaws/v1/acq/funds
Delete Fund	DELETE /almaws/v1/acq/funds/{fund_id}
Retrieve Fund	GET /almaws/v1/acq/funds/{fund_id}
Fund Service	POST /almaws/v1/acq/funds/{fund_id}
Update Fund	PUT /almaws/v1/acq/funds/{fund_id}

PO Lines

API	Path
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

API	Path
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

API	Path
Create Invoice	POST /almaws/v1/acq/invoices
Get Invoices	GET /almaws/v1/acq/invoices/
Delete Invoice's Attachment	DELETE /almaws/v1/acq/invoices/{invoice_id}/attachments/{attachment_id}
Update Invoice's Attachment	PUT /almaws/v1/acq/invoices/{invoice_id}/attachments/{attachment_id}
Get Invoice	GET /almaws/v1/acq/invoices/{invoice_id}
Invoice Service	POST /almaws/v1/acq/invoices/{invoice_id}
Update Invoice	PUT /almaws/v1/acq/invoices/{invoice_id}
Get Invoice Attachments	GET /almaws/v1/acq/invoices/{invoice_id}/attachments
Create Invoice Attachment	POST /almaws/v1/acq/invoices/{invoice_id}/attachments
Get Invoice Attachment	GET /almaws/v1/acq/invoices/{invoice_id}/attachments/{attachment_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

API	Path
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 License Attachments	GET /almaws/v1/acq/licenses/{license_code}/attachments
Create Licenses Attachment	POST /almaws/v1/acq/licenses/{license_code}/attachments
Delete Licenses Attachment	DELETE /almaws/v1/acq/licenses/{license_code}/attachments/{attachment_id}
Get Licenses Attachment	GET /almaws/v1/acq/licenses/{license_code}/attachments/{attachment_id}
Update License's Attachment	PUT /almaws/v1/acq/licenses/{license_code}/attachments/{attachment_id}
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}

Test

API	Path
GET Acq Test API	GET /almaws/v1/acq/test
POST Acq Test API	POST /almaws/v1/acq/test

Currencies

API	Path
Retrieve currencies	GET /almaws/v1/acq/currencies

FiscalPeriods

API	Path
Retrieve fiscal periods	GET /almaws/v1/acq/fiscal-periods

Fund Transactions

API	Path
Retrieve fund transactions	GET /almaws/v1/acq/funds/{fund_id}/transactions

Purchase Requests

API	Path
Get Purchase Requests	GET /almaws/v1/acq/purchase-requests/
Delete Purchase Request	DELETE /almaws/v1/acq/purchase-requests/{id}
Get Purchase Request	GET /almaws/v1/acq/purchase-requests/{id}
Operation on Purchase Request	POST /almaws/v1/acq/purchase-requests/{id}
Update Purchase Request	PUT /almaws/v1/acq/purchase-requests/{id}

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:

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