Invoice Item Resource

URL and Supported Request

The Invoice Item Resource supports five operations.

Operation Resource URL HTTP METHOD
Create https://{institution-identifier}.share.worldcat.org/acquisitions/invoiceitem/data POST
Read https://{institution-identifier}.share.worldcat.org/acquisitions/invoiceitem/data/{invoiceItemNumber} GET
Update https://{institution-identifier}.share.worldcat.org/acquisitions/invoiceitem/data/{invoiceItemNumber} PUT
Delete https://{institution-identifier}.share.worldcat.org/acquisitions/invoiceitem/data/{invoiceItemNumber} DELETE
Search https://{institution-identifier}.share.worldcat.org/acquisitions/invoiceitem/search?q={query} GET

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 Item Schema.

Parameters

Parameter Required Description Expected/Sample Value
q Yes

Available indexes:

invoiceNumber

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

Example URL

Return information about invoice item with ID INVI-2012-7 from institution 128807:

GET https://128807.share.worldcat.org/acquisitions/invoiceitem/data/INVI-2012-7

Search for invoice Items from institution 128807 that have in invoice Number of INV-2012-2:

GET https://128807.share.worldcat.org/acquisitions/invoiceitem/search?q=invoiceNumber:INV-2012-2

Add a new invoice item based on a particular PO Item ID.

POST https://128807.share.worldcat.org/acquisitions/invoiceitem/data
Content-Type: application/json

{
   "orderLineItem" : {
       "resource" : "PO-2016-1-1"
   },
   "invoice" : {
          "resource" : "INV-2017-1"
   }
}