Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix the step numbers in a doc page #54332

Merged
merged 2 commits into from
Dec 19, 2024
Merged
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
34 changes: 17 additions & 17 deletions docs/articles/expensify-classic/connections/Expensify-API.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,46 +11,46 @@ To begin, review our [Integration Server Manual](https://integrations.expensify.

We've compiled answers to some frequently asked questions to help you get started.

**Should I give your support team my API credentials when I need help?**
## Should I give your support team my API credentials when I need help?

If you’re seeking help with Expensify's API, do not share your partnerUserSecret. If you do, immediately rotate your credentials on [this page](https://www.expensify.com/tools/integrations/).

**Is there a rate limit?**
## Is there a rate limit?

Yes, the rate limit is currently 50 requests per minute. If you exceed this limit, you'll receive an error message.

**What is a Policy ID?**
## What is a Policy ID?

This is also known as a Workspace ID. To find your Policy/Workspace ID,
Hover over Settings and click Workspaces.
Click the name of the Workspace.
Copy the ID number from the URL. For example, if the URL is https://www.expensify.com/policy?param={"policyID":"0810E551A5F2A9C2”}, then your workspace ID is 0810E551A5F2A9C2.

**Can I use the parent type `file` to export workspace/policy data?**
## Can I use the parent type `file` to export workspace/policy data?

No. The parent type `file` can only be used to export expense and report data — not policy information. To export policy data (e.g., categories, tags), you must use the `get` type with `inputSettings.type` set to `policy`.

**Can I use the API to create Domain Groups?**
## Can I use the API to create Domain Groups?

No, you cannot create domain groups. You can only assign users to them.

**I’m exporting expense IDs `${expense.transactionID}` but when I open my CSV in Excel, it’s changing all the IDs and making them look the same. How can I prevent this?**
## I’m exporting expense IDs `${expense.transactionID}` but when I open my CSV in Excel, it’s changing all the IDs and making them look the same. How can I prevent this?

Try prepending a non-numeric character like a quote to force Excel to interpret the value as a string and not a number (i.e., `'${expense.transactionID}`).

**How can we export the person who will approve a report while the reports are still processing?**
## How can we export the person who will approve a report while the reports are still processing?

Use the field ${report.managerEmail}.

**Why won’t my boolean field return any data?**
## Why won’t my boolean field return any data?

Boolean fields won't output values without a string. For example, instead of using `${expense.billable}`, use `${expense.billable?string("Yes", "No")}`. This will display "Yes" if the expense is billable and "No" if it is not.

**Can I export the reports for just one user?**
## Can I export the reports for just one user?

Not in a quick convenient way, as you would need to include the user in your template. The simplest approach is to export data for all users and then apply a filter in your preferred spreadsheet program.

**Can I create expenses on behalf of users?**
## Can I create expenses on behalf of users?

Yes. However, to access the Expense Creator API on behalf of employees, Expensify needs to verify the following setup:

Expand All @@ -59,17 +59,17 @@ Verify you have internal authorization to add data to other accounts within your

If you need this access, contact [email protected] and reference this help page.

## Using Postman
# Using Postman

Many customers use Postman to help them build out their APIs. Below are some guides contributed by our customers. Please note, in all cases, you will need to first generate your authentication credentials, the steps for which can be found [here](https://integrations.expensify.com/Integration-Server/doc/#introduction) and have them ready:

### Download expenses from a report as a CSV file
## Download expenses from a report as a CSV file

**Step 1: Get the ID of a report you want to export in Expensify**

Find the ID by opening the expense report and clicking Details at the top right corner of the page. At the top of the menu, the ID is provided as the “Long ID.”

**Step 3: Export (generate) a "Report" as a CSV file**
Copy link
Contributor

Choose a reason for hiding this comment

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

🤣

**Step 2: Export (generate) a "Report" as a CSV file**
{% include info.html %}
For this you'll use the Documentation under [Report Exporter](https://integrations.expensify.com/Integration-Server/doc/#export).
{% include end-info.html %}
Expand Down Expand Up @@ -142,11 +142,11 @@ The template key will have the value like below:

The template variable determines what information is saved in your CSV file. If you want more columns than merchant, amount, and transaction date, follow the syntax as defined in the export template format documentation.

**Step 4: Save your generated file name**
**Step 3: Save your generated file name**

Expensify currently supports only the "onReceive":{"immediateResponse":["returnRandomFileName"]} option in step 3, so you should receive a random filename back from the API like "exportc111111d-a1a1-a1a1-a1a1-d1111111f.csv". You will need to document this filename if you plan on running the download command after this one.
Expensify currently supports only the "onReceive":{"immediateResponse":["returnRandomFileName"]} option in step 2, so you should receive a random filename back from the API like "exportc111111d-a1a1-a1a1-a1a1-d1111111f.csv". You will need to document this filename if you plan on running the download command after this one.

**Step 5: Download your exported report**
**Step 4: Download your exported report**

Set up another API call in almost the same way you did before. You don't need the template key in the Body anymore, so delete that and set the Body type to "none". Then modify your requestJobDescription to read like below, but with your own credentials and file name:

Expand All @@ -166,7 +166,7 @@ Click Go and you should see the CSV in the response body.

*Thank you to our customer Frederico Pettinella who originally wrote and shared this guide.*

### Use Advanced Employee Updater API with Postman
## Use Advanced Employee Updater API with Postman

1. Create a new request.
2. Select POST as the method.
Expand Down
Loading