API Docs

Export Purchase Orders

Overview

Data Dictionary

Click here to download export_purchase_orders.xsd

po

Description:

FieldTypeDescription
create_datestringThe PO creation date (which is the open date of
the order).
po_numberstringThe number of the order.
statusstringThe status of the order.
vendor_codestringThe vendor to which the PO was sent.
vendor_account_codestringThe specific vendor account the PO is related to.
vendor_invoice_numberstringThe invoice number (if already exists).
billing_addressaddressThe library address to which the billing should
be sent.
shipping_addressaddressThe library address to which the material should
be sent.
shipping_methodstringThe required way of shipping. Possible codes are
listed in 'ShippingMethod' code table.
The valid values for this parameter are controlled by the code-table: ShippingMethod. These are the currently defined values for your institution:
CodeDescription
total_po_coststringThe total price of the order.
po_line_listpo_linesThe list of PO lines related to the Purchase
order.

 

po_lines

Description: The list of PO lines related to the Purchase order
line.

FieldTypeDescription
po_linepo_lineSpecific purchase order line.

 

po_line

Description: Specific purchase order line.

FieldTypeDescription
ownerstringThe library that owns this order_line
po_line_typestringThe PO line type. Possible codes are listed in
'PurchaseType' code table.
The valid values for this parameter are controlled by the code-table: PurchaseType. These are the currently defined values for your institution:
CodeDescription
po_line_referencestringThe number of the PO line.
create_datestringThe PO Line creation date (which is the open date
of the order).
vendor_codestringThe vendors code. Should be the same for all the
po lines.
vendor_account_codestringThe specific vendor account code.
note_to_vendorstringFree text note.
priceamountThe amount to pay for the specific PO line.
source_typesource_type
statusstringStatus of the POLine.
acquisition_methodacquisition_method
vendor_reference_numberstringThe number given by the vendor to the PO line.
vendor_reference_number_typestringInformation regards the vendor's reference number
type. Possible codes are listed in 'VendorReferenceNumberType'
code table.
The valid values for this parameter are controlled by the code-table: VendorReferenceNumberType. These are the currently defined values for your institution:
CodeDescription
metadatametadataMetadata Section (The mapping is to the Selection
and Acquisition Metadata).
fund_distributionsfund_distributionsFund Distribution Section.
reporting_codestringReporting Code Section.
locationslocationsLocations Section.
urls_listurlsURLs for E-book item.
base_statusbase_status
access_providerstringVendor Provider for E-book item.
pda_datapda_data
material_typestringMaterial type of item. The possible values depend
on the type of material (phisical, digital).
interested_usersinterested_usersList of users that are interested in the order.
They will be annotated when the material arrives.
invoice_referencestringInvoice reference number.

 

pda_data

Description:

FieldTypeDescription
pda_idlong
pda_codestring

 

interested_users

Description:

FieldTypeDescription
interested_userinterested_userA specific user that is interested in the
order.

 

urls

Description: The list of portolio URLs.

FieldTypeDescription
urlstringURL for E-book item.

 

fund_distributions

Description:

FieldTypeDescription
fund_distributionfund_distribution

 

fund_distribution

Description:

FieldTypeDescription
fund_external_idstringThe ID that is used to link to other system keys.
fund_codestringThe fund code.
fiscal_periodstringThe financial year to which the fund applies.
amountamountThe amount which is to be paid by the fund.

 

metadata

Description:

FieldTypeDescription
titlestringTitle (taken from PO Line descirpion - Title
field).
authorstringAuthor - taken from inventory filed250 $b
isbnIssnisbnIssn
item_descriptionstringThe volume/part/number information of the item.
publisherstringThe Publisher of the item.
publication_placestringThe publication place of the item.
publication_yearstringThe publication year of the item.
vendor_title_numberstring

 

isbnIssn

Description:

FieldTypeDescription
ISBNstringISBN
ISSNstringISSN

 

locations

Description: Information about the locations in which the
ordered items will be stored.

FieldTypeDescription
locationlocation

 

location

Description:

FieldTypeDescription
quantityintThe quantity of items per location.
shelving_locationstringThe location.
librarystringThe library which the location belongs to.
copiescopiesCopies of item in this location.

 

copies

Description:

FieldTypeDescription
copycopy

 

copy

Description:

FieldTypeDescription
barcodestring
item_policystring

 

address

Description:

FieldTypeDescription
line1stringline1
line2stringline2
line3stringline3
line4stringline4
line5stringline5
citystringThe city.
stateProvincestringThe state province.
postalCodestringThe postal code.
countrystringThe country. Possible codes are listed in
'CountryCodes' code table.
The valid values for this parameter are controlled by the code-table: CountryCodes. These are the currently defined values for your institution:
CodeDescription

 

interested_user

Description:

FieldTypeDescription
first_namestringFirst name of the user.
last_namestringLast name of the user.
user_emailstringEmail address of the user.

 

amount

Description:

FieldTypeDescription
sumstringThe total sum.
currencystringThe currency. Possible values are listed in
'Currency_CT' code table.
The valid values for this parameter are controlled by the code-table: Currency_CT. These are the currently defined values for your institution:
CodeDescription

 

Samples

XML
JSON
__