API Docs

__METHOD= POST . __PATH= /almaws/v1/acq/invoices/{invoice_id} .

Invoice Service

This API operates on an invoice. Preview - subject to changes.
It is possible to use this API to process an invoice - see blog: Creating an invoice using APIs.
It is also possible to use this API for invoice integration with ERP system - see blog Alma - ERP invoices integration using APIs.

Resource URL

POST /almaws/v1/acq/invoices/{invoice_id}

API Description

URL Parameters

ParameterTypeDescription
invoice_idxs:stringThe Invoice id.

Querystring Parameters

ParameterTypeRequiredDescription
opxs:stringRequiredThe operation to perform on the invoice. Currently, the options are 'mark_in_erp', 'paid', 'process_invoice' or 'rejected'

Body Parameters

This method takes an invoice object. See doc

Output

This method returns a Invoice object. See doc

Possible Error Codes

CodeMessage
40166410Parameter op is not valid.
402400Invoice X not found.
60260Failed to start invoice process and workflow.
60267Failed to process invoice in ERP.
60268The invoice note is mandatory.