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.

Field	Type	Description
invoice	invoice

 

invoice

Description: Specific invoice to export

Field	Type	Description
invoice_number	string	The 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_code	string	The 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_code	string	The additional code of the vendor from which the invoice was issued.
invoice_ref_num	string	The invoice reference number, as appears on the invoice
invoice_owner	string	The invoice owner, as appears on the invoice
invoice_ownered_entity	owneredEntity
vendor_name	string	The name of the vendor from which the invoice was issued.
vendor_FinancialSys_Code	string	The Financial Sys Code of the vendor from which the invoice was issued.
vendor_liable_for_vat	boolean	Indication whether the vendor is liable for vat
approved_by	string	The name of the user first and last that approved this invoice.
vendor_payment_address_list	vendor_payment_address_list
vendor_account_code	string	The specific vendor account related to the invoice
vendor_national_tax_id	string	The specific vendor account related to the invoice
vendor_account_FinancialSys_Code	string	The Financial Sys Code of the vendor Account from which the invoice was issued.
invoice_date	string	The invoice date, same format as appears on the invoice
invoice_due_date	string	The invoice due date, same format as appears on the invoice
invoice_amount	amount
unique_identifier	string	Unique 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_method	string	Payment method of the invoice. Possible values are listed in 'Payment Method' code table.
additional_charges	additional_charges
vat_info	vat_info
prepaid_ind	boolean	Indication whether the invoice is prepaid
number_of_attachments	int	The number of invoice attachments. The actual attachments can be retrieved using API.
invoice_line_list	invoice_line_list
invoice_exchange_rate_list	invoice_exchange_rate_list
noteList	noteList

 

owneredEntity

Description:

Field	Type	Description
creationDate	formattedDateType
modificationDate	formattedDateType
createdBy	string
modifiedBy	string
customerId	string
institutionId	string
libraryId	string
libraryUnitId	string

 

noteList

Description:

Field	Type	Description
note	note

 

note

Description:

Field	Type	Description
owneredEntity	owneredEntity
content	string

 

vendor_payment_address_list

Description: List of vendor payment address

Field	Type	Description
payment_address	payment_address

 

invoice_line_list

Description: List of lines whithin an invoice

Field	Type	Description
invoice_line	invoice_line

 

invoice_exchange_rate_list

Description: List of lines whithin an invoice

Field	Type	Description
exchange_rate	exchange_rate

 

exchange_rate

Description: Specific exchange rate

Field	Type	Description
currency	string	The currency. Possible values are listed in 'Currency Code Table' code table.
rate	decimal	Rate for forgein currency exchange.
explicit_ind	boolean	Indication whether the exchange rate is explicit (by user definition) or implicit (By Alma definitions)

 

invoice_line

Description: Specific invoice line

Field	Type	Description
line_number	string	The invoice line number (need to contain numbers only )
line_type	string	The type of the invoice line. Possible values are listed in 'Invoice Line Types' code table.
po_line_info	po_line_info
vendor_tax	string
price	decimal	The price for the invoice line
total_price	decimal	The total price for the invoice line (including additional charges, vat etc.)
price_note	string	The price note for the invoice line
quantity	int	The quantity for the invoice line
reporting_code	string	The report code related to the invoice line
secondary_reporting_code	string	The secondary report code related to the invoice line
tertiary_reporting_code	string	The tertiary report code related to the invoice line
note	string	Free text note
fund_info_list	fund_info_list
vat_amount	decimal	Amount of VAT to be paid on the invoice line, will be set only if vat_in_invoice_line_level is set.
vat_percentage	decimal	VAT Percentage of the invoice line total amount.
vat_code	string	Invoice line VAT code
vat_description	string	Invoice line VAT Description
additional_information	string	The additional information of continuous po line invoice line
subscription_dates_range	string	The subscription dates range of continuous po line invoice line

 

amount

Description:

Field	Type	Description
sum	decimal	The total sum
currency	string	The currency. Possible values are listed in 'Currency Code Table' code table.
explicit_rate	decimal	Rate for forgein currency exchange.

 

additional_charges

Description: Additional charges that are included in the invoice.

Field	Type	Description
total_charges_amount	decimal	The total sum of additional charges.
overhead_amount	decimal	The amount of overhead charge.
discount_amount	decimal	The amount of discount charge.
shipment_amount	decimal	The amount of shipment charge.
insurance_amount	decimal	The amount of insurance charge.
supply_of_approvals_book_collections_amount	decimal	The amount of Supply of approvals/book collections charge.
barcode_labelling_amount	decimal	The amount of Barcode labelling charge.
classification_amount	decimal	The amount of Classification charge.
general_servicing_by_library_bookseller_amount	decimal	The amount of General servicing by library bookseller charge.
binding_amount	decimal	The amount of Binding charge.
sleeving_amount	decimal	The amount of Sleeving charge.
data_communication_amount	decimal	The amount of Data communication charge.
miscellaneous_servicing_amount	decimal	The amount of Miscellaneous servicing charge.
audio_CD-ROM_packaging_amount	decimal	The amount of Audio/CD-ROM packaging charge.
security_fitting_amount	decimal	The amount of Security fitting charge.
cataloguing_services_amount	decimal	The amount of Cataloguing services charge.
commission_amount	decimal	The amount of Commission charge.
delivery_amount	decimal	The amount of Delivery charge.
exchange_rate_guarantee_charge_amount	decimal	The amount of Exchange rate guarantee charge charge.
handling_charge_amount	decimal	The amount of Handling charge charge.
small_order_surcharge_amount	decimal	The amount of Small order surcharge charge.
insurance_charge_amount	decimal	The amount of Insurance charge.
posting_charge_amount	decimal	The amount of Posting charge.
packing_charge_amount	decimal	The amount of Packing charge.
postage_and_packing_charge_amount	decimal	The amount of Postage and packing charge.
special_handling_amount	decimal	The amount of Special handling charge.
miscellaneous_credit_adjustment_amount	decimal	The amount of Miscellaneous credit adjustment charge.
miscellaneous_charge_amount	decimal	The amount of miscellaneous charge charge.

 

vat_info

Description: VAT charge that is included in the invoice.

Field	Type	Description
vat_percentage	decimal	VAT Percentage of the invoice total amount, either inclusive or exclusive.
vat_amount	decimal	Amount of VAT to be paid on the invoice, either inclusive or exclusive.
vat_code	string	Invoice VAT code
vat_description	string	Invoice VAT Description
inclusive_ind	boolean	Indication 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_type	vat_type
expended_from_fund_ind	boolean	Indication 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_tax	string	Text that indicates that the invoice is in a foreign currency and the VAT is charged in the local currency.
vat_in_invoice_line_level	boolean	Indication whether the invoice vat is in invoice line level

 

po_line_info

Description: Information about the invoice line related PO line

Field	Type	Description
po_line_number	string	The number of the PO line.
po_line_price	decimal	The price of the PO line.
po_line_title	string	The title of the PO line.
mms_record_id	string	The MMS Id of the PO line.
meta_data_values	meta_data_values
intersted_user_list	intersted_user_list
additional_order_reference	string	The additional order reference of the PO line.
fully_Invoiced_ind	boolean	Indication whether the PO line has been fully invoiced. Relevant only for onetime PO lines.
po_line_owner	string	The library which owned the PO line.
vendor_note	string	The PO line vendor note.
vendor_reference_number	string	The PO line vendor reference number.

 

meta_data_values

Description: Information about the PO line meta data values

Field	Type	Description
acqterms_identifierType	string	The identifier Type ISBN or ISSN.
acqterms_place	string	The Place of the item creation
date	string	The date of the item
acqterms_identifier	string	The identifier value
publisher	string	The publisher of the item
creator	string	The creator of the item

 

intersted_user_list

Description: List of intersted user whithin a po line

Field	Type	Description
intersted_user	intersted_user

 

intersted_user

Description: Information about the intersted user

Field	Type	Description
first_name	string	The first name as shown on alma
last_name	string	The last name as shown on alma
user_name	string	The user name
email	string	The user perfered email
id	string	The user alma identifier id

 

fund_info_list

Description: List of funds related to an invoice line.

Field	Type	Description
fund_info	fund_info

 

fund_info

Description: Information about invoice line related fund

Field	Type	Description
ledger_name	string	Fund name
ledger_code	string	Fund code
fiscal_period	string	The financial year to which the fund applies.
name	string	Fund name
code	string	Fund code
type	string	Fund type LEDGER, SUMMARY, ALLOCATED
fund_type	string	Fund type code table
fund_type_desc	string	Fund type code table Description
amount	amount	The amount which is to be paid by the fund (in the invoice's currency)
local_amount	amount	The amount which is to be paid by the fund (in the fund's currency)
external_id	string	The ID that is used to link to other system keys

 

payment_address

Description:

Field	Type	Description
line1	string
line2	string
line3	string
line4	string
line5	string
city	string
stateProvince	string
postalCode	string
country	string	Values taken from CountryCodes Alma Code Table
note	string
types	types

 

types

Description: List of address payment types

Field	Type	Description
type	string

 

formattedDateType

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

Samples

XML

JSON

__