API Docs

Invoice Payment

Overview

Data Dictionary

Click here to download invoice_payment.xsd

invoice_list

Description: Invoice list to Export. Includes at least one Invoice.

FieldTypeDescription
invoiceinvoice

 

invoice

Description: Specific invoice to export

FieldTypeDescription
invoice_numberstringThe invoice number, as appears on the invoice. This may be used to identify the invoice (with vendor_code) during import, if a unique_identifier is not supplied.
vendor_codestringThe code of the vendor from which the invoice was issued. This may be used to identify the invoice (with invoice_number) during import, if a unique_identifier is not supplied.
vendor_additional_codestringThe additional code of the vendor from which the invoice was issued.
invoice_ref_numstringThe invoice reference number, as appears on the invoice
invoice_ownerstringThe invoice owner, as appears on the invoice
invoice_ownered_entityowneredEntity
vendor_namestringThe name of the vendor from which the invoice was issued.
vendor_FinancialSys_CodestringThe Financial Sys Code of the vendor from which the invoice was issued.
vendor_liable_for_vatbooleanIndication whether the vendor is liable for vat
approved_bystringThe name of the user first and last that approved this invoice.
vendor_payment_address_listvendor_payment_address_list
vendor_account_codestringThe specific vendor account related to the invoice
vendor_national_tax_idstringThe specific vendor account related to the invoice
vendor_account_FinancialSys_CodestringThe Financial Sys Code of the vendor Account from which the invoice was issued.
invoice_datestringThe invoice date, same format as appears on the invoice
invoice_amountamount
unique_identifierstringUnique identifier of the invoice. This value can be used when importing invoices in order to identify the invoice. If not specified during import, the invoice number and vendor code combination will be used to identify the invoice.
payment_methodstringPayment method of the invoice. Possible values are listed in 'Payment Method' code table.
additional_chargesadditional_charges
vat_infovat_info
prepaid_indbooleanIndication whether the invoice is prepaid
invoice_line_listinvoice_line_list
invoice_exchange_rate_listinvoice_exchange_rate_list
noteListnoteList

 

owneredEntity

Description:

FieldTypeDescription
creationDateformattedDateType
modificationDateformattedDateType
createdBystring
modifiedBystring
customerIdstring
institutionIdstring
libraryIdstring
libraryUnitIdstring

 

noteList

Description:

FieldTypeDescription
notenote

 

note

Description:

FieldTypeDescription
owneredEntityowneredEntity
contentstring

 

vendor_payment_address_list

Description: List of vendor payment address

FieldTypeDescription
payment_addresspayment_address

 

invoice_line_list

Description: List of lines whithin an invoice

FieldTypeDescription
invoice_lineinvoice_line

 

invoice_exchange_rate_list

Description: List of lines whithin an invoice

FieldTypeDescription
exchange_rateexchange_rate

 

exchange_rate

Description: Specific exchange rate

FieldTypeDescription
currencystringThe currency. Possible values are listed in 'Currency Code Table' code table.
ratedecimalRate for forgein currency exchange.
explicit_indbooleanIndication whether the exchange rate is explicit (by user definition) or implicit (By Alma definitions)

 

invoice_line

Description: Specific invoice line

FieldTypeDescription
line_numberstringThe invoice line number (need to contain numbers only )
line_typestringThe type of the invoice line. Possible values are listed in 'Invoice Line Types' code table.
po_line_infopo_line_info
vendor_taxstring
pricedecimalThe price for the invoice line
total_pricedecimalThe total price for the invoice line (including additional charges, vat etc.)
quantityintThe quantity for the invoice line
reporting_codestringThe report code related to the invoice line
notestringFree text note
fund_info_listfund_info_list
vat_amountdecimalAmount of VAT to be paid on the invoice line, will be set only if vat_in_invoice_line_level is set.
vat_percentagedecimalVAT Percentage of the invoice line total amount.
vat_codestringInvoice line VAT code
vat_descriptionstringInvoice line VAT Description

 

amount

Description:

FieldTypeDescription
sumdecimalThe total sum
currencystringThe currency. Possible values are listed in 'Currency Code Table' code table.
explicit_ratedecimalRate for forgein currency exchange.

 

additional_charges

Description: Additional charges that are included in the invoice.

FieldTypeDescription
total_charges_amountdecimalThe total sum of additional charges.
overhead_amountdecimalThe amount of overhead charge.
discount_amountdecimalThe amount of discount charge.
shipment_amountdecimalThe amount of shipment charge.
insurance_amountdecimalThe amount of insurance charge.
supply_of_approvals_book_collections_amountdecimalThe amount of Supply of approvals/book collections charge.
barcode_labelling_amountdecimalThe amount of Barcode labelling charge.
classification_amountdecimalThe amount of Classification charge.
general_servicing_by_library_bookseller_amountdecimalThe amount of General servicing by library bookseller charge.
binding_amountdecimalThe amount of Binding charge.
sleeving_amountdecimalThe amount of Sleeving charge.
data_communication_amountdecimalThe amount of Data communication charge.
miscellaneous_servicing_amountdecimalThe amount of Miscellaneous servicing charge.
audio_CD-ROM_packaging_amountdecimalThe amount of Audio/CD-ROM packaging charge.
security_fitting_amountdecimalThe amount of Security fitting charge.
cataloguing_services_amountdecimalThe amount of Cataloguing services charge.
commission_amountdecimalThe amount of Commission charge.
delivery_amountdecimalThe amount of Delivery charge.
exchange_rate_guarantee_charge_amountdecimalThe amount of Exchange rate guarantee charge charge.
handling_charge_amountdecimalThe amount of Handling charge charge.
small_order_surcharge_amountdecimalThe amount of Small order surcharge charge.
insurance_charge_amountdecimalThe amount of Insurance charge.
posting_charge_amountdecimalThe amount of Posting charge.
packing_charge_amountdecimalThe amount of Packing charge.
postage_and_packing_charge_amountdecimalThe amount of Postage and packing charge.
special_handling_amountdecimalThe amount of Special handling charge.
miscellaneous_credit_adjustment_amountdecimalThe amount of Miscellaneous credit adjustment charge.
miscellaneous_charge_amountdecimalThe amount of miscellaneous charge charge.

 

vat_info

Description: VAT charge that is included in the invoice.

FieldTypeDescription
vat_percentagedecimalVAT Percentage of the invoice total amount, either inclusive or exclusive.
vat_amountdecimalAmount of VAT to be paid on the invoice, either inclusive or exclusive.
vat_codestringInvoice VAT code
vat_descriptionstringInvoice VAT Description
inclusive_indbooleanIndication whether the invoice total amount includes VAT, this field is deprecated, use vat_type instead, for backwards compatibility it will return true if VAT type is INCLUSIVE.
vat_typevat_type
expended_from_fund_indbooleanIndication whether the VAT amount is expended from the invoice line's fund. If set to false, the VAT amount is expended from a separate fund (adjustment invoice line).
vendor_taxstringText that indicates that the invoice is in a foreign currency and the VAT is charged in the local currency.
vat_in_invoice_line_levelbooleanIndication whether the invoice vat is in invoice line level

 

po_line_info

Description: Information about the invoice line related PO line

FieldTypeDescription
po_line_numberstringThe number of the PO line.
po_line_pricedecimalThe price of the PO line.
po_line_titlestringThe title of the PO line.
mms_record_idstringThe MMS Id of the PO line.
meta_data_valuesmeta_data_values
intersted_user_listintersted_user_list
additional_order_referencestringThe additional order reference of the PO line.
fully_Invoiced_indbooleanIndication whether the PO line has been fully invoiced. Relevant only for onetime PO lines.
po_line_ownerstringThe library which owned the PO line.
vendor_notestringThe PO line vendor note.
vendor_reference_numberstringThe PO line vendor reference number.

 

meta_data_values

Description: Information about the PO line meta data values

FieldTypeDescription
acqterms_identifierTypestringThe identifier Type ISBN or ISSN.
acqterms_placestringThe Place of the item creation
datestringThe date of the item
acqterms_identifierstringThe identifier value
publisherstringThe publisher of the item
creatorstringThe creator of the item

 

intersted_user_list

Description: List of intersted user whithin a po line

FieldTypeDescription
intersted_userintersted_user

 

intersted_user

Description: Information about the intersted user

FieldTypeDescription
first_namestringThe first name as shown on alma
last_namestringThe last name as shown on alma
user_namestringThe user name
emailstringThe user perfered email
idstringThe user alma identifier id

 

fund_info_list

Description: List of funds related to an invoice line.

FieldTypeDescription
fund_infofund_info

 

fund_info

Description: Information about invoice line related fund

FieldTypeDescription
ledger_namestringFund name
ledger_codestringFund code
fiscal_periodstringThe financial year to which the fund applies.
namestringFund name
codestringFund code
typestringFund type LEDGER, SUMMARY, ALLOCATED
fund_typestringFund type code table
fund_type_descstringFund type code table Description
amountamountThe amount which is to be paid by the fund
external_idstringThe ID that is used to link to other system keys

 

payment_address

Description:

FieldTypeDescription
line1string
line2string
line3string
line4string
line5string
citystring
stateProvincestring
postalCodestring
countrystringValues taken from CountryCodes Alma Code Table
notestring
typestypes

 

types

Description: List of address payment types

FieldTypeDescription
typestring

 

formattedDateType
formattedDateTypeis a xs:string with xs:restriction - see XSD for details.

Samples

XML
JSON
__