ACI Documentation

Import Invoices V3

Executive Summary

Import Invoices V3 brings sale invoices that were issued in AlayaCare into the integration so they can be billed and tracked. Billing staff choose a billing cycle, year and period and start an import. For every funder on that cycle whose period is still open, the system reads the funder's invoices for the period from AlayaCare, checks each invoice, and creates the invoice, its line items (as open client account transactions) and, when needed, the client account and billing contact records. Each import is saved as a job in the list, with counts of invoices included, warnings and errors. Opening a job shows the invoices, accounts and messages produced by that import and lets you export everything to Excel.

Key Features

  • Start a new import for a billing cycle, year and billing cycle period
  • Import invoices from AlayaCare for every funder on the cycle whose funder period is open (closed funder periods are skipped with a warning)
  • Validate each invoice before importing: every line must have a department, and the line items must add up to the invoice amount
  • Support invoices that are part of a master invoice (split billing)
  • Automatically create or refresh client accounts and billing contact details from AlayaCare
  • Invoice lines dated before the start of the period are flagged with a warning and dated to the invoice posting date
  • Keep a history of every import with its timing, duration and counts of included invoices, warnings and errors
  • Review the invoices, accounts and messages created by an import, with a check that invoice totals match transaction totals
  • Export an import to Excel (Summary, Invoices, Accounts and Messages sheets)

Typical Workflow

  1. Click Start A New Import.
  2. Select a billing cycle, confirm the Year, and select a billing cycle period. Click Ok.
  3. Watch the progress panel while invoices are checked and imported. A message at the end reports success, errors found, or that no invoices were imported.
  4. Find the new job at the top of the list. Check the Included, Warnings and Errors counts.
  5. Open the job (the edit button in Manage Records, or right-click the row and choose Edit) to review the Invoices, Accounts and Messages tabs.
  6. Correct any problems in AlayaCare (for example a missing department on a service code) and run the import again for the same period. Invoices already imported are not imported twice.
  7. Click Export on the job to save the results to Excel.

Available Permissions

The following permissions are available to be assigned to AlayaCare Roles:

AttributeWhat It Controls
ViewOpen the page and its import details

Main Grid

Lists every previous invoice import, newest first (14 rows per page).

ColumnDescription
IDImport job number.
AddedDate and time the import was started, shown in the tenant time zone.
Added ByUser who started the import.
CycleBilling cycle imported.
YearBilling year.
PeriodBilling period number.
FromFirst date of the period.
ToLast date of the period.
Processing StartDate and time processing began.
Processing EndDate and time processing finished. Blank while the import is still running or if it did not finish.
DurationHow long the import took.
IncludedNumber of invoices imported.
WarningsNumber of warning messages recorded for the import.
ErrorsNumber of error messages recorded for the import.
Manage RecordsEdit button that opens the import details.

Actions

ButtonDescription
Start A New ImportOpens the Start A New Import dialog.
Edit (button in Manage Records, or right-click a row)Opens the details of the selected import.

Dialog Components

Start A New Import

Opens from Start A New Import. Choose what to import and click Ok.

FieldPurpose
Select A Billing CycleBilling cycle to import. Only funders assigned to this cycle are imported.
YearBilling year. Defaults to the current year. In January and February the two previous years are also offered.
Select A Billing Cycle PeriodPeriod within the chosen cycle and year, shown as year, period number and date range. The list fills once a cycle and year are chosen.

A warning is shown if no billing cycle or no period has been selected. The dialog closes when you click Ok and the import runs in a progress panel.

Import Invoices Details

Opens from the edit button or right-click Edit on a job. A back arrow beside the title returns to the list. The top of the page shows read-only totals for the import:

FieldPurpose
PeriodYear, period number and date range of the import.
Total AmountSum of the invoice amounts imported.
Client Account Transactions AmountSum of the transaction (line item) amounts created. Shown in red when it does not equal Total Amount.

Click Export to save the import to Excel. The file contains four sheets:

SheetContents
SummaryImport details (cycle, year, period, dates, processing times, duration, included count, added date and user) and the total invoice and transaction amounts.
InvoicesOne row per invoice with client, billing contact, funder, invoice id and number, amount, posting date, the transaction amount, the difference between the two (blank when they match) and any message recorded for the invoice.
AccountsClient accounts used by the import.
MessagesAll messages for the import. For error messages, the AlayaCare client ID and client name are looked up in AlayaCare and added.

Tabs

TabPurpose
InvoicesInvoices imported by this job.
AccountsClient accounts created by this job.
MessagesInformation, warning and error messages written during the import.
Invoices — Grid
ColumnDescription
Client UIDAlayaCare client ID.
Client NameClient name.
Billing Contact IdAlayaCare profile ID of the billing contact (0 when there is none).
Billing ContactBilling contact name.
Funder IdAlayaCare funder ID.
AC Invoice IdAlayaCare invoice ID.
AC Invoice#AlayaCare invoice number.
AmountInvoice amount.
Posting DateInvoice posting date.
Accounts — Grid
ColumnDescription
Client UIDAlayaCare client ID.
Client NameClient name.
Funder CodeFunder code.
Funder NameFunder name.
Billing Contact IDAlayaCare profile ID of the billing contact.
Billing NameBilling contact last name, first name. Blank when there is no billing contact.
Bill Contact Is ClientChecked when the billing contact is the client.
Messages — Grid
ColumnDescription
Invoice IDAlayaCare invoice ID the message relates to (the master invoice ID for line-item count messages on master invoices).
Invoice NumberAlayaCare invoice number.
Client UIDAlayaCare client ID.
Client First NameClient first name.
Client Last NameClient last name.
Funder IdAlayaCare funder ID.
TypeInfo, Warning or Error.
MessageDescription of what was found.

Common messages:

MessageMeaning
n Invoice Line Items / Invoice Billed Line Items / Invoice Split Billed Line ItemsInformation: how many lines were found on the invoice.
Invoice Amount of x does not match line item amount of yError: the invoice total in AlayaCare differs from the sum of its lines including tax. The invoice is not imported.
Service Code 'name' does not have a department / Invoice item does not have a service code / Unable to find Department for Invoice ItemError: a line has no department, so the invoice is not imported.
Client Premium 'id' is missing a Department / Local Client Premium 'id' not found / Client Premium 'id' not found in AlayaCareError: a premium line cannot be given a department.
Error retrieving Invoice Line ItemsError: no lines could be read for the invoice.
Document Date date prior to period start dateWarning: a line is dated before the period, so it is imported as a prior-period item dated on the invoice posting date.
Parsing item start time …Error: a line's start time could not be read.
Messages — Grid Filters
FilterPurpose
Filter TypeShow All, Info, Error or Warning messages.

Click Apply to refresh the list. Use Clear to reset the filter to All.

Messages — Grid Actions

The Apply and Clear buttons above apply the filter. The Export button at the top of the page exports all messages, not only the filtered ones.

Dependencies

The following tables must be configured for lookups on this view to work:

TableDescription
Billing CyclesBilling cycles offered in the Start A New Import dialog. Also covers its billing cycle periods: periods offered for the selected billing cycle and year.
FundersFunders assigned to the selected billing cycle. Also covers its funder periods: A funder period must exist for the cycle, year and period and must be open for that funder to be imported.
PremiumsUsed to find the department for client premium invoice lines.

Processing Overviews

This section describes what happens after you confirm a processing action.

Start A New Import

  1. A new import job is saved with the cycle, year, period dates, your user name and the start time.
  2. Funders assigned to the selected cycle are listed. For each funder, its period is checked: if the funder period is closed, a warning is shown and the funder is skipped; if no funder period exists for the selected period, the funder is skipped without a message.
  3. The funder's transactions for the period dates are read from AlayaCare, and only sale invoices for that funder are kept.
  4. For each invoice, the invoice details and line items are read from AlayaCare. For invoices that belong to a master invoice, the billed and split-billed lines of the master invoice are read as well. Information messages record the number of lines found.
  5. Each line is checked for a department (from its service code, or from its premium) and the line amounts including tax are added up. If a department is missing or the total does not match the invoice amount, an error message is saved and the invoice is not imported.
  6. For valid invoices, the client account for the client, funder and billing contact is looked up. If it does not exist it is created from the AlayaCare client details (using the year of the client's first service). If it exists, its name, address, phone, email, reference number, branch and billing-contact-is-client details are refreshed from AlayaCare, and the changes are written to the action log. The billing contact's details are saved or updated from AlayaCare at the same time.
  7. If the invoice is not already saved, the invoice is created and counted as Included. Line items are created as open invoice transactions when the invoice is new or has no transactions yet. For split-billed invoices, the line amount is taken from the master invoice items.
  8. Lines dated before the start of the period receive a warning and are dated to the invoice posting date, flagged as prior period.
  9. If a transaction cannot be saved, an error is shown and the import stops at that point.
  10. When all funders are done, a message reports whether invoices were imported, whether errors were found, or that no invoices were imported. The job is updated with its end time, duration and number of invoices included.