Source:

Module: mod-invoice-storage

Interface: /invoice-storage/invoice-lines

Attributes:

Property Name Property Type Property Description
id string The UUID format string
accountingCode string Pulled based on account number.
accountNumber string Account number that the vendor assigned
adjustments array Defined in settings - the amount field will be editable and pro-rate toggle will be editable if enabled for that adjustment
adjustmentsTotal number Sum of all invoice line adjustments. This amount is always calculated by system.
comment string Free form commentary
description string Title as captured in the Purchase Order Line. In the absence of a POL link this could be used to describe the POL
fundDistributions array List of fund distributions
invoiceId string The UUID format string
invoiceLineNumber string Sequentially generated and not editable by the user.
invoiceLineStatus string Invoice line status
poLineId string The UUID format string
productId string product identifier
productIdType string The UUID corresponding to the type of product id
quantity integer quantity
releaseEncumbrance boolean This is intended to not only release encumbrances but to indicate that this is the final invoice line for corresponding order line. This should take into account the fiscal year. We may release encumbrance for this FY but for on-going orders expect to encumber again next year.
subscriptionInfo string The user should use this field to provide info on the subscription (eg. which volumes are being invoiced). It is MANDATORY if the chk_subscription_overlap is FALSE AND there is no start date provided
subscriptionStart string Subscription start date
subscriptionEnd string Subscription end date
subTotal number Invoice line amount before adjustments are applied
total number Invoice line total amount which is sum of subTotal and adjustmentsTotal. This amount is always calculated by system.
referenceNumbers array Reference number items array
metadata object Metadata about creation and changes to records, provided by the server (client should not provide)
metadata/createdDate string Date and time when the record was created
metadata/createdByUserId string ID of the user who created the record (when available)
metadata/createdByUsername string Username of the user who created the record (when available)
metadata/updatedDate string Date and time when the record was last updated
metadata/updatedByUserId string ID of the user who last updated the record (when available)
metadata/updatedByUsername string Username of the user who last updated the record (when available)
tags object List of simple tags that can be added to an object
tags/tagList array List of tags