Invoices Resource
Building a query:
To access a collection of invoices construct the URL in the following manner:
https://acq.sd00.worldcat.org/invoices?{query}
To access information on a specific invoice construct the URL in the following manner:
https://acq.sd00.worldcat.org/invoices/{invoiceNumber}
To flag an invoice as paid you can submit a GET request to the following URL:
https://acq.sd00.worldcat.org/invoices/{invoiceNumber}/pay
where {query} or {invoiceNumber} provide information about the invoices you are requesting information for.
Examples:
Below are some sample URLs and an explanation of what they are querying using different HTTP methods:
| example uRL | http method | notes |
|---|---|---|
| https://acq.sd00.worldcat.org/invoices?q=invoiceStatus:OPEN&startIndex=2&itemsPerPage=5 | GET | Returns a collection of invoices where the status is OPEN the collection starts at index 2 and there are 5 items per page |
| https://acq.sd00.worldcat.org/invoices/INV-2010-59 | GET | Returns information about a specific invoice with the ID INV-2010-59. |
| https://acq.sd00.worldcat.org/invoices/INV-2010-59 | DELETE | Deletes a specific invoice with the ID INV-2010-59. |
| https://acq.sd00.worldcat.org/invoices | POST | Creates a new invoice using the content of the post body. |
| https://acq.sd00.worldcat.org/invoices/INV-2010-59 | PUT | Updates the information about a specific invoice with the ID INV-2010-59. |
| https://acq.sd00.worldcat.org/invoices/INV-2010-59/pay | GET | Flags an invoice with the ID INV-2010-59 as paid. |
Query options:
Below is a list of all the possible parameters that can be used as part of the invoices resource, all of them are optional:
| parameter | description |
|---|---|
| q | Available Queries are: vendorName, vendorInvoiceNumber, invoiceStatus (ex. vendorName:EBSCO, vendorInvoiceNumber:12345, and invoiceStatus=OPEN) |
| startIndex | What index item to start the collection at. |
| itemsPerPage | How many collection items to return per request. |
The OCLC Developer Network supports the use of OCLC Web Services—a set of tools and APIs that expose data and services for WorldCat and our member libraries and partner institutions or companies. learn more »
© 2010 OCLC Domestic and international trademarks and/or service marks of OCLC Online Computer Library Center, Inc. and its affiliates
Follow the OCLC Developer Network: