API Docs
Rest Invoice Line
Contents
Overview
An invoice line.
Data Dictionary
Click here to download rest_invoice_line.xsd
invoice_line
Description: Invoice line Object.
| Field | Type | Description | ||
|---|---|---|---|---|
id | string | Unique identifier of the invoice line. Output parameter. Should be used in subsequent queries regarding the line. | ||
type | string with attr. | The type of invoice line. Possible codes are listed in 'InvoiceLinesTypes' code table. Default is 'Regular'.
| ||
number | string | The invoice line number. Optional. If not supplied in POST action, Alma will generate it. Cannot be updated by the PUT action. | ||
status | string with attr. | The invoice line status. Output parameter. Possible codes are listed in 'InvoiceLineStatus' code table.
| ||
po_ | string | The number of the PO line which is connected to the invoice line. Optional. | ||
price | decimal | The price of the invoice line. Default is the PO line price. | ||
price_ | string | The price note of the invoice line. | ||
total_ | decimal | The total price of the specific invoice line. Output parameter. | ||
quantity | int | The quantity for the invoice line. Default is the PO line quantity. | ||
vat_ | string | VAT related note. Relevant only if VAT is defined at the invoice level. | ||
check_ | boolean | Indication whether Alma should check if the subscription date overlaps with those of any other lines. Relevant only when a continuous PO line is selected. Default is true. | ||
fully_ | boolean | Indication whether the PO line has been fully invoiced. This creates a disencumbrance transaction for any encumbered amounts. Relevant only when a one-time PO line is selected. Default is false. | ||
subscription_ | date | The date from which the invoice line is covered. Relevant only when a continuous PO line is selected. Mandatory if check_subscription_date_overlap is true. | ||
subscription_ | date | The date to which the invoice line is covered. Relevant only when a continuous PO line is selected. Mandatory if check_subscription_date_overlap is true. | ||
additional_ | string | A note. Relevant only when a continuous PO line is selected. Mandatory if the Subscription from date and Subscription to date fields are empty. | ||
release_ | boolean | Indication whether Alma should create a disencumbrance transaction to release encumbrance amounts that remain after paying an invoice. Relevant only when a continuous PO line is selected. Relevant only when the total invoice line price is lower than the PO line price. Default is false. | ||
reporting_ | string with attr. | The main Reporting Codes. Possible values are listed in 'HFundsTransactionItem.reportingCode' code table.
| ||
secondary_ | string with attr. | Secondary reporting code. Possible values are listed in 'SecondReportingCode' code table.
| ||
tertiary_ | string with attr. | Tertiary reporting code. Possible values are listed in 'ThirdReprotingCode' code table.
| ||
note | string | Free text note. | ||
invoice_ | invoice_line_vat | VAT charge that is included in the invoice line. Relevant only if the invoice is defined as 'vat_per_invoice_line'. | ||
fund_ | fund_distributions | The Fund Distributions list. Mandatory for processing the invoice line. see Get funds API. |
fund_distributions
Description:
The Fund Distributions list. Mandatory for processing the invoice line. Get funds API.
| Field | Type | Description |
|---|---|---|
fund_ | fund_distribution | Specific Fund Distributions. |
fund_distribution
Description: Specific Fund Distribution.
| Field | Type | Description |
|---|---|---|
fund_ | string with attr. | The fund code. |
percent | decimal | Percentage which is to be paid by the fund. In POST and PUT actions, percentage or vat_amount should be supplied, but not both. |
amount | decimal | The amount which is to be paid by the fund. In POST and PUT actions, percentage or vat_amount should be supplied, but not both. |
invoice_line_vat
Description:
VAT charge that is included in the invoice line. Relevant only if the invoice is defined as 'vat_per_invoice_line'.
| Field | Type | Description |
|---|---|---|
vat_ | string with attr. | VAT code to assign to the invoice. If supplied, percentage and vat_amount will be defined accordingly. Possible values are according to the VATCodes_MT mapping table. |
percentage | decimal | VAT Percentage of the invoice line price. In POST and PUT actions, percentage or vat_amount should be supplied, but not both. If vat_code is defined, percentage and vat_amount should be left empty in these actions. |
vat_ | decimal | Amount of VAT to be paid on the invoice line. In POST and PUT actions, percentage or vat_amount should be supplied, but not both. If vat_code is defined, percentage and vat_amount should be left empty in these actions. |
Samples
XML
JSON
__