API Docs

Rest Vendor

Overview

Vendor represents suppliers of library materials. A vendor can be of the following types:
*Material supplier/Subscription agent - Supplies the reading material or the subscription to the material
*Access provider - Holds the access privileges to services which manage e-resources. Access is managed via interfaces.
*Licensor - Holds the license of electronic resources.
*Governmental - Indicates that the vendor is to receive use tax (VAT) for an invoice payment. The Governmental vendor's invoices handle only use tax on invoices, ensuring that tax payments are handled separately from the regular invoice charges and go directly to the government. Use tax represents a tax on the usage of library items, and is expended from the same funds as the actual invoice charges.
Note that a vendor can be of few of the above type - for example, a vendor can be access provider and Licensor.
Governmental vendor cannot be of more types.
Only a single Governmental vendor can be defined for an insitution.

Data Dictionary

Click here to download rest_vendor.xsd

vendor

Description: Vendor Object.

FieldTypeDescription
codestringThe vendor code. Mandatory.
namestringThe vendor name. Mandatory.
additional_codestringThe vendor additional code.
financial_sys_codestringA code for the financial system account.
national_tax_idstringThe vendor's a national tax ID number.
statusstring with attr. The status of the vendor. Default value is Active.
Possible codes are listed in 'VendorSearchStatusFilter' code table.
The valid values for this parameter are controlled by the code-table: VendorSearchStatusFilter. These are the currently defined values for your institution:
CodeDescription
liable_for_vatbooleanIndication if invoices must be paid with VAT included.
For Governmental vendor, this field must be set to true in order to collect VAT for an invoice.
languagestring with attr. The vendor's language.
Possible codes are listed in 'User Preferred Language' code table.
Default is the institution language.

The valid values for this parameter are controlled by the code-table: UserPreferredLanguage. These are the currently defined values for your institution:
CodeDescription
material_supplierboolean
Indication if the vendor is a material_supplier.
Mandatory when creating a vendor.
At least one of the following fields must be true: material_supplier, access_provider, licensor, governmental.
access_providerboolean
Indication if the vendor is a access_provider.
Mandatory when creating a vendor.
At least one of the following fields must be true: material_supplier, access_provider, licensor, governmental.
licensorboolean
Indication if the vendor is a licensor.
Mandatory when creating a vendor.
At least one of the following fields must be true: material_supplier, access_provider, licensor, governmental.
governmentalboolean
Indication if the vendor is a governmental.
Mandatory when creating a vendor.
At least one of the following fields must be true: material_supplier, access_provider, licensor, governmental.
If Governmental is true, material_supplier, access_provider and licensor must be false.
tax_percentagestringA numerical value for the tax to be administered.
Relevant only for governmental vendor.
vendor_librarieslibrariesList of libraries that the vendor works with.
If not specified, the default will be the institution including all sub units.
vendor_currenciescurrenciesList of currencies with which the vendor operates.
If not specified, all the institution's supported currencies will be considered as supported.
accountsaccountsList of vendor related accounts.
For a material_supplier vendor, at least one active account must be defined.
contact_personscontact_personsList of the vendor's contacts persons. Output Parameter.
interfacesinterfacesList of the vendor's related interfaces.
Relevant only for an Access Provider vendor.
For an Access Provider vendor, at least one interface must be defined.
contact_infocontact_infoList of the vendor's contacts information.
edi_infoedi_infoThe vendor's EDI related information.
notesnotesThe vendor's related notes.
In the PUT action the incoming list will replace the existing list. If the incoming list is empty, the existing list will be deleted.

 

contact_info

Description: List of the contacts information.
In the PUT action the incoming list will replace the existing list. If the incoming list is empty, the existing list will be deleted.

FieldTypeDescription
addressesaddressesList of addresses.
emailsemailsList of email addresses.
phonesphonesList of phone numbers.
web_addressesweb_addressesList of web addresses.
Relevant only for vendor and not for an account.

 

emails

Description: List of vendor's email addresses.

FieldTypeDescription
emailemailSpecific vendor's email address.

 

email

Description: Specific vendor's email address.

FieldTypeDescription
email_addressstringThe email address. Mandatory.
descriptionstringThe email address' related description.
email_typesemail_types

 

email_types

Description: The different email types. Mandatory.

FieldTypeDescription
email_typestring with attr. Possible codes are listed in the 'UserEmailTypes' code table.

The valid values for this parameter are controlled by the code-table: MT_UserRecordType2EmailType_by_CT_UserEmailTypes_source1:organization_source2:VENDOR. These are the currently defined values for your institution:
CodeDescription

 

phones

Description: List of vendor's phone numbers.

FieldTypeDescription
phonephoneSpecific vendor's phone number.

 

phone

Description: Specific vendor's phone number.

FieldTypeDescription
phone_numberstringThe phone number. Mandatory.
phone_typesphone_typesThe different Phone types. Mandatory.

 

phone_types

Description: Phone types.

FieldTypeDescription
phone_typestring with attr. Possible values are listed in the 'UserPhoneTypes' code table.

The valid values for this parameter are controlled by the code-table: MT_UserRecordType2PhoneType_by_CT_UserPhoneTypes_source1:organization_source2:VENDOR. These are the currently defined values for your institution:
CodeDescription

 

addresses

Description: List of vendor's addresses.

FieldTypeDescription
addressaddressSpecific vendor's address.

 

address

Description: Specific vendor's address.

FieldTypeDescription
line1stringLine 1 of the address. Mandatory.
line2stringLine 2 of the address.
line3stringLine 3 of the address.
line4stringLine 4 of the address.
line5stringLine 5 of the address.
citystringThe address' relevant city. Mandatory.
state_provincestringThe address' relevant state.
postal_codestringThe address' relevant postal code.
countrystring with attr. The address' relevant country.
Possible codes are listed in the 'Country Codes' 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
address_notestringThe address' related note.
start_datedateThe date from which the address is deemed to be active.
end_datedateThe date after which the address is no longer active.
address_typesaddress_typesAddress types. Mandatory.

 

address_types

Description: Address types.

FieldTypeDescription
address_typestring with attr. Possible values are listed in the 'UserAddressTypes' code table.

The valid values for this parameter are controlled by the code-table: MT_UserRecordType2AddressType_by_CT_UserAddressTypes_source1:organization_source2:VENDOR. These are the currently defined values for your institution:
CodeDescription

 

web_addresses

Description: List of vendor's web addresses.

FieldTypeDescription
web_addressweb_addressSpecific vendor's web address.

 

web_address

Description: Specific vendor's web address.

FieldTypeDescription
urlstringThe URL. Mandatory.
url_typestring with attr. The type of the URL.
Possible codes are listed in 'UserWebAddressTypes' code table.

The valid values for this parameter are controlled by the code-table: UserWebAddressTypes. These are the currently defined values for your institution:
CodeDescription
descriptionstringThe web address description.
notestringThe web address related note.

 

edi_info

Description:

FieldTypeDescription
codestringA unique code for the vendor, per institution.
typestring with attr. The type of EDI.
Possible codes are listed in 'EdiType' code table.
The valid values for this parameter are controlled by the code-table: EdiType. These are the currently defined values for your institution:
CodeDescription
naming_conventionstring with attr. The naming convention of the EDI.
Possible codes are listed in 'EDINamingConvention' code table.
The valid values for this parameter are controlled by the code-table: EDINamingConvention. These are the currently defined values for your institution:
CodeDescription
vendor_formatstring with attr. The format of EDI communication.
Possible codes are listed in 'EdiPreference' code table.
The valid values for this parameter are controlled by the code-table: EdiPreference. These are the currently defined values for your institution:
CodeDescription
invoicesbooleanIndication whether the vendor submits invoices via EDI files.
po_linesbooleanIndication whether PO lines are sent to the vendor via EDI files.
additional_order_numberbooleanIndication whether additional PO number should be included in the EDI file sent to the vendor.
include_fund_codebooleanIndication whether fund code should be included in the EDI files sent to the vendor and received from the vendor.
do_not_prorateboolean
fund_codestring with attr. The fund from which overhead and discount amounts are charged.
Relevant only when 'Do not prorate' is true.
ftp_descriptionstringOptional description of the EDI submission details.
server_namestringThe IP address of the FTP server receiving the EDI files.
port_numberintThe port to be used on the FTP server, if the connection is not secure. This is generally port 21.
user_namestringThe user name for logging on to the FTP server.
passwordstringThe password for the FTP server.
input_pathstringThe name of the subdirectory in which the incoming invoice EDI files are to be stored.
By default, Alma displays invoices in this field. If you leave this field empty, Alma searches for incoming files in the root directory.
output_pathstringThe name of the subdirectory in which the outgoing PO EDI files are to be stored.
By default, Alma displays orders in this field. If you leave this field empty, Alma places the PO EDI files in the root directory.
allow_navigationbooleanIndication whether access to other areas of the FTP site is enabled.
secured_ftpbooleanIndication whether the FTP server is secured.
send_commandstring with attr. The send command. Possible codes are listed in 'FTPSend' code table.
The valid values for this parameter are controlled by the code-table: FTPSend. These are the currently defined values for your institution:
CodeDescription
passive_modebooleanCurrently not in use.
ftp_modestring with attr. The mode used for sending the outgoing EDI files.
Possible codes are listed in 'FTPMode' code table.
The valid values for this parameter are controlled by the code-table: FTPMode. These are the currently defined values for your institution:
CodeDescription
per_organization_unitsper_organization_unitsList of EDI codes and types for specific libraries, if used by the vendor.
One entry must be defined for the institution and its EDI code and type.
In the PUT action the incoming list will replace the existing list. If the incoming list is empty, the existing list will be deleted.
ean_accountsean_accountsList of mappings of EAN (Envelope Address Node) code to the vendor account.
In the PUT action the incoming list will replace the existing list. If the incoming list is empty, the existing list will be deleted.

 

per_organization_units

Description: List of EDI codes and types for specific libraries, if used by the vendor.
One entry must be defined for the institution and its EDI code and type.
In the PUT action the incoming list will replace the existing list. If the incoming list is empty, the existing list will be deleted.

FieldTypeDescription
per_organization_unitper_organization_unitEDI code and type for specific library/institution.

 

per_organization_unit

Description: EDI code and type for specific library/institution.

FieldTypeDescription
organization_unitstring with attr. The organization unit for which the EDI code and type are defined.
edi_codestringThe EDI code.
edi_typestring with attr. The type of EDI.
Possible codes are listed in 'EdiType' code table.
The valid values for this parameter are controlled by the code-table: EdiType. These are the currently defined values for your institution:
CodeDescription

 

ean_accounts

Description: List of mappings of EAN (Envelope Address Node) code to the vendor account.
In the PUT action the incoming list will replace the existing list. If the incoming list is empty, the existing list will be deleted.

FieldTypeDescription
ean_accountean_accountEDI code and type for specific library/institution.

 

ean_account

Description: Mapping of EAN (Envelope Address Node) code to the vendor account.

FieldTypeDescription
accountstringThe code of the vendor account to map. Should be a valid account of this vendor.
ean_codestringThe EAN code.

 

currencies

Description: List of currencies with which the vendor operates.
If not specified, all the institution's supported currencies will be considered as supported.

FieldTypeDescription
currencystring with attr. The fund's related currency.
Possible values are listed in 'Currency Code Table' 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

 

contact_persons

Description:

FieldTypeDescription
contact_personcontact_person

 

contact_person

Description:

FieldTypeDescription
first_namestringThe contact person's first name.
last_namestringThe contact person's last name.

 

libraries

Description: List of libraries related to the vendor or the account.
If not specified, the default will be the institution including all sub units.

FieldTypeDescription
librarylibraryA specific library that the vendor works with.

 

library

Description:
A specific library that the vendor works with.
Note that the include_sub_units attribute is mandatory.

FieldTypeDescription
codestring with attr. Code of the specific library.

 

payment_methods

Description: List of supported payment methods.

FieldTypeDescription
payment_methodstring with attr. The account's payment method.
Possible values are listed in 'PaymentMethod' code table.
The valid values for this parameter are controlled by the code-table: PaymentMethod. These are the currently defined values for your institution:
CodeDescription

 

accounts

Description: List of vendor related accounts.
For a material_supplier vendor, at least one active account must be defined.

FieldTypeDescription
accountaccountA specific vendor account.

 

account

Description: A specific vendor account.

FieldTypeDescription
account_idstringThe account id. If included in the PUT payload, the existing account will be updated. If not - a swap-all will be performed.
codestringA code for the account. Mandatory.
descriptionstringA description for the account. Mandatory.
financial_sys_codestringA code for the financial system account.
statusstring with attr. The status of the account.
Possible codes are listed in VendorSearchStatusFilter code table.
The valid values for this parameter are controlled by the code-table: VendorSearchStatusFilter. These are the currently defined values for your institution:
CodeDescription
account_librarieslibrariesList of libraries that the vendor works with.
If not specified, the default will be the institution including all sub units.
discount_percentstringA discount percentage for the account.
notestringA note for the account.
payment_methodspayment_methodsList of supported payment methods.
expected_receipt_intervalstringWhen creating a PO line for a physical resource, this value appears by default in the same field on the PO Line Summary page.
It is added to the current date to determine the expected receipt date.
claiming_intervalstringWhen creating a PO line, this value appears by default in the same field on the PO Line Summary page.
It is added to the expected receipt date to determine when a PO line is sent to the Claims task list.
expected_invoice_intervalstringCurrently not in use.
expected_activation_intervalstringhen creating a PO line for an e-resource, this value appears by default in the same field on the PO Line Summary page.
It is added to the current date to determine the expected activation date of the resource.
renewal_evaluation_intervalstringThe number of days after the evaluation period that renewal can be performed.
subscription_intervalstringWhen creating a PO line, this value appears by default in the Claiming grace period field on the PO Line Summary page.
It is added to the expected activation date to determine when a PO line for an e-resource is sent to the Claims task list.
reclaim_intervalstring
When creating a PO line, this value appears by default in the Reclaim interval field on the PO Line Summary page.
The number of days to wait before sending a 2nd, 3rd, 4th etc claim letter to the vendor. Optional. Default: 0.
contact_infocontact_infoList of the account's contacts information. Note that an account cannot have web_addresses.

 

interfaces

Description: List of the vendor's related interfaces.
Relevant only for an Access Provider vendor.

FieldTypeDescription
interfaceinterfaceA specific vendor interface.

 

interface

Description: A specific vendor interface.

FieldTypeDescription
interface_idstringThe interface id. If included in the PUT payload, the existing interfaces will be updated. If not - a swap-all will be performed.
namestringThe interface name. Mandatory.
descriptionstringThe interface description.
statusstring with attr. The status of the interface.
Possible codes are listed in VendorSearchStatusFilter code table.
The valid values for this parameter are controlled by the code-table: VendorSearchStatusFilter. These are the currently defined values for your institution:
CodeDescription
main_notestringThe interface's related note.
contact_infocontact_infoList of the interface's contacts information. Note that an intefrace cannot have web_addresses.
admin_infoadmin_infoAdministrative details about the interface.
statisticsstatistics
access_infoaccess_info
interface_notesnotesThe interface's related notes.
In the PUT action the incoming list will replace the existing list. If the incoming list is empty, the existing list will be deleted.

 

admin_info

Description: Administrative details about the interface.

FieldTypeDescription
user_idstringThe user id for security purposes.
user_passwordstringThe user password for security purposes.
user_password_notestringThe user password's related note.
online_admin_modulebooleanIndication whether the resource attributes can be directly modified online by the subscribing institution.
admin_uristringThe URI of the online administration module.
admin_uri_typestring with attr. The type of online administration module URI.
Possible values are listed in 'AdminURIType' code table.
The valid values for this parameter are controlled by the code-table: AdminURIType. These are the currently defined values for your institution:
CodeDescription
open_url_compliantbooleanIndication whether the electronic content and its content is compliant with an open URI.
linking_notestringInformation about external linking, such as implementation details, or other notes.
hardware_req_internalstringInformation about hardware requirements and restrictions - not visible to end users.
hardware_req_publicstringInformation about hardware requirements and restrictions - visible to end users.
software_req_internalstringInformation about software requirements - not visible to end users.
software_req_publicstringInformation about software requirements - visible to end users.
maintenance_win_valuestringThe provider's regularly scheduled downtime window for this product.
The recurring period of time reserved by the product provider for technical maintenance activities, during which online access may be unavailable.
incident_logstringA log of downtime and problem reports, as well as their resolution.
admin_documentationstringInformation about and/or location of documentation available for product administrators.

 

statistics

Description: Statistical details about the interface.

FieldTypeDescription
user_idstringThe user id for security purposes.
user_passwordstringThe user password for security purposes.
user_pass_notestringThe user password's related note.
availablebooleanIndication whether the usage statistics are available for the resource.
delivery_methodstring with attr. The manner in which statistics are made available.
Possible values are listed in 'UsageStatsDeliveryMethod' code table.
The valid values for this parameter are controlled by the code-table: UsageStatsDeliveryMethod. These are the currently defined values for your institution:
CodeDescription
formatstring with attr. The formats in which statistics are made available. Multiple formats can be entered.
Possible values are listed in 'UsageStatsFormat' code table.
The valid values for this parameter are controlled by the code-table: UsageStatsFormat. These are the currently defined values for your institution:
CodeDescription
frequencystring with attr. The frequency with which statistics are made available.
Possible values are listed in 'UsageStatsFrequency' code table.
The valid values for this parameter are controlled by the code-table: UsageStatsFrequency. These are the currently defined values for your institution:
CodeDescription
online_locationstringThe online location where statistics can be accessed, such as a URL or file path.
delivery_addressstringThe contact name within the library.
locally_storedstringInformation about and/or links to locally stored data.
statistics_notestringInformation about usage-related statistics.

 

access_info

Description:

FieldTypeDescription
user_idstringThe user id for security purposes.
user_passwordstringThe user password for security purposes.
user_pass_notestringThe user password's related note.
ip_address_reg_methodstring with attr. The method by which IP addresses are sent to the product provider.
Possible values are listed in 'IpAddressRegMethod' code table.
The valid values for this parameter are controlled by the code-table: IpAddressRegMethod. These are the currently defined values for your institution:
CodeDescription
ip_address_reg_instructionsstringThe URI at which IP addresses are registered, the email address or contact role to which updates are sent, or other relevant instructions.
ip_address_notestringAdditional notes pertaining to IP address information.
access_notestring
primary_access_uristringThe method of access, the location, and the file name of an e-product.
interface_uristring
implemented_auth_methodstring with attr. The Method of authorization.
Possible values are listed in 'ImplementedAuthMethod' code table.
The valid values for this parameter are controlled by the code-table: ImplementedAuthMethod. These are the currently defined values for your institution:
CodeDescription
local_persistent_uristring

 

Samples

XML
JSON
__