Source:

Module: mod-invoice-storage

Interface: /invoice-storage/invoices

Attributes:

Property Name Property Type Property Description
id string The UUID format string
accountingCode string Number that represents the vendor is an external accounting system which may include details like “Address code” in it. This is the number as stated on the invoice
adjustments array List of invoice level adjustments. The adjustments can be pro-rated which are defined at the invoice level, but are applied to the invoice lines. A generic example is a shipping fee which should be spread out across all of the invoice lines so that all funds involved pay some portion of the fee.
adjustmentsTotal number Total amount which is sum of all invoice line adjustments and all non-prorated invoice level adjustments. This amount is always calculated by system.
approvedBy string The UUID format string
approvalDate string Date the invoice was approved for processing
batchGroupId string UUID of the batch group to use when generating batch vouchers
billTo string The UUID format string
chkSubscriptionOverlap boolean IF TRUE the system will check if there is another invoice for this subscription and whether the dates overlap. IF the dates overlap, the system should issue an alert.
cancellationNote string The reason of the invoice cancellation.
currency string Ideally this is the ISO code and not something the user defines
enclosureNeeded boolean Indicates that an enclosure is needed
exchangeRate number Exchange rate
operationMode string Operation mode performed on the exchange rate
exportToAccounting boolean This would keep the invoice from being feed into the batch process (i.e. not generate an external voucher/payment) but would still move values in the system. This might be defined by the vendor relationship and exposed for override on the invoice.
folioInvoiceNo string Invoice number in folio system
invoiceDate string Invoice date
lockTotal number Total amount which manually set by user. The calculated total must match this before the invoice can be approved
note string Invoice note
paymentDue string When this is required to be paid. Generally governed by the relationship with the Vendor
paymentDate string When the invoice was actually paid
paymentTerms string Invoice payment terms
paymentMethod string Inherited from vendor record
status string Open: Record has been created, Reviewed: details have been verified, Approved: Funds are release, Paid: confirmation that funds have been exchanged and check number has been returned amounts are frozen, cancelled.
    Note: invoices are never partially paid.
source string This does not denote a user ID but describes how the record was created. Eg. User, API, EDI
subTotal number Invoice amount before adjustments are applied. This is sum of all subTotal amounts of the corresponding invoice lines. This amount is always calculated by system.
total number The total amount is calculated “on the fly” of this invoice which is sum of subTotal and adjustmentsTotal. Must be the same with existed “lockTotal”, when approve invoice.
vendorInvoiceNo string This is the number from the vendor’s invoice, which is different from the folioInvoiceNo
disbursementNumber string The identifier for the physical transaction corresponding to a payment (Eg. Check #, EFT # etc.) Brought in from external source
voucherNumber string Number generated by folio that will eventually identify the payment request sent out to external financial system.
paymentId string The UUID format string
disbursementDate string Date payment was made from financial system (eg. corresponding check date)
poNumbers array May or may not be provided; references the PO associated to the invoice
vendorId string The UUID format string
fiscalYearId string The UUID format string
accountNo string The unique number of the organization account
manualPayment boolean This would keep the invoice from being feed into the batch process (Not generate a external voucher/payment) but would still move values in the system. Note: this is ideally defined by the vendor relationship and exposed for override on the invoice.
acqUnitIds array acquisition unit ids associated with this invoice
nextInvoiceLineNumber integer Number that will be used next time an invoice line is created
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