Collated Documents
Executive Summary
Collated Documents builds, for each billing period, a single combined PDF for every client invoice or claim and then sends it to the people who need it. Billing staff start a new period for a branch, billing cycle and billing period, choose whether the period is made up of Invoices or Claims, and then work through the period in a fixed order: import the invoices or claims from AlayaCare, add the extra attachments that each client's tag calls for (visit notes, a letter of authorization, a mileage spreadsheet), merge everything into one PDF per client, and queue the result for delivery by email, fax or printed mail. Each period keeps a count of how many documents sit at each step, a full history of every action taken, and the list of distribution jobs, so staff can see what is waiting, what has failed and what has been sent.
Key Features
- Start a new period for a branch, billing cycle, year and billing period, as either an Invoices or a Claims period
- Import invoices or claims for the period from AlayaCare, together with each client's group, tag and state, and keep the invoice or claim PDF
- Flag documents that cannot continue (no group, no tag, more than one group or tag, missing state, missing PDF) and re-check them after the data is corrected in AlayaCare
- Add the attachments required by the client's tag: a notes PDF listing the completed interventions for each visit, the client's letter of authorization (LOA) for the period, and the client's mileage spreadsheet for the period
- Merge the invoice or claim and its attachments into one collated PDF per document, either for all documents at once or for a single document
- Queue distributions by email (secure, insecure or standard), fax and mail, based on the funder's distribution settings and the distribution fields on the client's contacts in AlayaCare, then send the queued emails and faxes
- Build one combined print document of all mail distributions for printing and posting
- Download all collated PDFs for a period as a single zip file
- Review every distribution job and every individual distribution, with their status and last message
- Review the history of every action run on the period, with who ran it, when, and how long it took
- Filter and sort the documents in a period, and export the list to Excel
- Open the client in AlayaCare from a document
- Configure the email and fax accounts used for distribution, the secure email subject, the email body, the LOA and mileage folder names, and the contact fields that switch on fax, mail and email distribution in the page settings
Typical Workflow
- Select the Branch and click Start A New Period. Choose the Billing Cycle, Year, Billing Cycle Period and Primary File Type (Invoices or Claims), then click Ok. The new period opens automatically.
- On the All Documents tab, click Check For New Invoices (or Check For New Claims) to import the documents for the period from AlayaCare.
- Review any documents in Import Errors, correct the client in AlayaCare (group, tag or state), and click Refresh Document Errors.
- Click Process Tags to add the notes, LOA and mileage attachments and to check that fax numbers and email addresses exist. Correct anything that ends in Tag Processing Errors and click Refresh Document Errors.
- Click Collate Files to merge each document and its attachments into a single PDF.
- Click Distribute Collated Files and confirm. This queues the email, fax and mail distributions.
- Open the Distributions tab and click Send Email and Send Fax to send what is queued. For mail, use the Download Print Document icon on the distribution job to get the combined print file.
- Use Download Collated Files at any time to save all collated PDFs as a zip file, and use the History tab to review what was done.
Configurable Settings
Open View Settings or Edit Settings from this screen (when permitted) to change these options. The setting names themselves are held in a configuration table and are not shown here; the descriptions below follow the control shown for each setting.
| Group | Setting | Type | Purpose |
|---|
| General | Email account used for distribution | Dropdown (email accounts) | The email account that distribution emails are sent from. Send Email stops with "Mail From Account Setup incomplete" if it is not set. |
| General | Fax account used for distribution | Dropdown (fax accounts) | The fax account that distribution faxes are sent from. Send Fax stops with "Fax Account Setup incomplete" if it is not set. |
| General | Secure email subject text | Text | Text added to the front of the subject of emails sent as secure. If left blank, [SECURE] is used. |
| General | Email body | Multi-line text | Body of distribution emails. It can contain the place-holder {AttachmentInfo}, which is replaced by a description of what the attached PDF contains. If the text contains HTML tags it is sent as an HTML email. If left blank, a short standard sentence is used. |
| General | LOA folder name | Text | Name of the client attachment folder in AlayaCare that holds letters of authorization. Required before documents can be imported. |
| General | Mileage spreadsheet folder name | Text | Name of the client attachment folder in AlayaCare that holds mileage spreadsheets. Required before documents can be imported. |
| General | Contact field for fax distribution | Text | Name of the custom field on a client contact in AlayaCare that marks the contact to receive collated documents by fax. The contact is included when the field holds yes, true, 1 or y. |
| General | Contact field for mail distribution | Text | Name of the custom field on a client contact in AlayaCare that marks the contact to receive collated documents by mail. The contact is included when the field holds yes, true, 1 or y. |
| General | Contact field for email distribution | Text | Name of the custom field on a client contact in AlayaCare that marks the contact to receive collated documents by email. What the field holds decides how the email is sent (see Distribute Collated Files below). |
Settings that also affect this screen but are maintained elsewhere: the agency name, address, phone and logo that appear on the notes PDF; the options on each tag (whether to include notes, LOA and mileage); the funder's fax, mail and email distribution settings and its fax number, address and email addresses; and the fax, mail and email fields on each client contact in AlayaCare. The three contact fields named above are only the field names; the values are kept on the contacts themselves.
Available Permissions
The following permissions are available to be assigned to AlayaCare Roles:
| Attribute | What It Controls |
|---|
| View | Open the page |
| Settings View | Open View Settings to see the page configuration |
| Settings Edit | Open Edit Settings and change the page configuration |
| All Branches | Choose any branch (or all branches) in the Branch filter and when starting a new period. Without it, the branch is fixed to the user's own branch. |
Main Grid
The grid lists the collated document periods that have been started for the selected branch, newest first (14 rows per page). The first six columns stay in view when scrolling sideways. The counts show how many documents in the period are currently at each step.
| Column | Description |
|---|
| ID | Period number. |
| Branch | Branch the period belongs to. |
| Cycle | Billing cycle. |
| Year | Billing year. |
| Period | Billing period number within the cycle. |
| From | First date of the billing period. |
| To | Last date of the billing period. |
| Primary File Type | Invoices or Claims. |
| Import Errors | Documents that could not be imported cleanly. |
| Waiting For Tag Processing | Documents ready for Process Tags. |
| Tag Processing Errors | Documents where a required attachment, fax number or email address was not found. |
| Waiting For Collation | Documents ready for Collate Files. |
| Collation Errors | Documents that could not be merged into a PDF. |
| Waiting For Distribution | Documents with a collated PDF that are ready for Distribute Collated Files. |
| Distributed | Documents that have been queued for distribution. |
| Added | Date and time the period was started, in the user's time zone. |
| Added By | User who started the period. |
| Manage Records | Edit icon that opens the period. |
Main Grid Filters
| Filter | Purpose |
|---|
| Branch | Limits the grid to one branch. Users with the All Branches permission can pick any branch or all branches; other users see their own branch only. Changing the branch refreshes the grid. |
Actions
| Button | Description |
|---|
| Start A New Period | Opens the Start A New Period dialog. |
| View Settings | Opens the page settings in read-only mode (when settings view is permitted). |
| Edit Settings | Opens the page settings for editing (when settings edit is permitted). |
| Reset For Testing All | Shown only on staging and UAT sites. After confirmation, deletes all periods and all their documents. |
| Reset But Leave Jobs | Shown only on staging and UAT sites. After confirmation, deletes the documents but leaves the periods in place. |
| Edit (right-click a row, or the edit icon under Manage Records) | Opens the period. |
Dialog Components
Start A New Period
Opens from Start A New Period. It defines the period to work on.
| Field | Purpose |
|---|
| Branch | Branch for the period. Defaults to the branch currently selected on the page. |
| Select A Billing Cycle | Billing cycle for the period. |
| Year | Year of the billing period. Changing the cycle or year reloads the list of periods. |
| Select A Billing Cycle Period | Period within the cycle and year, shown as year, period number and date range. |
| Primary File Type | Invoices or Claims. |
Click Ok to create the period. A warning is shown if the branch, billing cycle, period or primary file type is missing. When the period is created it opens straight away for processing, and the page switches to the period's branch if it differs from the current filter.
Collated Period
Opens from the Edit icon or right-click Edit on a period, and automatically after a new period is created. The title reads Collated Invoices (or Collated Claims) followed by the cycle, year, period number and the From and To dates.
Across the top are read-only counts for the period: Import Errors, Waiting For Tag Processing, Tag Processing Errors, Waiting For Collation, Collation Errors, Waiting For Distribution and Distributed. They refresh after every action.
Tabs
| Tab | Purpose |
|---|
| All Documents | Every invoice or claim in the period with its status, plus the buttons for each processing step. |
| Distributions | The distribution jobs created for the period, with the buttons to send queued emails and faxes. |
| History | A log of every action run on the period. |
All Documents — Grid
| Column | Description |
|---|
| ID | Document number. |
| Client Name | Client's name. |
| Client Tag | The AlayaCare client tag that matched a Collated Documents tag. It decides which attachments (notes, LOA, mileage spreadsheet) are added. |
| Client Group | The AlayaCare client group that matched a Collated Documents group. |
| Client State | State from the client's address. |
| Status | Where the document is in the process (see the status list below). |
| Reason | Explanation when the document is in an error status. |
| Billing Contact | Billing contact on the invoice (invoices only). |
| Funder | Funder on the invoice or claim. |
| Invoice Number | AlayaCare invoice number (invoices). |
| Claim Number | AlayaCare claim number (claims). |
| Posting Date | Invoice or claim date. |
| Primary File Type | Invoices or Claims. |
| Actions | Edit icon (opens the document) and Download icon (downloads the collated PDF). |
Status values, in the order a document moves through them:
| Status | Meaning |
|---|
| Pending | Imported with a valid group and tag. This is brief; the document moves to Waiting For Tag Processing at the end of the import. |
| Import Errors | The document could not be imported cleanly. Possible reasons: No RCM Group found for client, Multiple RCM Groups found for client, No RCM Tag found for client, Multiple Tags found for client, State Missing, File Import Failed. |
| Waiting For Tag Processing | Ready for Process Tags. |
| Tag Processing Errors | A required item was not found. Possible reasons: LOA Document not found for period, Mileage Spreadsheet not found for period, Fax number not found, Email address not found. |
| Waiting For Collation | Attachments are in place. Ready for Collate Files. |
| Collation Errors | No usable PDF could be built for the document. |
| Waiting For Distribution | The collated PDF is ready. Ready for Distribute Collated Files. |
| Distributed | At least one email, fax or mail distribution has been queued for the document. |
All Documents — Grid Filters
| Filter | Purpose |
|---|
| Filter Client Name Includes | Shows documents whose client first or last name contains every word entered (words can be separated by spaces, commas or semicolons; not case-sensitive). |
| Filter ID Includes | Shows documents whose ID contains the digits entered. |
| Filter Status | Multi-select list of statuses to show. |
| Filter Tag Types | Multi-select: No Attachments, Notes, LOA, Mileage Spreadsheet. Shows documents whose tag includes any of the selected attachments (or no attachments). |
| Sort By | Collated ID (default), Client Name, or State, Group, Client Name. Re-sorts the list straight away. |
Click Apply Filter to apply the filters and Clear Filter to reset them.
All Documents — Grid Actions
| Button | Description |
|---|
| Check For New Invoices / Check For New Claims | Imports new documents for the period from AlayaCare. The label follows the period's primary file type. Always available. |
| Process Tags | Adds the attachments required by each client's tag. Available only when at least one document is Waiting For Tag Processing. |
| Refresh Document Errors | Re-checks every document in Import Errors or Tag Processing Errors against the current AlayaCare data. Available only when at least one such document exists. |
| Collate Files | Merges each document's files into one PDF. Available only when at least one document is Waiting For Collation. |
| Distribute Collated Files | Queues email, fax and mail distributions after confirmation. Available only when at least one document is Waiting For Distribution. |
| Download Collated Files | Downloads all collated PDFs for the period as one zip file. Available only when at least one document has a collated PDF. |
| Export | Exports the documents currently shown (after filters and sort) to Excel. |
| Edit (right-click a row, or the edit icon) | Opens the document details. |
| Download (right-click a row, or the download icon) | Downloads that document's collated PDF. A warning is shown if none has been created yet. |
| Refresh Document Errors (right-click a row) | Re-checks just that document. Shown only for documents in Import Errors or Tag Processing Errors. |
| Collate Files (right-click a row) | Collates just that document. Shown only for documents in Waiting For Collation. |
| Open Client In AlayaCare (right-click a row) | Opens the client's scheduling page in AlayaCare in a new browser tab. |
Distributions — Grid
Each row is one distribution job, created the first time documents are queued for distribution.
| Column | Description |
|---|
| ID | Distribution job number. |
| Status | Waiting To Send until every distribution in the job is sent or a mail print file has been created, then Sent. |
| Waiting To Send | Number of distributions still waiting to be sent. |
| Error | Number of distributions that failed or were not sent. |
| Sent | Number of distributions sent. |
| Added | Date and time the job was created. |
| Added By | User who created the job. |
| Actions | Edit icon (opens the distribution job) and Print icon (downloads the print document). |
Distributions — Grid Actions
| Button | Description |
|---|
| Send Email | Sends all queued email distributions after confirmation. Available only when a distribution job is waiting to send. |
| Send Fax | Sends all queued fax distributions after confirmation. Available only when a distribution job is waiting to send. |
| Edit (right-click a row, or the edit icon) | Opens the distribution job. |
| Download Print Document (right-click a row, or the print icon) | Downloads the combined PDF of all mail documents in the job, ready to print and post. A warning is shown if the job has no print document. |
History — Grid
| Column | Description |
|---|
| Action | What was run, for example import, tag processing, refreshing document errors, collating, distributing, sending email, sending fax or downloading collated files. |
| Details | Extra detail for the action. |
| Message | Message recorded for the action. |
| Client ID | AlayaCare client ID, when the action relates to one client. |
| Client Last Name | Client last name, when applicable. |
| Client First Name | Client first name, when applicable. |
| Added | Date and time the action was logged. |
| Added By | User who ran the action. |
| Processing Start | When the action started. |
| Processing End | When the action finished. |
| Duration | How long the action took. |
Collated Document
Opens from Edit on a document in the All Documents tab. The title reads Collated Document followed by the client's name. The top of the dialog shows these read-only details: ID, Status, Primary File Type, Posting Date, EBP Claim Type, Client, Client Tag, Client Group, Billing Contact, Billing Contact Is Client, Funder, Funder ID, Invoice Number, Claim Number, Added and Added By. Use Close to return to the period.
Tabs
| Tab | Purpose |
|---|
| Document Files | The files that make up the document: the primary invoice or claim and each attachment. |
| Distributions | Every distribution queued for this document and its result. |
Document Files — Grid
| Column | Description |
|---|
| File Type | Invoice, Claim or Attachment. |
| Attachment Type | Primary, Notes, LOA or Mileage. |
| File Name | Name of the PDF. |
| Status | Imported or Error where a status was recorded. |
| Status Message | Detail when a file could not be downloaded or converted. |
| Added | Date and time the file was added. |
| Added By | User who added it. |
| Actions | Download icon. |
Document Files — Grid Actions
| Button | Description |
|---|
| Download (right-click a row, or the download icon) | Downloads the file's PDF. A warning is shown if the PDF is not available. |
Distributions — Grid
| Column | Description |
|---|
| Job ID | Distribution job the entry belongs to. |
| Method | Email, Email Secure, Email Insecure, Fax or Mail. |
| Email | Email address used. |
| Fax | Fax number used. |
| Mail Address | Street address used for mail. |
| City | City used for mail. |
| State | State used for mail. |
| Zip | Zip code used for mail. |
| Status | Waiting To Send, Sent, Not Sent or Mail Created. |
| Last Distribution | Date and time of the last send attempt. |
| Message | Result of the last attempt, for example the reason it was not sent. |
| Added | Date and time the entry was queued. |
Distribution Job
Opens from Edit on a distribution job. The title reads Distribution Job followed by the job ID. It lists every individual distribution in the job. Above the grid, a summary shows the number Waiting To Send, in Error and Sent. Use Close to return to the period.
Grid
| Column | Description |
|---|
| Document ID | Document the distribution is for. |
| Client | Client's name. |
| Method | Email, Email Secure, Email Insecure, Fax or Mail. |
| Email | Email address. |
| Fax | Fax number. |
| Mail Address | Street address (mail). |
| City | City (mail). |
| State | State (mail). |
| Zip | Zip code (mail). |
| Status | Waiting To Send, Sent, Not Sent or Mail Created. |
| Last Distribution | Date and time of the last send attempt. |
| Message | Result of the last attempt. |
| Added | Date and time the distribution was queued. |
Grid Filters
| Filter | Purpose |
|---|
| Filter Status | Shows only distributions with the chosen status: Waiting To Send, Error (which includes Not Sent), Sent or Mail Created. Use the clear icon to show all. |
Dependencies
The following tables must be configured for lookups on this view to work:
| Table | Description |
|---|
| BillingCycles | Billing cycles offered when starting a period. Also covers its billing cycle periods: periods (year, number, dates) offered for the chosen cycle and year. |
| Branches | Branches offered in the filter and when starting a period. |
| EmailAccounts | Email accounts offered in the page settings and used to send distribution emails. |
| FaxAccounts | Fax accounts offered in the page settings and used to send distribution faxes. |
| Funders | Funder claim type, email addresses, fax number, mailing address and fax, mail and email distribution settings. Used for Claims periods, and for invoices that have no billing contact. |
| Groups | Groups with the integration type Collated Documents. Each client must belong to exactly one. |
| Tags | Tags of the type Collated Documents. Each client must have exactly one. The tag decides the attachments (notes, LOA, mileage spreadsheet). |
Processing Overviews
This section describes what happens after you confirm a processing action. Each action adds an entry to the History tab and refreshes the counts when it finishes. Each one shows a progress panel with a Cancel option, and stops at the next document if cancelled.
Ok (Start A New Period)
- Requires a branch, billing cycle, period and primary file type.
- Creates the period with the chosen cycle, year, period dates and file type, recorded as added by the current user.
- Refreshes the grid, switching the branch filter to the new period's branch if needed.
- Opens the new period.
Check For New Invoices / Check For New Claims
- Requires the LOA folder name and mileage spreadsheet folder name to be set in the settings, and a successful AlayaCare sign-in.
- Loads the tags and groups of type Collated Documents.
- Downloads the invoices (or claims) for the period from AlayaCare. Only those that have a PDF are used.
- Skips any invoice or claim already imported for this period.
- For each new one, loads the client from AlayaCare and checks the client has exactly one Collated Documents group, exactly one matching Collated Documents tag, and a state. The first two checks set the status to Import Errors with the reasons No RCM Group found for client, Multiple RCM Groups found for client, No RCM Tag found for client or Multiple Tags found for client; a blank state sets Import Errors with State Missing. When more than one check fails, the last one is the reason shown.
- Saves the document with client, tag, group, state, funder, billing contact (invoices), posting date and the funder's EBP claim type.
- Downloads the invoice or claim PDF and saves it as the primary file. If the download fails, the document is set to Import Errors with File Import Failed.
- When all are imported, every document still Pending moves to Waiting For Tag Processing.
- Takes every document that is Waiting For Tag Processing.
- Looks up the document's client tag. If the tag has Include Notes on, builds a notes PDF listing, for each visit on the invoice, the scheduled start and end, the client, the employee and the completed interventions, and saves it as a Notes attachment. Notes never cause an error.
- If the tag has Include LOA on, looks in the client's LOA folder in AlayaCare for a file named like LOA-2026_08_31-2026_09_06 whose date range contains the period's end date, and saves it as the LOA attachment. If none is found, the document gets LOA Document not found for period.
- If the tag has Include Mileage Spreadsheet on, does the same in the mileage folder for a file named like Mileage-2026_08_31-2026_09_06. PDF files are kept as they are and Word files are converted to PDF. If none is found, or the file is not a PDF or Word file, the document gets Mileage Spreadsheet not found for period.
- Works out where the document will be sent (see How the distribution destinations are chosen below). If fax distribution is switched on but no fax number can be found, the document gets Fax number not found.
- If email distribution is switched on but no email address can be found, the document gets Email address not found. A missing mailing address is not treated as an error at this step.
- Documents with a problem move to Tag Processing Errors; the others move to Waiting For Collation.
Refresh Document Errors
- Takes every document in Import Errors or Tag Processing Errors (or only the one selected, when started from the right-click menu).
- Reloads the invoice or claim and the client from AlayaCare and repeats the group, tag and state checks, updating the status and reason. Documents that now pass move to Waiting For Tag Processing.
- Documents that had been in Tag Processing Errors and no longer have import errors then have their tags processed again, as described under Process Tags.
- A warning is shown if the invoice or claim cannot be found in AlayaCare for the period.
Collate Files
- Takes every document that is Waiting For Collation (or only the one selected from the right-click menu).
- Collects the document's files that have a PDF, placing the invoice or claim first and the attachments after it.
- If there is only one file it is used as it is; otherwise the files are merged. A file that cannot be merged is skipped with a warning.
- Saves the result as the document's collated PDF, named with the client's last name and the invoice or claim number.
- Documents that were collated move to Waiting For Distribution; documents with no usable PDF move to Collation Errors.
Download Collated Files
- Takes every document that has a collated PDF.
- Adds each PDF to a zip file, giving duplicate file names a numeric suffix.
- Downloads the file, named like CollatedDocuments_{cycle}{year}{period}.zip, and shows how many PDFs were included.
How the distribution destinations are chosen
The destinations for each document depend on its type:
- Claims: the funder only.
- Invoices with no billing contact: the funder and all of the client's active contacts.
- Invoices with a billing contact: the client's active contacts only (contacts that are enabled in AlayaCare).
For the funder, fax, mail and email are each used only when the funder is set up to distribute collated documents that way. Fax uses the funder's fax number, mail uses the funder's address, and email uses the funder's email addresses in order (email, email 2, email 3).
For each client contact, fax, mail and email are each used only when the matching contact field (named in the page settings) is switched on for that contact. Fax uses the contact's fax number, mail uses the contact's street address (with suite), city, state and zip, and email uses the contact's email address followed by their preferred email address.
For email, the value held in the field (or the funder's email setting) also chooses how the email is sent. If it contains Insecure the email is sent as Email Insecure; if it contains Secure it is sent as Email Secure; otherwise it is sent as plain Email. If it contains Single (and not Multiple) only the first address found is used; otherwise every address found is used. Duplicate fax numbers, email addresses and mailing addresses are used once only.
Distribute Collated Files
- Asks for confirmation, then takes every document that is Waiting For Distribution.
- For each document, works out the destinations as described above. A fax is queued for each fax number found, and an email for each address found, marked secure, insecure or standard. A distribution already queued for the same destination is not queued again.
- Creates a distribution job the first time something is queued.
- Moves a document to Distributed when at least one fax or email was queued for it.
- Documents that have at least one mailing address are combined, in client name order, into a single print PDF stored on the distribution job. A Mail entry with status Mail Created is added for each address, or with the message Mail address not found when the address is blank. These documents move to Distributed. A document with no collated PDF is skipped with a warning.
- A document that has no fax, email or mail destination at all stays in Waiting For Distribution. A message reports how many distributions and whether a mail PDF were queued, or that no destinations were queued.
Send Email
- Asks for confirmation. Requires the email account for distribution to be set in the settings; an Office 365 account must also have a valid sign-in.
- Takes every email distribution that is Waiting To Send in jobs that are Waiting To Send.
- Sends each email with the document's collated PDF attached. The subject reads Invoices For {client name} For The Week Ending {date} (or Claims, and Month for monthly billing cycles); secure emails start with the secure subject text. The body is the email body from the settings, or a standard sentence.
- Marks each distribution Sent, or Not Sent with the reason (for example Email address not found or Collated PDF not found).
- Marks a job Sent once every distribution in it is Sent or Mail Created.
- Reports how many were sent, skipped and failed.
Send Fax
- Asks for confirmation. Requires the fax account for distribution to be set in the settings.
- Takes every fax distribution that is Waiting To Send.
- Sends the collated PDF to the fax number. Marks each distribution Sent (with the fax reference when one is returned) or Not Sent with the reason.
- Marks a job Sent once every distribution in it is complete, and reports how many were sent, skipped and failed.
Export
- Requires at least one document in the list after filters.
- Builds an Excel sheet named Documents with: ID, Client Name, Client Tag, Client Group, Client State, Status, Reason, Billing Contact, Funder, Invoice Number, Claim Number, Posting Date, Primary File Type, Invoice/Claim Filename, LOA Filename, Mileage Spreadsheet Filename and Notes Filename.
- Downloads the file, named like CollatedInvoices_{year}{period}{date and time}.xlsx, and shows "Exported Successfully".