{"info":{"_postman_id":"9a502a2b-5a76-47cd-8245-b1a57385210c","name":"EXPENSIFY POSTMAN COLLECTION","description":"

This Postman collection provides a comprehensive overview of the Expensify Integration Server endpoints. It offers all the information you need to integrate your application with Expensify's functionalities.

The collection includes requests for:

Programmatically downloading expense report data for analysis or import into your accounting system.
\n
Provisioning accounts for new employees.
\n
And many more functionalities offered by the Expensify API.
\n

The Expensify API is a self-service tool, but you can also find valuable discussions about API usage on the Expensify community forum.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"28050470","collectionId":"9a502a2b-5a76-47cd-8245-b1a57385210c","publishedId":"2sA35D74CW","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-03-27T00:06:59.000Z"},"item":[{"name":"AUTHENTICATION","item":[],"id":"9c0fbba4-0476-4fe5-a8ac-f561e4f077eb","description":"

To use the API, you will need to generate API credentials.

Create an Expensify account at https://www.expensify.com/
\n
Go to https://www.expensify.com/tools/integrations/
\n
A pair of credentials: partnerUserID and partnerUserSecret will be generated and shown on the page.
\n

\n","_postman_id":"9c0fbba4-0476-4fe5-a8ac-f561e4f077eb"},{"name":"REQUEST FORMAT","item":[],"id":"40b70bae-c072-45f6-b738-f71dca58cf2c","description":"

Every request to the Expensify API follows the same pattern: a JSON payload that identifies the job to execute is passed as a parameter called requestJobDescription. Additionally, other parameters may be needed based on the type of job.

Finally, there is a general rate limit of 50 jobs started per minute. Exceeding this limit will result in the following error message: You have been rate-limited. Please try again later or contact help@expensify.com for assistance.

Every request has to be made against the endpoint https://integrations.expensify.com/Integration-Server/ExpensifyIntegrations.

Request Job Description format

For every request, the requestJobDescription JSON parameter needs to contain the following data:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

PARAMETER	TYPE	DESCRIPTION
type	String	The type of job to execute.
credentials	JSON object	An object containing two key-values used to authenticate you: * partnerUserID
		* partnerUserSecret
inputSettings	JSON Object	(Optional) Additional settings specific to the job type. Refer to the Expensify API documentation for details on supported inputSettings for each job.

","_postman_id":"40b70bae-c072-45f6-b738-f71dca58cf2c"},{"name":"ENDPOINTS","item":[{"name":"EXPORT","item":[{"name":"Report Exporter","item":[{"name":"Export Report","id":"086beb96-7d3d-4bc3-bbe3-b16c76b1cb23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{partnerUserID}}"},{"key":"password","value":"{{partnerUserID}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"requestJobDescription","value":"{\n \"type\":\"file\",\n \"credentials\":{\n \"partnerUserID\":{{partnerUserID}},\n \"partnerUserSecret\":{{partnerUserSecret}}\n },\n \"onReceive\":{\n \"immediateResponse\":[\"returnRandomFileName\"]\n },\n \"inputSettings\":{\n \"type\":\"combinedReportData\",\n \"filters\":{\n \"reportIDList\": \"R00bCluvcO4T,R006AseGxMka\"\n }\n },\n \"outputSettings\":{\n \"fileExtension\":\"csv\"\n }\n }' \\\n --data-urlencode 'template@expensify_template.ftl'","type":"text"}]},"url":"https://integrations.expensify.com/Integration-Server/ExpensifyIntegrations","urlObject":{"protocol":"https","path":["Integration-Server","ExpensifyIntegrations"],"host":["integrations","expensify","com"],"query":[],"variable":[]}},"response":[{"id":"bc25c4f6-7313-4e4b-9d26-a3a82e016016","name":"Export reports by ID, to a CSV file","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"requestJobDescription","value":"{\n \"type\":\"file\",\n \"credentials\":{\n \"partnerUserID\":{{partnerUserID}},\n \"partnerUserSecret\":{{partnerUserSecret}}\n },\n \"onReceive\":{\n \"immediateResponse\":[\"returnRandomFileName\"]\n },\n \"inputSettings\":{\n \"type\":\"combinedReportData\",\n \"filters\":{\n \"reportIDList\": \"R00bCluvcO4T,R006AseGxMka\"\n }\n },\n \"outputSettings\":{\n \"fileExtension\":\"csv\"\n }\n }' \\\n --data-urlencode 'template@expensify_template.ftl'","type":"text"}]},"url":"https://integrations.expensify.com/Integration-Server/ExpensifyIntegrations"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 Mar 2024 06:51:12 GMT"},{"key":"Content-Type","value":"text/plain;charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Servlet/3.1 JSP/2.3 (GlassFish Server Open Source Edition 4.1.1 Java/Private Build/1.8)"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"OPTIONS, GET, POST"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"origin-when-cross-origin"},{"key":"Content-Security-Policy","value":"frame-ancestors https://www.expensify.com https://staging.expensify.com https://integrations.expensify.com"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\r\n \"responseCode\": 200\r\n}"},{"id":"8fa6d588-5bf0-4c1b-95ce-9562f1f9f1f5","name":"Export Approved And Reimbursed Reports to A XLSX File","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"requestJobDescription","value":"{\n \"type\":\"file\",\n \"credentials\":{\n \"partnerUserID\":\"_REPLACE_\",\n \"partnerUserSecret\":\"_REPLACE_\"\n },\n \"onReceive\":{\n \"immediateResponse\":[\"returnRandomFileName\"]\n },\n \"inputSettings\":{\n \"type\":\"combinedReportData\",\n \"filters\":{\n \"reportIDList\": \"R00bCluvcO4T,R006AseGxMka\"\n }\n },\n \"outputSettings\":{\n \"fileExtension\":\"csv\"\n }\n }' \\\n --data-urlencode 'template@expensify_template.ftl'\nExport at most 10 Approved and Reimbursed reports generated between 2016-01-01 and 2016-02-01 to an xlsx file named myExport.xlsx. The exported reports are then marked as exported with the label \"Expensify Export\" (markAsExported action), and an email with a link to the output is sent. Reports that have already been marked with the label \"Expensify Export\" are ignored (markedAsExported filter)\ncurl -X POST 'https://integrations.expensify.com/Integration-Server/ExpensifyIntegrations' \\\n -d 'requestJobDescription={\n \"type\":\"file\",\n \"credentials\":{\n \"partnerUserID\":{{partnerUserID}},\n \"partnerUserSecret\":{{partnerUserID}}\n },\n \"onReceive\":{\n \"immediateResponse\":[\"returnRandomFileName\"]\n },\n \"inputSettings\":{\n \"type\":\"combinedReportData\",\n \"reportState\":\"APPROVED,REIMBURSED\",\n \"limit\":\"10\",\n \"filters\":{\n \"startDate\":\"2016-01-01\",\n \"endDate\":\"2016-02-01\",\n \"markedAsExported\":\"Expensify Export\"\n }\n },\n \"outputSettings\":{\n \"fileExtension\":\"xlsx\",\n \"fileBasename\":\"myExport\"\n },\n \"onFinish\":[\n {\"actionName\":\"markAsExported\",\"label\":\"Expensify Export\"},\n {\"actionName\":\"email\",\"recipients\":\"manager@domain.com,finances@domain.com\", \"message\":\"Report is ready.\"}\n ]\n }' \\\n --data-urlencode 'template@expensify_template.ftl'","type":"text"}]},"url":"https://integrations.expensify.com/Integration-Server/ExpensifyIntegrations"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 Mar 2024 07:27:10 GMT"},{"key":"Content-Type","value":"text/plain;charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Servlet/3.1 JSP/2.3 (GlassFish Server Open Source Edition 4.1.1 Java/Private Build/1.8)"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"OPTIONS, GET, POST"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"origin-when-cross-origin"},{"key":"Content-Security-Policy","value":"frame-ancestors https://www.expensify.com https://staging.expensify.com https://integrations.expensify.com"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\r\n \"responseCode\": 200\r\n}\r\n\r\n The exported reports are then marked as exported with the label \"Expensify Export\" (markAsExported action), and an email with a link to the output is sent. Reports that have already been marked with the label \"Expensify Export\" are ignored (markedAsExported filter)"}],"_postman_id":"086beb96-7d3d-4bc3-bbe3-b16c76b1cb23"}],"id":"265c538a-5468-4bb5-8e35-7901aea90e9c","description":"

Export expense or report data in a configurable format for analysis or insertion into your accounting package. See the export template format reference for more information about how to write export templates.

`requestJobDescription` format

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

NAME	FORMAT	VALID VALUES	DESCRIPTION
type	String	file
onReceive	JSON object	`{\"immediateResponse\":[\"returnRandomFileName\"]}`	Returns the name of the generated report. Only this export mode is supported at the moment.
inputSettings	JSON object	See inputSettings	Settings used to filter the reports that are exported.
outputSettings	JSON object	See outputSettings	Settings for the generated file.
Optional elements
test	String	true, false	If set to true, actions defined in `onFinish` will not be executed.
onFinish	JSON array	See onFinish	Actions performed at the end of the export.

inputSettings

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

NAME	FORMAT	VALID VALUES	DESCRIPTION
type	String	combinedReportData	Specifies all Expensify reports will be combined into a single file.
filters	JSON object	See inputSettings filters
Optional elements
reportState	String	One or more of `\"OPEN\"`, `\"SUBMITTED\"`, `\"APPROVED\"`, `\"REIMBURSED\"`, `\"ARCHIVED\"`. When using multiple statuses, separate them by a comma, e.g. `\"APPROVED,REIMBURSED\"` Note: These values respectively match the statuses \"Open\", \"Processing\", \"Approved\", \"Reimbursed\" and \"Closed\" on the website	Only the reports matching the specified status(es) will be exported.
limit	String	Any integer, as a string	Maximum number of reports to export.
employeeEmail	String	A valid email address Note: * The usage of this parameter is restricted to certain domains * If this parameter is used, reports in the OPEN status cannot be exported	The reports will be exported from that account.

inputSettings.filters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

NAME	FORMAT	VALID VALUES	DESCRIPTION
reportIDList	String, Required if `_startDate_` or `_approvedAfter_` are not specified		Comma-separated list of report IDs to be exported.
policyIDList	String, Optional		Comma-separated list of policy IDs the exported reports must be under.
startDate	Date, Required if `_reportIDList_` or `_approvedAfter_` are not specified	yyyy-mm-dd formatted date	Filters out all reports submitted or created before the given date, whichever occurred last (inclusive).
endDate	Date, Optional	yyyy-mm-dd formatted date	Filters out all reports submitted or created after the given date, whichever occurred last (inclusive).
approvedAfter	Date, Required if `_reportIDList_` or `_startDate_` are not specified	yyyy-mm-dd formatted date	Filters out all reports approved before, or on that date. This filter is only used against reports that have been approved.
markedAsExported	String, Optional	Any string	Filters out reports that have already been exported with that label out.

outputSettings

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

NAME	FORMAT	VALID VALUES	DESCRIPTION
fileExtension	String	One or multiple of \"csv\", \"xls\", \"xlsx\", \"txt\", \"pdf\", \"json\", \"xml\"	Specifies the format of the generated report. Note: if the \"pdf\" option is chosen, one PDF file will be generated for each report exported.
Optional elements
fileBasename	String	Any valid file base name	The name of the generated file(s) will start with this value, and a random part will be added to make each filename globally unique. If not specified, the default value `export` is used.
includeFullPageReceiptsPdf	Boolean	`true`, `false`	Specifies whether generated PDFs should include full page receipts. This parameter is used only if `fileExtension` contains `pdf`.

onFinish (Optional)

This section can be used to describe actions that need to be performed at the end of the export.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

ACTION NAME	DESCRIPTION
email	Send an email linking to the generated report to a provided list of recipients.
markAsExported	Mark the exported reports as “Exported” in Expensify.
sftpUpload	upload the generated file(s) to an SFTP server.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

NAME	FORMAT	VALID VALUES	DESCRIPTION
`email` action
recipients	String	Comma-separated list of valid email addresses	People to email at the end of the export.
message	String	Plain text or Freemarker message	Content of the message. If using Freemarker, the `filenames` list can be used to get the names of all files that have been generated.
`markAsExported` action
label	String	Any string value	The exported reports will be marked as exported with this label.
`sftpUpload` action
sftpData	JSON object		See below
`sftpUpload.sftpData` action
host	String		The SFTP host to connect to. You can upload to a specific folder by setting the `homedir` (home directory) of the SFTP user to that folder. You cannot specify a specific folder any other way.
login	String		The username to use for SFTP authentication.
password	String		The password to use during authentication.
port	Integer		The port to connect to on the SFTP server.

Template parameter

The template parameter is used to format the Expensify data as you wish. It is based on the Freemarker language's syntax.

See the export template format reference for more information about how to write export templates.

We recommend storing your template in separate files, which can be passed to the request more easily with cURL's `@` operator.

\n","_postman_id":"265c538a-5468-4bb5-8e35-7901aea90e9c"},{"name":"Downloader","item":[{"name":"Download Report","id":"a78fdfdc-eafd-4c9b-8422-c12acd39698b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{partnerUserID}}"},{"key":"password","value":"{{partnerUserSecret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"requestJobDescription","value":"{\n \"type\":\"download\",\n \"credentials\":{\n \"partnerUserID\":{{partnerUserID}},\n \"partnerUserSecret\":{{partnerUserSecret}}\n },\n \"fileName\":\"myFile.csv\",\n \"fileSystem\":\"integrationServer\"\n }'","type":"text"}]},"url":"https://integrations.expensify.com/Integration-Server/ExpensifyIntegrations","urlObject":{"protocol":"https","path":["Integration-Server","ExpensifyIntegrations"],"host":["integrations","expensify","com"],"query":[],"variable":[]}},"response":[{"id":"88b21eb3-0b8a-41e2-b4bf-2fe00f61f627","name":"Download Report","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"requestJobDescription","value":"{\n \"type\":\"download\",\n \"credentials\":{\n \"partnerUserID\":{{partnerUserID}},\n \"partnerUserSecret\":{{partnerUserSecret}}\n },\n \"fileName\":\"myFile.csv\",\n \"fileSystem\":\"integrationServer\"\n }'","type":"text"}]},"url":"https://integrations.expensify.com/Integration-Server/ExpensifyIntegrations"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 Mar 2024 06:44:28 GMT"},{"key":"Content-Type","value":"text/plain;charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Servlet/3.1 JSP/2.3 (GlassFish Server Open Source Edition 4.1.1 Java/Private Build/1.8)"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"OPTIONS, GET, POST"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"origin-when-cross-origin"},{"key":"Content-Security-Policy","value":"frame-ancestors https://www.expensify.com https://staging.expensify.com https://integrations.expensify.com"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\r\n \"responseCode\": 200\r\n}\r\n\r\n"}],"_postman_id":"a78fdfdc-eafd-4c9b-8422-c12acd39698b"}],"id":"2e91b561-9aad-4c86-8422-ebb7f82645b9","description":"

This table describes the structure of the response you receive when downloading reports using the Download Report endpoint.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Format	Description
fileName	String	The name of the downloaded report file.
Optional Elements
fileSystem	String	(Optional) Specifies the report type.
		Valid values are:
		`reconciliation` for reports generated by the Reconciliation job.
		`integrationServer` (default) for reports generated by the Report Exporter job.

","_postman_id":"2e91b561-9aad-4c86-8422-ebb7f82645b9"}],"id":"b575101c-2341-4a51-aec5-47b5ce882627","_postman_id":"b575101c-2341-4a51-aec5-47b5ce882627","description":""},{"name":"CREATE","item":[{"name":"Report Creator","item":[{"name":"Create Report","id":"59162d63-c4c3-42f5-a49f-5394d4ba8d53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"requestJobDescription","value":"{\n \"type\": \"create\",\n \"credentials\": {\n \"partnerUserID\": {{partnerUserID}},\n \"partnerUserSecret\":{{partnerUserSecret}}\n },\n \"inputSettings\": {\n \"type\": \"report\",\n \"policyID\": \"952DB91B963583C7\",\n \"report\": {\n \"title\": \"Name of the report\",\n \"fields\":{\n \"reason_of_trip\": \"Business trip\",\n \"employees\": \"3\"\n }\n },\n \"employeeEmail\": \"ifedolapo387@gmail.com\",\n \"expenses\": [\n {\n \"date\": \"2024-03-24\",\n \"currency\": \"USD\",\n \"merchant\": \"Name of merchant\",\n \"amount\": 1234\n },\n {\n \"date\": \"2024-03-27\",\n \"currency\": \"CAD\",\n \"merchant\": \"Name of merchant\",\n \"amount\": 2211\n }\n ]\n }\n }'","type":"text"}]},"url":"https://integrations.expensify.com/Integration-Server/ExpensifyIntegrations","urlObject":{"protocol":"https","path":["Integration-Server","ExpensifyIntegrations"],"host":["integrations","expensify","com"],"query":[],"variable":[]}},"response":[{"id":"cbc9e9cf-ff6e-48c8-8bb4-6b13566f4e12","name":"Create Report","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"requestJobDescription","value":"{\n \"type\": \"create\",\n \"credentials\": {\n \"partnerUserID\": {{partnerUserID}},\n \"partnerUserSecret\":{{partnerUserSecret}}\n },\n \"inputSettings\": {\n \"type\": \"report\",\n \"policyID\": \"952DB91B963583C7\",\n \"report\": {\n \"title\": \"Name of the report\",\n \"fields\":{\n \"reason_of_trip\": \"Business trip\",\n \"employees\": \"3\"\n }\n },\n \"employeeEmail\": \"ifedolapo387@gmail.com\",\n \"expenses\": [\n {\n \"date\": \"2024-03-24\",\n \"currency\": \"USD\",\n \"merchant\": \"Name of merchant\",\n \"amount\": 1234\n },\n {\n \"date\": \"2024-03-27\",\n \"currency\": \"CAD\",\n \"merchant\": \"Name of merchant\",\n \"amount\": 2211\n }\n ]\n }\n }'","type":"text"}]},"url":"https://integrations.expensify.com/Integration-Server/ExpensifyIntegrations"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 Mar 2024 07:37:56 GMT"},{"key":"Content-Type","value":"text/plain;charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Servlet/3.1 JSP/2.3 (GlassFish Server Open Source Edition 4.1.1 Java/Private Build/1.8)"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"OPTIONS, GET, POST"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"origin-when-cross-origin"},{"key":"Content-Security-Policy","value":"frame-ancestors https://www.expensify.com https://staging.expensify.com https://integrations.expensify.com"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\r\n \"responseCode\": 200,\r\n \"reportName\": \"Name of the report\",\r\n \"reportID\": \"R006AseGxMka\"\r\n}"}],"_postman_id":"59162d63-c4c3-42f5-a49f-5394d4ba8d53"}],"id":"3a9a8584-ed1f-43b7-b2ca-e2cf9beca88b","description":"

This section details creating a report within a user's Expensify account using the requestJobDescription format. However, this functionality requires prior enablement by Expensify Concierge.

Requirements:

Domain and Policy Admin permissions
\n
Functionality enabled for your domain by contacting concierge@expensify.com
\n

Error Handling:

If you encounter the \"Not authorized to authenticate as user\" error, it signifies report creation functionality is not enabled for your domain.

Request Format:

The request utilizes the requestJobDescription format with specific inputSettings. Here's a breakdown of the required fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Format	Valid Values	Description
type	String	\"report\"	Specifies the job type as report creation.
employeeEmail	String	A valid email address	The report will be created in the corresponding user's account.
report (JSON Object)		See report details below.	Defines report properties.
expenses (JSON Array)		See expenses details below.	Defines expense details to be included in the report (optional).
policyID	String	Any valid Expensify policy ID	The report will be associated with this policy.

inputSettings.report Details:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Format	Valid Values	Description
title	String		The title of the report.
fields (Optional - JSON Object)		A series of key-value pairs.	Defines values for custom fields on the specified policy (key names require underscores for non-alphanumeric characters).

inputSettings.expenses Details (Optional):

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Format	Valid Values	Description
merchant	String		The merchant name for the expense.
currency	String	Three-letter currency code (e.g., USD, EUR)	The currency in which the expense was made.
date	Date	yyyy-mm-dd format	The date of the expense.
amount	Integer		The expense amount in cents.

","_postman_id":"3a9a8584-ed1f-43b7-b2ca-e2cf9beca88b"},{"name":"Expense Creator","item":[{"name":"Create Expense","id":"726086c1-f4c2-4a6d-a884-6a2cacab9260","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{partnerUserID}}"},{"key":"password","value":"{{partnerUserSecret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"requestJobDescription","value":"{\n \"type\":\"create\",\n \"credentials\":{\n \"partnerUserID\":{{partnerUserID}},\n \"partnerUserSecret\":{{partnerUserSecret}}\n },\n \"inputSettings\":{\n \"type\":\"expenses\",\n \"employeeEmail\":\"user@domain.com\",\n \"transactionList\": [\n {\n \"created\": \"2016-01-01\",\n \"currency\": \"USD\",\n \"merchant\": \"Name of merchant 1\",\n \"amount\": 1234\n },\n {\n \"created\": \"2016-01-21\",\n \"currency\": \"EUR\",\n \"merchant\": \"Name of merchant 2\",\n \"amount\": 2211,\n \"policyID\": \"E40D9B8DF456E233\",\n \"tax\": {\n \"rateID\":\"id_TAX_OPTION_16\"\n }\n },\n {\n \"created\": \"2016-01-31\",\n \"currency\": \"CAD\",\n \"merchant\": \"Name of merchant 3\",\n \"amount\": 2211,\n \"reportID\": \"R006AseGxMka\",\n \"tax\": {\n \"rateID\":\"id_TAX_OPTION_16\",\n \"amount\":600\n }\n }\n ]\n }\n }'","type":"text"}]},"url":"https://integrations.expensify.com/Integration-Server/ExpensifyIntegrations","urlObject":{"protocol":"https","path":["Integration-Server","ExpensifyIntegrations"],"host":["integrations","expensify","com"],"query":[],"variable":[]}},"response":[{"id":"2a948e97-43db-4e2a-9ce6-d5e99133f255","name":"Create Expense","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"requestJobDescription","value":"{\n \"type\":\"create\",\n \"credentials\":{\n \"partnerUserID\":{{partnerUserID}},\n \"partnerUserSecret\":{{partnerUserSecret}}\n },\n \"inputSettings\":{\n \"type\":\"expenses\",\n \"employeeEmail\":\"user@domain.com\",\n \"transactionList\": [\n {\n \"created\": \"2016-01-01\",\n \"currency\": \"USD\",\n \"merchant\": \"Name of merchant 1\",\n \"amount\": 1234\n },\n {\n \"created\": \"2016-01-21\",\n \"currency\": \"EUR\",\n \"merchant\": \"Name of merchant 2\",\n \"amount\": 2211,\n \"policyID\": \"E40D9B8DF456E233\",\n \"tax\": {\n \"rateID\":\"id_TAX_OPTION_16\"\n }\n },\n {\n \"created\": \"2016-01-31\",\n \"currency\": \"CAD\",\n \"merchant\": \"Name of merchant 3\",\n \"amount\": 2211,\n \"reportID\": \"R006AseGxMka\",\n \"tax\": {\n \"rateID\":\"id_TAX_OPTION_16\",\n \"amount\":600\n }\n }\n ]\n }\n }'","type":"text"}]},"url":"https://integrations.expensify.com/Integration-Server/ExpensifyIntegrations"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 Mar 2024 07:49:47 GMT"},{"key":"Content-Type","value":"text/plain;charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Servlet/3.1 JSP/2.3 (GlassFish Server Open Source Edition 4.1.1 Java/Private Build/1.8)"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"OPTIONS, GET, POST"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"origin-when-cross-origin"},{"key":"Content-Security-Policy","value":"frame-ancestors https://www.expensify.com https://staging.expensify.com https://integrations.expensify.com"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\r\n \"responseCode\" : 200,\r\n \"transactionList\" : [\r\n {\r\n \"amount\" : 1234,\r\n \"merchant\" : \"Name Of Merchant 1\",\r\n \"created\" : \"2016-01-01\",\r\n \"transactionID\" : \"6720309558248016\",\r\n \"currency\" : \"USD\"\r\n },\r\n {\r\n \"amount\" : 2211,\r\n \"merchant\" : \"Name Of Merchant 2\",\r\n \"created\" : \"2016-01-31\",\r\n \"transactionID\" : \"6720309558248017\",\r\n \"currency\" : \"CAD\"\r\n }\r\n ]\r\n}"}],"_postman_id":"726086c1-f4c2-4a6d-a884-6a2cacab9260"}],"id":"09749f4e-2b0c-4e40-b577-7f993ed133b1","description":"

This section details how to create expenses in a user's account through the Expensify API.

Request Format:

This follows the requestJobDescription format with specific input settings.

Input Settings:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Format	Valid Values	Description
type	String	\"expenses\"	Specifies to create expenses.
employeeEmail	String	A valid email address	The expenses will be created in this account.

Note: Using employeeEmail requires advanced permissions. Contact Expensify's Customer Community for more information.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Format	Description
transactionList	JSON array	List of expense objects. (See below for details)

Expense Object Details:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Format	Description
merchant	String	The name of the expense's merchant.
created	String	The date of the expense (format yyyy-mm-dd).
amount	Integer	The amount of the expense, in cents.
currency	String	The three-letter currency code of the expense.

Optional Expense Elements:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Format	Description
externalID	String	A unique, custom string to identify the expense after export.
category	String	The name of the category to assign to the expense
tag	String	The name of the tag to assign to the expense
billable	boolean	Whether to mark the expense as billable or not
reimbursable	Boolean	Whether to mark the expense as reimbursable or not
comment	String	An expense comment.
reportID	String	The ID of the report you want to attach the expense to.
policyID	String	The ID of the policy the tax belongs to.
tax	JSONObject	A tax object (See below for details)

Tax Object Details:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Format	Valid Values	Description
rateID	String	The tax rateID from the policy (use Policy Getter job to retrieve).	The tax rateID
amount	Integer (Optional)	The tax amount paid on the expense (specify for partial tax).	The tax amount paid on the expense

","_postman_id":"09749f4e-2b0c-4e40-b577-7f993ed133b1"}],"id":"821e36d3-ff61-4170-9b16-aac7c7271989","_postman_id":"821e36d3-ff61-4170-9b16-aac7c7271989","description":""},{"name":"READ/GET","item":[{"name":"Policy Getter","item":[{"name":"Retrieve Policy","id":"5de64d8a-6594-4a4b-91cd-c999e48b4163","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{partnerUserID}}"},{"key":"password","value":"{{partnerUserSecret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"requestJobDescription","value":"{\n \"type\":\"get\",\n \"credentials\":{\n \"partnerUserID\": {{partnerUserID}},\n \"partnerUserSecret\": {{partnerUserSecret}}\n },\n \"inputSettings\":{\n \"type\":\"policy\",\n \"fields\": [\"tax\"],\n \"policyIDList\": [\"952DB91B963583C7\"],\n \"userEmail\":\"ifedolapo387@gmail.com\"\n }\n }'","type":"text"}]},"url":"https://integrations.expensify.com/Integration-Server/ExpensifyIntegrations","urlObject":{"protocol":"https","path":["Integration-Server","ExpensifyIntegrations"],"host":["integrations","expensify","com"],"query":[],"variable":[]}},"response":[{"id":"bf5a9ee0-c167-411e-84f9-b3c65c4a3f23","name":"Retrieve Policy","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"requestJobDescription","value":"{\n \"type\":\"get\",\n \"credentials\":{\n \"partnerUserID\": {{partnerUserID}},\n \"partnerUserSecret\": {{partnerUserSecret}}\n },\n \"inputSettings\":{\n \"type\":\"policy\",\n \"fields\": [\"tax\"],\n \"policyIDList\": [\"952DB91B963583C7\"],\n \"userEmail\":\"ifedolapo387@gmail.com\"\n }\n }'","type":"text"}]},"url":"https://integrations.expensify.com/Integration-Server/ExpensifyIntegrations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 Mar 2024 08:04:03 GMT"},{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Content-Length","value":"61"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Servlet/3.1 JSP/2.3 (GlassFish Server Open Source Edition 4.1.1 Java/Private Build/1.8)"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"OPTIONS, GET, POST"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"origin-when-cross-origin"},{"key":"Content-Security-Policy","value":"frame-ancestors https://www.expensify.com https://staging.expensify.com https://integrations.expensify.com"}],"cookie":[],"responseTime":null,"body":"{\n \"responseCode\": 200,\n \"policyInfo\": {\n \"4C6722D4BD2BD941\": {\n \"reportFields\": [{\n \"values\": [],\n \"name\": \"title\",\n \"type\": \"formula\"\n }, {\n \"values\": [\"Class 1\", \"Class 2\", \"Class 2:Sub class 2\"],\n \"name\": \"Classes\",\n \"type\": \"dropdown\"\n }, {\n \"values\": [\"Donatello\", \"Leonardo\", \"Michelangelo\", \"Rafael\"],\n \"name\": \"Customers/Jobs\",\n \"type\": \"dropdown\"\n }],\n \"categories\": [{\n \"name\": \"Entertainment\",\n \"enabled\": true\n }, {\n \"name\": \"Transportation\",\n \"enabled\": true\n }, {\n \"name\": \"Phone\",\n \"enabled\": true\n }, {\n \"name\": \"Fuel/Mileage\",\n \"enabled\": true\n }, {\n \"name\": \"Lodging\",\n \"enabled\": true\n }, {\n \"name\": \"Meals\",\n \"enabled\": true\n }, {\n \"name\": \"Other\",\n \"enabled\": false\n }],\n \"tags\": [{\n \"glCode\": \"\",\n \"name\": \"Enterprise\",\n \"enabled\": true\n }, {\n \"glCode\": \"\",\n \"name\": \"Enterprise:Jean-Luc Picard\",\n \"enabled\": true\n }, {\n \"glCode\": \"\",\n \"name\": \"Enterprise:Lt. Commander Data\",\n \"enabled\": true\n }, {\n \"glCode\": \"\",\n \"name\": \"Enterprise:William Riker\",\n \"enabled\": true\n }],\n \"tax\": {\n \"default\": \"4\",\n \"rates\": [{\n \"rate\": 0,\n \"name\": \"EC Goods Zero-rated\",\n \"rateID\": \"5\"\n }, {\n \"rate\": 0,\n \"name\": \"EC Services Standard\",\n \"rateID\": \"4\"\n }, {\n \"rate\": 20,\n \"name\": \"Standard\",\n \"rateID\": \"2\"\n }, {\n \"rate\": 5,\n \"name\": \"Reduced\",\n \"rateID\": \"9\"\n }],\n \"name\": \"Tax\"\n }\n },\n \"3F329EA1C3809E6C\": {\n \"categories\": [{\n \"name\": \"Phone Costs\",\n \"areCommentsRequired\": false,\n \"enabled\": false\n }, {\n \"name\": \"Legal\",\n \"areCommentsRequired\": false,\n \"enabled\": false\n }, {\n \"name\": \"Agency Expense\",\n \"areCommentsRequired\": false,\n \"enabled\": false\n }],\n \"reportFields\": [{\n \"values\": [],\n \"name\": \"title\",\n \"type\": \"formula\"\n }],\n \"tags\": [{\n \"name\": \"Tags\",\n \"tags\": []\n }],\n \"tax\": {},\n \"employees\": [{\n \"email\": \"admin@domain.com\",\n \"role\": \"admin\",\n \"submitsTo\": \"user@domain.com\"\n }, {\n \"email\": \"user@domain.com\",\n \"role\": \"user\",\n \"submitsTo\": \"admin@domain.com\",\n \"employeeID\": \"Emp1\",\n \"customField2\": \"custom information\",\n }]\n }\n }\n}"}],"_postman_id":"5de64d8a-6594-4a4b-91cd-c999e48b4163"}],"id":"5c30bf38-103b-4bbc-91f4-346372997ca6","description":"

This section describes the input parameters for retrieving specific information about listed policies.

Here's a breakdown of the parameters needed:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter Name	Format	Valid Values	Description
type	String	\"policy\"	Specifies to the job that it has to get information specific to policies.
policyIDList	JSON Array		The IDs of the policies to get information for.
fields	JSON Array	\"categories\", \"reportFields\", \"tags\", \"tax\", \"employees\"	Specifies the fields of the policy to gather information for.

Optional Elements:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter Name	Format	Description
userEmail	String	Specifies the user to gather the policy data for. You must have been granted third-party access by that user/company domain beforehand.

","_postman_id":"5c30bf38-103b-4bbc-91f4-346372997ca6"}],"id":"df7f26be-5607-455b-9a99-64ddf9e37d80","_postman_id":"df7f26be-5607-455b-9a99-64ddf9e37d80","description":""},{"name":"UPDATE","item":[{"name":"Policy Updater","item":[{"name":"Update Policy","id":"b192fed3-4651-4499-bd78-9643fb0d0237","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{partnerUserID}}"},{"key":"password","value":"{{partnerUserSecret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"requestJobDescription","value":"{\n \"type\": \"update\",\n \"credentials\": {\n \"partnerUserID\": {{partnerUserID}},\n \"partnerUserSecret\": {{partnerUserSecret}}\n },\n \"inputSettings\": {\n \"type\": \"policy\",\n \"policyID\": \"0123456789ABCDEF\"\n },\n \"categories\": {\n \"action\": \"merge\",\n \"data\": [\n {\n \"name\": \"Category 1\",\n \"enabled\": true,\n \"payrollCode\": \"Payroll Code 1\",\n \"glCode\": \"GL Code 1\",\n \"commentHint\": \"Comment hint 1\",\n \"areCommentsRequired\": true,\n \"maxExpenseAmount\": 2500\n },\n {\n \"name\": \"Category 2\",\n \"enabled\": false\n }\n ]\n },\n \"tags\": {\n \"data\": [\n {\n \"name\": \"Tag\",\n \"tags\": [\n {\n \"name\": \"Tag 1\",\n \"glCode\": \"Tag 1 GL Code\"\n },\n {\n \"name\": \"Tag 2\",\n \"enabled\": false\n }\n ]\n }\n ]\n },\n \"reportFields\": {\n \"action\": \"merge\",\n \"data\": [\n {\n \"name\": \"Report field 1\",\n \"type\": \"dropdown\",\n \"values\": [\n \"value 1\",\n \"value 2\",\n \"value 3\"\n ]\n }\n ]\n }\n }'","type":"text"}]},"url":"https://integrations.expensify.com/Integration-Server/ExpensifyIntegrations","urlObject":{"protocol":"https","path":["Integration-Server","ExpensifyIntegrations"],"host":["integrations","expensify","com"],"query":[],"variable":[]}},"response":[{"id":"03268392-83be-4486-8f5c-e25edd38c9f9","name":"Update Categories, Tags, and Report Fields","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"requestJobDescription","value":"{\n \"type\": \"update\",\n \"credentials\": {\n \"partnerUserID\": {{partnerUserID}},\n \"partnerUserSecret\": {{partnerUserSecret}}\n },\n \"inputSettings\": {\n \"type\": \"policy\",\n \"policyID\": \"0123456789ABCDEF\"\n },\n \"categories\": {\n \"action\": \"merge\",\n \"data\": [\n {\n \"name\": \"Category 1\",\n \"enabled\": true,\n \"payrollCode\": \"Payroll Code 1\",\n \"glCode\": \"GL Code 1\",\n \"commentHint\": \"Comment hint 1\",\n \"areCommentsRequired\": true,\n \"maxExpenseAmount\": 2500\n },\n {\n \"name\": \"Category 2\",\n \"enabled\": false\n }\n ]\n },\n \"tags\": {\n \"data\": [\n {\n \"name\": \"Tag\",\n \"tags\": [\n {\n \"name\": \"Tag 1\",\n \"glCode\": \"Tag 1 GL Code\"\n },\n {\n \"name\": \"Tag 2\",\n \"enabled\": false\n }\n ]\n }\n ]\n },\n \"reportFields\": {\n \"action\": \"merge\",\n \"data\": [\n {\n \"name\": \"Report field 1\",\n \"type\": \"dropdown\",\n \"values\": [\n \"value 1\",\n \"value 2\",\n \"value 3\"\n ]\n }\n ]\n }\n }'","type":"text"}]},"url":"https://integrations.expensify.com/Integration-Server/ExpensifyIntegrations"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 Mar 2024 08:10:44 GMT"},{"key":"Content-Type","value":"text/plain;charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Servlet/3.1 JSP/2.3 (GlassFish Server Open Source Edition 4.1.1 Java/Private Build/1.8)"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"OPTIONS, GET, POST"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"origin-when-cross-origin"},{"key":"Content-Security-Policy","value":"frame-ancestors https://www.expensify.com https://staging.expensify.com https://integrations.expensify.com"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\r\n \"responseCode\": 200\r\n}\r\n"},{"id":"1addeeac-fcd8-4fd0-a8b3-f1b1b355c623","name":"Update Independent Multi-level Tags in JSON","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"requestJobDescription","value":"{\n \"type\": \"update\",\n \"credentials\": {\n \"partnerUserID\": {{partnerUserID}},\n \"partnerUserSecret\":{{partnerUserSecret}}\n },\n \"inputSettings\": {\n \"type\": \"policy\",\n \"policyID\": \"952DB91B963583C7\"\n },\n \"tags\": {\n \"data\": [\n {\n \"name\": \"Tag Level 1\",\n \"setRequired\": true,\n \"tags\": [\n {\n \"name\": \"Tag 1\",\n \"glCode\": \"Tag 1 GL Code\"\n },\n {\n \"name\": \"Tag 2\",\n \"glCode\": \"Tag 2 GL Code\"\n }\n ]\n },\n {\n \"name\": \"Tag Level 2\",\n \"setRequired\": false,\n \"tags\": [\n {\n \"name\": \"Tag 3\",\n \"glCode\": \"Tag 3 GL Code\"\n },\n {\n \"name\": \"Tag 4\",\n \"glCode\": \"Tag 4 GL Code\"\n }\n ]\n }\n ]\n }\n }'","type":"text"}]},"url":"https://integrations.expensify.com/Integration-Server/ExpensifyIntegrations"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 Mar 2024 08:13:38 GMT"},{"key":"Content-Type","value":"text/plain;charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Servlet/3.1 JSP/2.3 (GlassFish Server Open Source Edition 4.1.1 Java/Private Build/1.8)"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"OPTIONS, GET, POST"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"origin-when-cross-origin"},{"key":"Content-Security-Policy","value":"frame-ancestors https://www.expensify.com https://staging.expensify.com https://integrations.expensify.com"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\r\n \"responseCode\": 200\r\n}\r\n\r\nNote: Dependent multi-level tags, with GL Codes and tag level names. These must be passed via CSV.\r\nTag file - In this example, we have the following data in a file called tags.csv.\r\n\r\nState,State GL,Region,Region GL,City,City GL\r\nCalifornia,100,North,20,San Francisco,1\r\nCalifornia,100,North,20,Oakland,2\r\nCalifornia,100,South,30,Los Angeles,3\r\nCalifornia,100,South,30,San Diego,4\r\nTexas,200,East,40,Dallas,5\r\nTexas,200,East,40,Houston,6\r\nTexas,200,South,50,San Antonio,7\r\n"},{"id":"0b166b38-2d0c-4c40-a0f0-5bbe5889b1fd","name":"Report Fields with the Values as Objects Rather than strings","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"requestJobDescription","value":"{\n \"type\": \"update\",\n \"credentials\": {\n \"partnerUserID\":{{partnerUserID}},\n \"partnerUserSecret\":{{partnerUserSecret}}\n },\n \"inputSettings\": {\n \"type\": \"policy\",\n \"policyID\": \"0123456789ABCDEF\"\n },\n \"tags\": {\n \"action\": \"replace\",\n \"source\":\"file\",\n \"config\": {\n \"dependency\":true,\n \"glCodes\":true,\n \"header\":true,\n \"setRequired\":true,\n \"fileType\":\"csv\"\n }\n }\n }' \\\n --data-urlencode 'file@tags.csv'","type":"text"}]},"url":"https://integrations.expensify.com/Integration-Server/ExpensifyIntegrations"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 Mar 2024 08:16:36 GMT"},{"key":"Content-Type","value":"text/plain;charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Servlet/3.1 JSP/2.3 (GlassFish Server Open Source Edition 4.1.1 Java/Private Build/1.8)"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"OPTIONS, GET, POST"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"origin-when-cross-origin"},{"key":"Content-Security-Policy","value":"frame-ancestors https://www.expensify.com https://staging.expensify.com https://integrations.expensify.com"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\r\n \"responseCode\": 200\r\n}\r\n"}],"_postman_id":"b192fed3-4651-4499-bd78-9643fb0d0237"}],"id":"f1435b1e-fcf2-4f57-986f-503c7820ea93","description":"

Lets you independently manage categories, tags and report fields on a policy.

requestJobDescription

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

NAME	FORMAT	VALID VALUES	DESCRIPTION
Optional elements
categories	JSON object	See `categories` below	Replace or update the existing categories of the policy with the ones provided.
tags	JSON object	See the dedicated Update tags section below	Replace the existing tags of the policy with the ones provided.
reportFields	JSON object	See `reportFields` below	Replace or update the existing report fields of the policy with the ones provided.

inputSettings

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

NAME	FORMAT	VALID VALUES	DESCRIPTION
type	String	\"policy\"	Specifies to the job that it has to update a policy.
policyID	String	Any valid Expensify policy ID, owned or shared with the user with admin permissions.	The ID of the policy to update.
Optional elements
policyIDList	JSON Array	Instead of providing a `policyID`, you can provide an array of policyIDs to update all polices at once with the same information.

categories

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

NAME	FORMAT	VALID VALUES	DESCRIPTION
action	String	\"merge\", \"replace\"	Specifies how the categories will be updated. - \"replace\" removes all existing categories and replaces them with the specified list - \"merge\" keeps existing categories and updates/adds the ones specified.
data	JSON array	See below

categories.data objects

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

NAME	FORMAT	DESCRIPTION
name	String	The name of the category.
enabled	Boolean	Whether the category is enabled on Expensify.
Optional elements
glCode	String	The GL Code associated to the category.
payrollCode	String	The Payroll Code associated to the category.
areCommentsRequired	Boolean	Whether comments are required for expenses under that category.
commentHint	String	The hint value for the comment for expenses under that category.
maxExpenseAmount	Integer	The maximum amount (in cents) for expenses under that category.

reportFields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

NAME	FORMAT	VALID VALUES	DESCRIPTION
action	String	\"merge\", \"replace\"	Specifies how the report fields will be updated. - \"replace\" removes all existing report fields and replaces them with the specified list - \"merge\" keeps existing report fields and updates/adds the ones specified.
data	JSON array	See below

reportFields.data objects

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

NAME	FORMAT	VALID VALUES	DESCRIPTION
name	String		The name of the report field.
type	String	\"text\", \"dropdown\", \"date\"	The type of the report field.
values	JSON array	Strings, JSONObjects - See below	Only if type is \"dropdown\" The values of the dropdown. Type must be uniform across the entire array. For more information on supplying JSONObjects see `reportFields.data.values` objects section below.
Optional elements
defaultValue	String		The default value of the report field. Only used for types \"text\" and \"dropdown\"

reportFields.data.values objects

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

NAME	FORMAT	VALID VALUES	DESCRIPTION
value	String		The name of the report field value.
Optional elements
enabled	Boolean	`true`, `false`	Whether the report field value is enabled or not. Default value is `true`.
externalID	String		The externalID associated with the report field value.

Update tags

Tags can be specified in two ways:

Directly in the JSON job description
As extra parameters of the request (via a csv file)

Tag levels dependency

For multi-level tagging, Expensify has the notion of tag level dependency. This means each tag level is dependent on the parent tag level above it. For more information and examples about multi-tagging, please refer to our help site.

Passing tag data in JSON (independent levels only)

tags

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

NAME	FORMAT	VALID VALUES	DESCRIPTION
data	JSON array	See below
source	String	\"inline\"	Specifies that the tags are directly passed in the JSON payload.

tags.data objects

Multiple objects can be specified. Each one corresponds to a level in multi-level tagging.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

NAME	FORMAT	VALID VALUES	DESCRIPTION
name	String		The name of the tag level. Only use with multi-level tagging.
setRequired	Boolean	`true`, `false`	Whether users must specify a tag for that level, when coding expenses. This is set to `false` by default.
tags	JSON array	See below	The tags for that level.

tags.data.tags objects

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

NAME	FORMAT	DESCRIPTION
name	String	The name of the tag.
Optional elements
enabled	Boolean	Whether the tag is enabled or not. Default value is `true`.
glCode	String	The GL Code associated to the tag.

Passing tag data from plain text as additional request parameters (dependent or independent tag levels)

The tag data must be passed in a parameter called file in the request.

The tags object must contain the following information:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

NAME	FORMAT	VALID VALUES
source	String	\"file\"
config	JSON Object	See below

tags.config

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

NAME	FORMAT	VALID VALUES	DESCRIPTION
dependency	Boolean	true, false	Whether the tag levels are dependent.
setRequired	Boolean or JSON Array	e.g. `true` or `[true, false]`	If `dependency` is `true`, then a single boolean is expected, as dependent tag lists cannot be marked as required individually. If `dependency` is `false`, an array of booleans should be used.
glCodes	Boolean	true, false	Whether adjacent columns in the tag file(s) contain GL Codes.
header	Boolean	true, false	Whether the first line of the file contains the names of the tag levels.
setRequired	Boolean	true, false	If set to `true`, users will be required to tag each expense under that category.
fileType	String	\"cvs\" or \"tsv\"	Format of the tag data.

","_postman_id":"f1435b1e-fcf2-4f57-986f-503c7820ea93"},{"name":"Report Status Updater","item":[{"name":"Update Report Status","id":"73056064-a1ff-42c2-88db-f884fd9fd76f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{partnerUserID}}"},{"key":"password","value":"{{partnerUserSecret}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"requestJobDescription","value":"{\n\"type\":\"update\",\n \"credentials\":{\n \"partnerUserID\":{{partnerUserID}},\n \"partnerUserSecret\":{{partnerUserSecret}},\n },\n \"inputSettings\":{\n \"type\":\"reportStatus\",\n \"status\" : \"REIMBURSED\",\n \"filters\":{\n \"reportIDList\": \"R006AseGxMka,R00bCluvcO4T\"\n }\n }\n }'\n","type":"text"}]},"url":"https://integrations.expensify.com/Integration-Server/ExpensifyIntegrations","urlObject":{"protocol":"https","path":["Integration-Server","ExpensifyIntegrations"],"host":["integrations","expensify","com"],"query":[],"variable":[]}},"response":[{"id":"6e6204bc-16ed-4f69-9cc6-0c747b07f7c1","name":"Update Report Status","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"requestJobDescription","value":"{\n\"type\":\"update\",\n \"credentials\":{\n \"partnerUserID\":{{partnerUserID}},\n \"partnerUserSecret\":{{partnerUserSecret}},\n },\n \"inputSettings\":{\n \"type\":\"reportStatus\",\n \"status\" : \"REIMBURSED\",\n \"filters\":{\n \"reportIDList\": \"R006AseGxMka,R00bCluvcO4T\"\n }\n }\n }'\n","type":"text"}]},"url":"https://integrations.expensify.com/Integration-Server/ExpensifyIntegrations"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 28 Mar 2024 12:08:27 GMT"},{"key":"Content-Type","value":"text/plain;charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Servlet/3.1 JSP/2.3 (GlassFish Server Open Source Edition 4.1.1 Java/Private Build/1.8)"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"OPTIONS, GET, POST"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"origin-when-cross-origin"},{"key":"Content-Security-Policy","value":"frame-ancestors https://www.expensify.com https://staging.expensify.com https://integrations.expensify.com"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\r\n \"responseCode\" : 200,\r\n \"reportIDs\" : [\r\n \"R006AseGxMka\",\r\n \"R00bCluvcO4T\"\r\n ]\r\n}\r\n\r\nPartial success\r\nskippedReports corresponds to a list of reports that could not be updated because they are in an invalid status.\r\nfailedReports corresponds to a list of reports that failed to be updated for another reason.\r\n{\r\n \"responseCode\" : 207,\r\n \"reportIDs\" : [\r\n \"R00bCluvcO4T\"\r\n ],\r\n \"skippedReports\" : [\r\n {\r\n \"reason\" : \"Report is in status 'Open'\",\r\n \"reportID\" : \"R006AseGxMka\"\r\n }\r\n ],\r\n \"failedReports\": [\r\n {\r\n \"reason\" : \"Internal error\",\r\n \"reportID\" : \"R002bGmt16ac\"\r\n }\r\n ]\r\n}\r\nValidation error\r\n{\r\n \"responseMessage\" : \"Status 'APPROVED' is not supported\",\r\n \"responseCode\" : 410\r\n}\r\n"}],"_postman_id":"73056064-a1ff-42c2-88db-f884fd9fd76f"}],"id":"c23066ec-d776-434a-acb5-af53a40189ec","description":"

This section describes how to update the status of a report using the Expensify API. Note: Currently, the only supported action is marking reports from \"Approved\" to \"Reimbursed\".

Input Settings

The following table details the required and optional input settings for updating report status:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Format	Valid Values	Description
type	String	\"reportStatus\"	Specifies the job type as updating report status.
status	String	\"REIMBURSED\"	The new status for the reports. Currently, only \"REIMBURSED\" is supported.

Note:

Only reports in the \"Approved\" status can be updated to \"Reimbursed\". Other statuses will be ignored.
You can use filters to target specific reports for the update. Details on filters are provided in the next section.

inputSettings.filters

This section details the available filters within the filters JSON object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Format	Valid Values	Description
reportIDList	String, Optional	Comma-separated list of report IDs to update.
startDate	Date, Required if reportIDList is not specified	yyyy-mm-dd formatted date	Filters reports submitted or created before this date (inclusive).
endDate	Date, Optional	yyyy-mm-dd formatted date	Filters reports submitted or created after this date (inclusive).

","_postman_id":"c23066ec-d776-434a-acb5-af53a40189ec"}],"id":"740bb08a-174e-4f4b-bd20-d5fe2dfeda11","_postman_id":"740bb08a-174e-4f4b-bd20-d5fe2dfeda11","description":""}],"id":"04b3dadf-d3e7-4bae-b599-6852c41c177b","_postman_id":"04b3dadf-d3e7-4bae-b599-6852c41c177b","description":""},{"name":"ERROR CODES","item":[],"id":"06212c8f-fc3c-48f6-80c1-566589dbb135","description":"

Expensify API Error Codes

This table lists potential error codes encountered when using the Expensify API and their possible reasons.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Possible Reason
207 (Partial Success)	Some of the reports failed to update. Their IDs are contained in the list `failedReports` within the response.
400 (Bad Request)	Missing required parameter
	Invalid parameter value format
	Malformed JSON body
401 (Unauthorized)	Invalid or missing API credentials
	Insufficient permissions for the requested action
403 (Forbidden)	The requested action is not allowed for your account
	Resource access restrictions in place
404 (Not Found)	Requested endpoint does not exist
	Resource not found (e.g., report with a specific ID)
409 (Conflict)	Attempting to create a duplicate resource (e.g., creating a report with an existing ID)
	Conflicting data in the request
410 (Validation Error)	The request contains invalid data that fails validation checks on the Expensify API side.
	Examples: Malformed date format, invalid enum value, etc.
410 (Gone)	Requested endpoint has been deprecated and is no longer available
	Resource has been deleted
422 (Unprocessable Entity)	Validation errors in the request payload
	Business logic violation (e.g., attempting to update a report with an invalid status)
429 (Too Many Requests)	Exceeding API rate limits
	Throttling applied due to frequent requests
500 (Generic Error)	Unexpected error on the Expensify API server.
	This is a generic error code for internal server issues. Consult Expensify support for further investigation in case of a 500 error.

","_postman_id":"06212c8f-fc3c-48f6-80c1-566589dbb135"},{"name":"GLOSSARY","item":[],"id":"8593d4fe-b3a6-489f-9774-d600e2b2bdef","description":"

Expensify Postman Collection Glossary

This table defines key terms you will encounter throughout the Expensify API and this Postman collection.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Term	Definition	Usage in Expensify Collection
API (Application Programming Interface)	A set of commands, functions, protocols, and objects that expose functionalities of an application or service to software developers.	This collection uses the Expensify API to interact with data and functionalities.
Authentication	The process of verifying a user's identity to grant access to a system or resource.	The collection uses API credentials (partnerUserID and partnerUserSecret) for authentication within your Postman requests.
Authorization	The process of determining what actions a user is allowed to perform after successful authentication.	Expensify API controls access based on the permissions associated with your credentials.
Collection (Postman)	A group of related API requests organized together within Postman.	This collection contains requests for various Expensify API functionalities (specific functionalities to be listed based on the collection's purpose).
Endpoint	A specific URL that represents a resource or functionality within the Expensify API.	You'll use different endpoints for various actions like downloading reports (specific endpoints with brief descriptions can be listed).
Environment (Postman)	A set of key-value pairs that represent environment variables.	You can use environments to store reusable values like API credentials or base URLs (specific use cases for environments within the collection can be mentioned).
Error Code	A numeric code included in the API response that indicates whether the request was successful (e.g., 200 OK) or encountered an error (e.g., 404 Not Found).	This collection likely includes descriptions for common Expensify API error codes.
FTL	FreeMarker Template Language	Expensify supports FTL for generating custom report outputs,
POST (HTTP Method)	An HTTP method used to send data to a server to create or update resources.	The collection uses POST requests for actions that modify data, such as creating reports or updating their status.
JSON (JavaScript Object Notation)	A lightweight data interchange format commonly used to represent structured data in API requests and responses.	Expensify uses JSON for data exchange in requests and responses.
OAuth	An authorization framework that allows users to grant third-party applications access to their accounts without sharing their credentials directly.
Partner User ID & Partner User Secret	The API credentials you generate from your Expensify account to access the Expensify API. These are required for authentication in your Postman requests.
Postman	A popular application for building, testing, and managing API requests.	This Expensify collection is designed to be used within Postman.
Query Parameter	Key-value pairs appended to the URL of an API request to filter or modify its behavior.	Expensify might use query parameters for filtering reports based on dates or other criteria (specific examples can be listed).
Request	An HTTP message sent to a server to initiate communication and request a specific action or data.	This collection consists of various POST requests tailored for interacting with the Expensify API.
Response	The HTTP message sent back by the server in response to a request. It contains data or a status code indicating the outcome of the request.
Resource	An entity or piece of data managed by the Expensify API, such as reports, users, or expense categories.	The collection interacts with various Expensify resources (specific resources the collection interacts with can be listed).
REST (Representational State Transfer)	An architectural style for designing APIs that emphasizes using a standardized set of HTTP methods (GET, POST, PUT, DELETE) to interact with resources.	Expensify utilizes a RESTful API.

","_postman_id":"8593d4fe-b3a6-489f-9774-d600e2b2bdef"}]}

requestJobDescription format

Template parameter

Update tags

Tag levels dependency

Passing tag data in JSON (independent levels only)

Passing tag data from plain text as additional request parameters (dependent or independent tag levels)

`requestJobDescription` format