OCLC Developer Network

Invoice items response details

Examples:

The following examples demonstrate the different operations that can be executed on invoice items using HTTP methods.  The invoice items service can return data in two possible formats.

FormatAccept HeaderExtension
Atom XMLapplication/atom+xml.xml
Atom JSONapplication/json.json

 

GET an invoice item by ID:

Request:

https://acq.sd00.worldcat.org/invoiceItems/INVI-2012-7

Response:


<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns="http://www.w3.org/2005/Atom">
  <title type="text" />
  <id>org.oclc.acquisitions.data.Link@3d428308</id>
  <link href="org.oclc.acquisitions.data.Link@4e0c0251" rel="self" type="application/atom+xml" />
  <link href="https://acq.sd00.worldcat.org/invoiceItems/INVI-2012-7" rel="self" type="application/atom+xml" />
  <updated>2012-08-07T13:52:35.436Z</updated>
  <content type="application/xml">
    <invoiceItem xmlns="http://worldcat.org/xmlschemas/Acquisitions" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://worldcat.org/xmlschemas/Acquisitions http://worldcat.org/xmlschemas/Acquisitions/1.1/Acquisitions-1.1-invoiceItem.xsd">
      <link rel="self" href="https://acq.sd00.worldcat.org/invoiceItems/INVI-2012-7" type="application/atom+xml" />
      <invoiceItemNumber>INVI-2012-7</invoiceItemNumber>
      <quantity>1</quantity>
      <unitCost>12.00</unitCost>
      <discountPercentage>0.00</discountPercentage>
      <discountValue>0.00</discountValue>
      <taxPercentage>0.00</taxPercentage>
      <taxValue>0.00</taxValue>
      <shippingAmount>0.00</shippingAmount>
      <serviceCharge>0.00</serviceCharge>
      <itemType>FULL</itemType>
      <totalCost>12.00</totalCost>
      <invoiceInfo>
        <link rel="self" href="https://acq.sd00.worldcat.org/invoices/INV-2012-2" type="application/atom+xml" />
        <vendorInfo>
          <link rel="self" href="https://vic.sd00.worldcat.org/vendors/c796db47-deed-4716-abda-fb0815c09ddf" type="application/atom+xml" />
          <vendorName>Amazon</vendorName>
          <invoiceNumber>KAC-12345</invoiceNumber>
          <invoiceDate>2012-06-28</invoiceDate>
        </vendorInfo>
      </invoiceInfo>
    </invoiceItem>
  </content>
</entry>

JSON Response:


{
   "id":"org.oclc.acquisitions.data.Link@768209d7",
   "title":"",
   "content":{
      "invoice":{
         "link":{
            "type":"application/atom+xml",
            "href":"https://acq.sd00.worldcat.org/invoices/INV-2012-2",
            "rel":"self"
         },
         "vendorInfo":{
            "link":{
               "type":"application/atom+xml",
               "href":"https://vic.sd00.worldcat.org/vendors/c796db47-deed-4716-abda-fb0815c09ddf",
               "rel":"self"
            },
            "name":"Amazon",
            "invoiceNumber":"KAC-12345",
            "invoiceDate":"2012-06-28"
         },
         "etag":"261725ce96229b3fb8067f159b19d231"
      },
      "number":"INVI-2012-7",
      "description":null,
      "link":{
         "type":"application/atom+xml",
         "href":"https://acq.sd00.worldcat.org/invoiceItems/INVI-2012-7",
         "rel":"self"
      },
      "itemType":"FULL",
      "quantity":1,
      "unitCost":12.00,
      "discountPercentage":0.00,
      "discountValue":0.00,
      "taxPercentage":0.00,
      "taxValue":0.00,
      "shippingAmount":0.00,
      "serviceCharge":0.00,
      "totalCost":12.00,
      "etag":"855f474d91c60766517d5d96dd2c49ff"
   },
   "updated":"2012-08-07T13:53:44.406Z",
   "links":[
      {
         "href":"org.oclc.acquisitions.data.Link@3ff6929c",
         "rel":"self",
         "type":"application/atom+xml"
      },
      {
         "href":"https://acq.sd00.worldcat.org/invoiceItems/INVI-2012-7",
         "rel":"self",
         "type":"application/atom+xml"
      }
   ]
}

Follow the OCLC Developer Network:

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


Powered by Drupal, an open source content management system