Invoice  Resource

URLs and Supported Requests

The Invoice Resource supports eight operations.

Operation Resource URL HTTP METHOD
Create https://{institution-identifier}.share.worldcat.org/acquisitions/invoice/data POST
Read https://{institution-identifier}.share.worldcat.org/acquisitions/invoice/data/{invoiceNumber} GET
Update https://{institution-identifier}.share.worldcat.org/acquisitions/invoice/data/{invoiceNumber} PUT
Delete https://{institution-identifier}.share.worldcat.org/acquisitions/invoice/data/{invoiceNumber} DELETE
Search https://{institution-identifier}.share.worldcat.org/acquisitions/invoice/search?q={query} GET
Open https://{institution-identifier}.share.worldcat.org/acquisitions/invoice/open/{invoiceNumber} PUT
Pay https://{institution-identifier}.share.worldcat.org/acquisitions/invoice/pay/{invoiceNumber} PUT
Prepare https://{institution-identifier}.share.worldcat.org/acquisitions/invoice/prepare/{invoiceNumber} PUT

HTTP Accept Header

Schema

More information about the proper structure of XML made as part of POST and PUT requests can be found in the Invoice Schema.

No POST payload is required to to open, prepare or pay an invoice.

Parameters

Parameter Required Description Expected/Sample Value
q Yes

Available indexes:

status

status:open

status:ready

status:paid

startIndex No What index item to start the collection at.  
itemsPerPage No How many invoices to return per request.  

Example Requests

Retrieve a collection of invoices from institution 128807 where the status is OPEN:

GET https://128807.share.worldcat.org/acquisitions/invoice/search?q=status:OPEN

Retrieve an invoice from institution 128807 with ID INV-2012-2:

GET https://128807.share.worldcat.org/acquisitions/invoice/data/INV-2012-2

Open invoice with ID INV-2012-7 from institution 128807:

POST https://128807.share.worldcat.org/acquisitions/invoice/open/INV-2012-7

Prepare invoice with ID INV-2012-7 from institution 128807:

POST https://128807.share.worldcat.org/acquisitions/invoice/prepare/INV-2012-7

Pay invoice with ID INV-2012-7 from institution 128807:

POST https://128807.share.worldcat.org/acquisitions/invoice/pay/INV-2012-7