diff --git a/docs/configure/portal/companies.md b/docs/configure/portal/companies.md index f766dabd2..ca712f651 100644 --- a/docs/configure/portal/companies.md +++ b/docs/configure/portal/companies.md @@ -61,17 +61,17 @@ In the companies view, you can see the following information for every company: - Company name - Company ID -- Name of the Portal user that created the company - Date and time of the company creation - Date and time of the last read of data - Data connections and their [statuses](/configure/portal/companies#data-connection-statuses) +- Associated products #### Data connection statuses - _Green_ indicates the connection is linked, and data can be refreshed from the connection - _Red_ indicates the connection has an error, or has become de-authorized (your customer will need to re-authorize the connection) - _Purple_ indicates the connection has been created but has not yet been authorized -- _Grey_ indicates the connection has been un-linked (your customer will need to re-authorize the connection) +- _Grey_ indicates the connection has been unlinked (your customer will need to reauthorize the connection) Clicking on a data connection allows you to manage the connection and see any linking errors. diff --git a/docs/spend-insights/guides/analyze-spend.md b/docs/spend-insights/guides/analyze-spend.md index bcc4c83c7..a0b18823c 100644 --- a/docs/spend-insights/guides/analyze-spend.md +++ b/docs/spend-insights/guides/analyze-spend.md @@ -1,6 +1,6 @@ --- title: "Review spend analysis and insights" -sidebar_label: Get spend insights +sidebar_label: Review insights description: "Learn how to review the spend and supplier information from your customer and associated insights" --- @@ -15,33 +15,58 @@ In this guide, we will cover how you can view the insights generated from your c ## Check data status -Once you onboard the customer, check that their insights reports are ready. In the Codat Portal, navigate to the **Spend Insights** tab and locate the customer's company. +Once you onboard the customer, their initial Spend Insights report generates immediately. In the Codat Portal, navigate to the **Spend Insights** tab, locate the customer's company, and check that the report is ready. You may see one of the following statuses next to the company name: -| **Status** | **Action** | +| **Report status** | **Action** | | ----------------------- | -------------------------------------------------------------------------------------------- | | **Available** | Codat successfully generated the spend report for this customer, and it's ready to download. | | **Generating** | Codat is currently generating the spend report for this customer. Check back later. | -| **Unavailable** | Report wasn't generated due to an error. Contact support to resolve the issue. | -| **Request information** | Codat hasn't yet received data from this customer. Onboard the customer first. | +| **Unavailable** | Codat hasn't yet received data from this customer. Onboard the customer first. | +| **Failed** | Codat couldn't generate the report. Contact support to resolve the error. | ![An image of the Portal user interface on the Spend Insights tab with four companies listed and their statuses highlighted.](/img/spend-insights/si-spend-report-statuses.png) -## Download reports +## Update report -To download the available reports, click the **Download** button next to the company name. In the dropdown, choose the type of report you wish to download and click the corresponding line. This downloads of the Excel reports to your default download folder. +If your customer shared their data with you via [Data streaming](/spend-insights/resources/link-software), you can refresh the data in the Spend Insights report as often as you need. This ensures you are always working with the most up-to-date financial information of your customers. -Codat offers the following report options: +On-demand report update isn't possible if your customer used [Intelligent Upload](/spend-insights/resources/link-file) to share their financial data. -- **Spend summary** provides a one-page summary view of top supplier opportunities for the customer. -- **Spend analysis** covers the summary and details of the customer's spend and suppliers in an Excel format. +To generate an updated report, follow these steps: + +1. Navigate to the **Spend Insights** tab in the [Codat Portal](https://app.codat.io). + +2. Search or scroll to locate the company you require reports for. + +3. Click the **Download** icon on the company line to view the dropdown menu. + +4. Click **Update reports** in the dropdown menu. + +5. Track the progress by checking the _Report Status_ column. + +Once updated, the status will change from _Generating_ to _Available_, and you can go ahead and download the resulting report. + +![An image of the Portal user interface on the Spend Insights tab with the Update Reports button visible and highlighted.](/img/spend-insights/si-update-reports.png) + +## Download report + +When you are ready to download a company's Spend Insights report, you can do so from the Spend Insights tab. + +1. Search or scroll to locate the company you require reports for. + +2. Click the **Download** icon again, then click the _Spend Analysis_ line item. + +This initiates the download and saves the Excel report to your default download folder. ![An image of the Portal user interface with the download dropdown displayed and download button highlighted for an example company](/img/spend-insights/si-reports-download.png) -## Spend analysis report +## Spend Analysis report + +Codat's **Spend Analysis** covers the summary and details of the customer's spend and suppliers in an Excel format. -This Excel report offers a detailed look into your customer's spend data, providing an overview of their spending and suppliers by payment method and detailed supplier analysis. It also contains the source bills, bill payments, and direct costs that inform the report. +It offers a detailed look into your customer's spend data, providing an overview of their spending and suppliers by payment method and detailed supplier analysis. It also contains the source bills, bill payments, and direct costs that inform the report. ### Customer tab diff --git a/docs/spend-insights/guides/get-report.md b/docs/spend-insights/guides/get-report.md new file mode 100644 index 000000000..f0b90b698 --- /dev/null +++ b/docs/spend-insights/guides/get-report.md @@ -0,0 +1,5 @@ +--- +title: "Download company's spend report" +sidebar_label: Get report +description: "Learn how to generate and download up-to-date spend reports for your customer" +--- \ No newline at end of file diff --git a/docs/spend-insights/guides/onboard-customer.md b/docs/spend-insights/guides/onboard-customer.md index 2ab9ed22a..a9c3a4069 100644 --- a/docs/spend-insights/guides/onboard-customer.md +++ b/docs/spend-insights/guides/onboard-customer.md @@ -10,7 +10,7 @@ In this guide, we will cover the ways you can create new customers, manage exist ## Create customer -You can create your client in Codat from the _Spend Insights_ tab or the _Companies_ tab. In our example, we start on _Spend Insights_ tab. +Navigate to the _Companies_ tab in the Codat Portal to start the creation of a new company that represents your customer. 1. Click the **Create company** button. This will open a _Create a company_ window. @@ -83,12 +83,20 @@ You can support your customer on this journey using the following guides: ## Manage customers -You can view all existing customers in the _Spend Insights_ tab or the _Companies_ tab. +You can view all existing customers in the _Spend Insights_ tab or the _Companies_ tab. If your customer's company has multiple subsidiaries, you can expand the parent company to view its children by clicking on the dropdown icon. -To edit or delete your existing customers, navigate to the _Companies_ tab. Use the **Pencil** icon next to the company name to edit its details or the **Trash** icon to delete it. +![An image of the Companies tab with a parent company called Abra Kedabra and its subsidiaries highlighted.](/img/spend-insights/companies-multi-entity.png) + +To edit or delete your existing customers, navigate to the _Companies_ tab. Click on the triple-dot menu to view the editing options dropdown. From there, you can click **Edit** to change company details or **Delete** to delete it. + +:::caution Deleting a company If you delete a company, this will also delete the data you previously received from it. As a result, you will no longer be able to access this company's reports in the Portal. This operation is not reversible. +If the company you are deleting is a parent company, you will see a pop-up window requesting manual confirmation to delete the company and its subsidiaries. + +::: + ![An image of the Companies tab with four companies listed as examples. A pencil icon and a trash icon are visible and highlighted next to a company entry called Hairosmith.](/img/spend-insights/si-manage-company.png) :::tip Review spend insights diff --git a/docs/using-the-api/managing-companies.md b/docs/using-the-api/managing-companies.md index 2c17f30a4..caf7b212b 100644 --- a/docs/using-the-api/managing-companies.md +++ b/docs/using-the-api/managing-companies.md @@ -26,6 +26,9 @@ You can either onboard users: To create a new company, use the [Create company](/platform-api#/operations/create-company) endpoint and provide a name for the company in the request body. The `name` parameter is mandatory to execute this request. You can also provide a `description` to store additional information about the company. +If you need to represent a complex multi-entity company structure, use the `referenceParentCompany` and `referenceSubsidiaryCompanies[]` parameters to build out the required hierarchy. + + diff --git a/static/img/spend-insights/companies-multi-entity.png b/static/img/spend-insights/companies-multi-entity.png new file mode 100644 index 000000000..33fa25f46 --- /dev/null +++ b/static/img/spend-insights/companies-multi-entity.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1e220b6f824cc6148bc4676d3736028a255617269fe0d27b2a1bf915fffe5ad9 +size 72887 diff --git a/static/img/spend-insights/si-create-company-button.png b/static/img/spend-insights/si-create-company-button.png index 903a7fceb..6a1a0c714 100644 --- a/static/img/spend-insights/si-create-company-button.png +++ b/static/img/spend-insights/si-create-company-button.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:71753d7123f83060e8fe917d2df89e338babe458d3a7f67fe81d67a7bd858379 -size 58163 +oid sha256:a0656efd2f32f6b39c405998796079472c54fa0f29debdfb3c1e039a6bf864e0 +size 63612 diff --git a/static/img/spend-insights/si-manage-company-request-info.png b/static/img/spend-insights/si-manage-company-request-info.png index 57c4f5379..5aae047f1 100644 --- a/static/img/spend-insights/si-manage-company-request-info.png +++ b/static/img/spend-insights/si-manage-company-request-info.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:52cd5a1b6bfc50ef0f895932d2ad624ba88ff3df9a839808251466ceccd54221 -size 57499 +oid sha256:99e7b45fea136020e439a37d7ffcc8e89bb44f88f95a0f8b2521ed9e070a9f9c +size 43020 diff --git a/static/img/spend-insights/si-manage-company.png b/static/img/spend-insights/si-manage-company.png index 808d94fdd..749deaff9 100644 --- a/static/img/spend-insights/si-manage-company.png +++ b/static/img/spend-insights/si-manage-company.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c0590e7239fed20248e510512f141dc8baf6337b03536ae0476f3aa9bfbe0416 -size 57853 +oid sha256:ae54a8a42ecc42af88ee8386a9b9452e72eb23f5f7fc5ab4a2e3a2eda58ef3d9 +size 47518 diff --git a/static/img/spend-insights/si-reports-download.png b/static/img/spend-insights/si-reports-download.png index de57178aa..a77f9a3b1 100644 --- a/static/img/spend-insights/si-reports-download.png +++ b/static/img/spend-insights/si-reports-download.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:9e8eb4d5ce06c24c10bf88a5f78fdff6f38ddf2c8e3569404a6e7f8fbfec26bb -size 35553 +oid sha256:479e48c36fab367aeed3369626dbd03de37d4734027ad475a63c39969f8b7bf7 +size 62695 diff --git a/static/img/spend-insights/si-spend-report-statuses.png b/static/img/spend-insights/si-spend-report-statuses.png index 7b29cf6fc..d82546513 100644 --- a/static/img/spend-insights/si-spend-report-statuses.png +++ b/static/img/spend-insights/si-spend-report-statuses.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:125681b78bf7617264e779035c2a5d7b271f53b07325b8d42ebe714768edd732 -size 63703 +oid sha256:851fb7767a831e0f6939d0d70df84efd1aec86e7912620f7fc0542b3589ef1e8 +size 84771 diff --git a/static/img/spend-insights/si-update-reports.png b/static/img/spend-insights/si-update-reports.png new file mode 100644 index 000000000..c523a93bb --- /dev/null +++ b/static/img/spend-insights/si-update-reports.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:73eb80edd996c88ee5026277debffee6e71e38adbbffade039e8fb0cb8b74cd7 +size 77201