API Docs
Invoice Payment
Contents
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_ | 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_ | 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_ | string | The additional code of the vendor from which the invoice was issued. |
invoice_ | string | The invoice reference number, as appears on the invoice |
invoice_ | string | The invoice owner, as appears on the invoice |
invoice_ | owneredEntity | |
vendor_ | string | The name of the vendor from which the invoice was issued. |
vendor_ | string | The Financial Sys Code of the vendor from which the invoice was issued. |
vendor_ | boolean | Indication whether the vendor is liable for vat |
approved_ | string | The name of the user first and last that approved this invoice. |
vendor_ | vendor_payment_address_list | |
vendor_ | string | The specific vendor account related to the invoice |
vendor_ | string | The specific vendor account related to the invoice |
vendor_ | string | The Financial Sys Code of the vendor Account from which the invoice was issued. |
invoice_ | string | The invoice date, same format as appears on the invoice |
invoice_ | string | The invoice due date, same format as appears on the invoice |
invoice_ | amount | |
unique_ | 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_ | string | Payment method of the invoice. Possible values are listed in 'Payment Method' code table. |
additional_ | additional_charges | |
vat_ | vat_info | |
prepaid_ | boolean | Indication whether the invoice is prepaid |
number_ | int | The number of invoice attachments. The actual attachments can be retrieved using API. |
invoice_ | invoice_line_list | |
invoice_ | 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_ | payment_address |
invoice_line_list
Description: List of lines whithin an invoice
Field | Type | Description |
---|---|---|
invoice_ | invoice_line |
invoice_exchange_rate_list
Description: List of lines whithin an invoice
Field | Type | Description |
---|---|---|
exchange_ | 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_ | 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_ | string | The invoice line number (need to contain numbers only ) |
line_ | string | The type of the invoice line. Possible values are listed in 'Invoice Line Types' code table. |
po_ | po_line_info | |
vendor_ | string | |
price | decimal | The price for the invoice line |
total_ | decimal | The total price for the invoice line (including additional charges, vat etc.) |
price_ | string | The price note for the invoice line |
quantity | int | The quantity for the invoice line |
reporting_ | string | The report code related to the invoice line |
secondary_ | string | The secondary report code related to the invoice line |
tertiary_ | string | The tertiary report code related to the invoice line |
note | string | Free text note |
fund_ | fund_info_list | |
vat_ | decimal | Amount of VAT to be paid on the invoice line, will be set only if vat_in_invoice_line_level is set. |
vat_ | decimal | VAT Percentage of the invoice line total amount. |
vat_ | string | Invoice line VAT code |
vat_ | string | Invoice line VAT Description |
additional_ | string | The additional information of continuous po line invoice line |
subscription_ | 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_ | decimal | Rate for forgein currency exchange. |
additional_charges
Description: Additional charges that are included in the invoice.
Field | Type | Description |
---|---|---|
total_ | decimal | The total sum of additional charges. |
overhead_ | decimal | The amount of overhead charge. |
discount_ | decimal | The amount of discount charge. |
shipment_ | decimal | The amount of shipment charge. |
insurance_ | decimal | The amount of insurance charge. |
supply_ | decimal | The amount of Supply of approvals/book collections charge. |
barcode_ | decimal | The amount of Barcode labelling charge. |
classification_ | decimal | The amount of Classification charge. |
general_ | decimal | The amount of General servicing by library bookseller charge. |
binding_ | decimal | The amount of Binding charge. |
sleeving_ | decimal | The amount of Sleeving charge. |
data_ | decimal | The amount of Data communication charge. |
miscellaneous_ | decimal | The amount of Miscellaneous servicing charge. |
audio_ | decimal | The amount of Audio/CD-ROM packaging charge. |
security_ | decimal | The amount of Security fitting charge. |
cataloguing_ | decimal | The amount of Cataloguing services charge. |
commission_ | decimal | The amount of Commission charge. |
delivery_ | decimal | The amount of Delivery charge. |
exchange_ | decimal | The amount of Exchange rate guarantee charge charge. |
handling_ | decimal | The amount of Handling charge charge. |
small_ | decimal | The amount of Small order surcharge charge. |
insurance_ | decimal | The amount of Insurance charge. |
posting_ | decimal | The amount of Posting charge. |
packing_ | decimal | The amount of Packing charge. |
postage_ | decimal | The amount of Postage and packing charge. |
special_ | decimal | The amount of Special handling charge. |
miscellaneous_ | decimal | The amount of Miscellaneous credit adjustment charge. |
miscellaneous_ | decimal | The amount of miscellaneous charge charge. |
vat_info
Description: VAT charge that is included in the invoice.
Field | Type | Description |
---|---|---|
vat_ | decimal | VAT Percentage of the invoice total amount, either inclusive or exclusive. |
vat_ | decimal | Amount of VAT to be paid on the invoice, either inclusive or exclusive. |
vat_ | string | Invoice VAT code |
vat_ | string | Invoice VAT Description |
inclusive_ | 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_ | vat_type | |
expended_ | 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_ | string | Text that indicates that the invoice is in a foreign currency and the VAT is charged in the local currency. |
vat_ | 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_ | string | The number of the PO line. |
po_ | decimal | The price of the PO line. |
po_ | string | The title of the PO line. |
mms_ | string | The MMS Id of the PO line. |
meta_ | meta_data_values | |
intersted_ | intersted_user_list | |
additional_ | string | The additional order reference of the PO line. |
fully_ | boolean | Indication whether the PO line has been fully invoiced. Relevant only for onetime PO lines. |
po_ | string | The library which owned the PO line. |
vendor_ | string | The PO line vendor note. |
vendor_ | string | The PO line vendor reference number. |
meta_data_values
Description: Information about the PO line meta data values
Field | Type | Description |
---|---|---|
acqterms_ | string | The identifier Type ISBN or ISSN. |
acqterms_ | string | The Place of the item creation |
date | string | The date of the item |
acqterms_ | 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_ | intersted_user |
intersted_user
Description: Information about the intersted user
Field | Type | Description |
---|---|---|
first_ | string | The first name as shown on alma |
last_ | string | The last name as shown on alma |
user_ | 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_ | fund_info |
fund_info
Description: Information about invoice line related fund
Field | Type | Description |
---|---|---|
ledger_ | string | Fund name |
ledger_ | string | Fund code |
fiscal_ | 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_ | string | Fund type code table |
fund_ | 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 | The amount which is to be paid by the fund (in the fund's currency) |
external_ | 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
__