mockups

https://drive.google.com/drive/folders/1DR0ownDKS14PxhCrHWy14TD8sJA1mnbK

mod-invoice/mod-invoice-storage

Schemas

invoice

• Add the batchGroupId field.
• Add enclosureNeeded field

NOTE:  We'll need a UI story to add this to the various invoice forms/views

batchGroupId

string

voucher

• Add the batchGroupId field.
• Remove the batchNumber field - no longer needed.

Copied over from invoice->batchGroupId

batchGroupId

string

adjustment

• add exportToAccounting

exportToAccounting

boolean

batch_voucher_export

This record describes an batch voucher export job - metadata about the process which generates and uploads the batch voucher

id

string

status

string

message

string

batchGroupId

string

start

datetime

end

datetime

batchVoucherId

string

metadata

metadata

batch_voucher

XML and JSON schemas/bindings are needed for this.

Immutable.

Potentially quite large.

Stored as json, but XML and JSON schemas/bindings are needed for this.

XML schema should favor elements over attributes as seen in the abbreviated example below.

id

string

batchGroup

string

start

datetime

end

datetime

created

datetime

batchedVouchers

collection<batched_voucher>

totalRecords

integer

batched_voucher

voucherNumber

string

vendorInvoiceNo

string

folioInvoiceNo

string

accountingCode

string

voucherDate

datetime

type

string

status

string

amount

number

systemCurrency

string

invoiceCurrency

string

exchangeRate

number

invoiceNote

string

vendorName

string

disbursementNumber

string

disbursementDate

datetime

disbursementAmount

number

enclosureNeeded

boolean

batchedVoucherLines

collection<batched_voucher_line>

batched_voucher_line

externalAccountNumber

string

amount

number

fundCodes

collection<string>

adjustments

collection<adjustment>

export_configuration

Configuration information for a voucher export - there's only one of these for a given batchGroup

id

string

startTime

string

weekdays

collection<string>

enableScheduledExport

boolean

format

string

uploadURI

string

metadata

metadata

credentials

Credentials used to upload batch vouchers.  Part of the voucher export configuration, but separated for security reasons (separate permission to access, allows for show/hide button, etc.)

id

string

exportConfigId

string

username

string

password

string

metadata

metadata

batch_group

Controlled vocabulary.  This is used when querying vouchers to be included in a batch voucher, e.g. GET /batch-voucher-storage/vouchers?query=invoice.batchGroupId==XYZ and voucherDate>=ABC and voucherDate<DEF

Need a system value that's ALWAYS there - so not reference or sample data...

{
  "id": "2a2cb998-1437-41d1-88ad-01930aaeadd5",
  "name": "FOLIO",
  "description": "default batch identifier for voucher export"
}

NOTE: We'll need a mockup and UI story for adding a settings area for this.

id

string

name

string

description

string

metadata

metadata

APIs

batch-voucher-export-configurations

• CRUD export configurations on a per-batchGroup basis
  • batchGroupId
  • startTime
  • enableDailyExport (boolean)
  • format (enum)
  • ftp location (host/port/path)
  • username/password

batch-voucher-exports

• On-demand export of vouchers between start/end date/times
  • Get all vouchers for the specified time period
  • For each
    • Get all voucher lines
    • Pull out relevant info
    • Dereference UUIDs as needed (API lookups likely required)
  • Build batch_voucher with the vouchers that have the specified batchGroupId and voucherDate between the specified start/end date/times.
  • Persist batch_voucher
  • Update voucher_export status as the export progresses (Pending, Generating, Generated, Uploading, Uploaded, Error)
  • Return batch voucher in desired format 
  • Optionally - Upload to FTP server
    • connects to FTP using provided credentials
    • uploads the batch voucher
    • updates batch voucher export (e.g. status = uploaded)
  • Only include vouchers for invoices w/ exportToAccounting=true

_timer

• calls POST /batch-voucher/batch-voucher-exports/scheduled
• runs every 5 (?) minutes

mod-invoice

mod-invoice-storage

Batch Voucher Generation

Batch voucher generation happens in a background task/job and is triggered via the POST /batch-voucher/batch-voucher-exports endpoint.  

• Query vouchers
  • exportToAccount=true
  • invoice.batchGroupId=specified batchGroupId
  • voucherDate >= start
  • voucherDate <= end
• Dereference fields as needed - instead of including UUIDs, retreive those records and use their code/name/etc. in the batchVoucher.  Details TBD

edge-voucher (WIP)

New edge module built upon edge-common

APIs

edge-batch-vouchers

• Honor Accept header
• take start/end date/times as params
• Make this synchronous so the AP system only needs to make a single call.

Stories

mod-invoice-storage

• MODINVOSTO-48 - Getting issue details... STATUS
• MODINVOSTO-50 - Getting issue details... STATUS
• MODINVOSTO-51 - Getting issue details... STATUS
• MODINVOSTO-52 - Getting issue details... STATUS
• MODINVOSTO-53 - Getting issue details... STATUS
• MODINVOSTO-54 - Getting issue details... STATUS

mod-invoice

• MODINVOICE-126 - Getting issue details... STATUS
• MODINVOICE-127 - Getting issue details... STATUS
• MODINVOICE-128 - Getting issue details... STATUS
• MODINVOICE-129 - Getting issue details... STATUS
• MODINVOICE-130 - Getting issue details... STATUS
• MODINVOICE-131 - Getting issue details... STATUS
• MODINVOICE-132 - Getting issue details... STATUS
• MODINVOICE-133 - Getting issue details... STATUS
• MODINVOICE-134 - Getting issue details... STATUS

edge-batch-voucher

• Project setup
• Create batch-voucher-export API

Notes

• Need to add batchGroupId to invoice and voucher
• Ability to export vouchers between start and end date/time
  • Get all vouchers for the specified time period
  • For each
    • Get all voucher lines
    • Pull out relevant info
    • Dereference UUIDs as needed (API lookups likely required)
  • Build report in json (new schema, details tbd)
  • Persist report
  • Return report in desired format 
• API for composite voucher ?  Might not be needed
• Edge API that generates returns voucher report 
  • Honor Accept header
  • take start/end date/times as params
• Need API to store export settings on a per-batchGroup basis
  • batchGroupId
  • startTime
  • enableDailyExport (boolean)
  • format (enum)
  • ftp location (host/port/path)
  • username/password
• Need API to store generated reports
  • can be downloaded again
  • can be re-sent (ftp) if configured
  • have status and metadata, maybe indicator of whether they were manually generated or from daily export
• Need Timer task for each voucher export configuration w/ enableDailyExport = true
  • runs at startTime
  • calls API to generate report
  • connects to FTP using provided credentials
  • uploads the report
  • updates report metadata (e.g. status = uploaded)