Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/configure/portal/companies.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('been unlinked').

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.


Clicking on a data connection allows you to manage the connection and see any linking errors.

Expand Down
49 changes: 37 additions & 12 deletions docs/spend-insights/guides/analyze-spend.md
Original file line number Diff line number Diff line change
@@ -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"
---

Expand All @@ -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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.


![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

Expand Down
5 changes: 5 additions & 0 deletions docs/spend-insights/guides/get-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm guessing this will be updated later? Was curious if we had docs for each of the reports we support

Image

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"
---
14 changes: 11 additions & 3 deletions docs/spend-insights/guides/onboard-customer.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.


:::

![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
Expand Down
3 changes: 3 additions & 0 deletions docs/using-the-api/managing-companies.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.


<Tabs groupId="language">

<TabItem value="nodejs" label="TypeScript">
Expand Down
3 changes: 3 additions & 0 deletions static/img/spend-insights/companies-multi-entity.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions static/img/spend-insights/si-create-company-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions static/img/spend-insights/si-manage-company-request-info.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions static/img/spend-insights/si-manage-company.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions static/img/spend-insights/si-reports-download.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions static/img/spend-insights/si-spend-report-statuses.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions static/img/spend-insights/si-update-reports.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading