Expense Reports

Expense reports are collections of expense items (receipts) that employees can use in SuiteProjects Pro to claim reimbursement.

Available methods

POST /expense-reports/ — Insert an Expense Report
POST /expense-reports/overlapping/ — Insert an Overlapping Expense Report (Overlapping expense reports are expense reports submitted for overlapping periods).
GET /expense-reports/ — Get the List of Expense Reports
GET /expense-reports/{id} — Get an Expense Report
PUT /expense-reports/{id} — Update an Expense Report
DELETE /expense-reports/{id} — Delete an Expense Report
GET /expense-reports/{id}/receipts — Get the List of Receipts in an Expense Report
GET /expense-reports/{id}/receipts/{ticket_id} — Get a Receipt associated with an Expense Report
POST /expense-reports/{id}/attachments — Add an Attachment to an Expense Report
GET /expense-reports/{id}/attachments — Get the List of Attachments Associated with an Expense Report
GET /expense-reports/{id}/attachments/{attachment_id} — Get an Attachment Associated with an Expense Report
GET /expense-reports/{id}/attachments/{attachment_id}/download — Get an Attachment File Associated with an Expense Report
GET /expense-reports/{id}/attachments/{attachment_id}/thumbnail — Get the Thumbnail for an Attachment Associated with an Expense Report
PUT /expense-reports/{id}/attachments/{attachment_id} — Replace an Attachment to an Expense Report
DELETE /expense-reports/{id}/attachments/{attachment_id} — Delete an Attachment Associated with an Expense Report
DELETE /expense-reports/{id}/attachments/{attachment_ids} — Delete Attachments Associated with an Expense Report
OPTIONS /expense-reports/ — Discover Available Methods and Fetch the Endpoint Reference for Expense Reports

ExpenseReport object properties

An expense report is a collection of expense items (receipts) that employees can use in SuiteProjects Pro to claim reimbursement.

The ExpenseReport object has the following properties:

Property	Description	Type	Read-only	Query allowed	Sorting allowed
`accountingDate`	The accounting period date of the expense report.	string($date)	—	Yes	Yes
`advance`	The amount of any cash advance on the expense report.	number($float)	—	Yes	—
`approveDate`	The date the expense report was approved.	string($date)	Yes	Yes	—
`attachments`	The attachments associated with this expense report. Array of internal IDs for attachment objects.	Array of `{”id”: <integerValue>}` objects.	Yes	—	—
`balance`	The outstanding balance on the expense report.	number($float)	—	Yes	—
`created`	The date the expense report was created.	string($date-time)	Yes	Yes	—
`currency`	The currency for monetary values in the expense report. Three-letter currency code.	string	—	Yes	—
`customerId`	The internal ID of the associated customer.	integer$(int64)	—	Yes	Yes
`date`	The date of the expense report.	string($date)	—	Yes	Yes
`description`	The description of the expense report (for example, reason for the trip).	string	—	Yes	—
`endDate`	The ending date of the expense report (only used with auto-naming).	string($date)	—	Yes	Yes
`exported`	The date and time the record was marked as "exported".	string($date-time)	—	Yes	—
`externalId`	The unique external ID of the expense report, if the record was imported from an external system.	string	—	Yes	Yes
`id`	The unique internal identifier of the expense report.	integer($int64)	Yes	Yes	Yes
`isAccounting`	A 1/0 field indicating if an envelope was submitted to an accounting partner.	Boolean	Yes	Yes	Yes
`isAdjusting`	A 1/0 field indicating if the expense report is an adjusting expense report.	Boolean	Yes	Yes	—
`isForeignCurrencyExchangeIntolerance`	A 1/0 field indicating if the record is within the specified foreign currency tolerance as defined in database data definitions.	Boolean	Yes	Yes	Yes
`name`	[REQUIRED] The name of the expense report.	string	—	Yes	—
`notes`	Notes about the expense report.	string	—	Yes	—
`projectId`	The internal ID of the associated project.	integer($int64)	—	Yes	Yes
`startDate`	The starting date of the expense report (only used with auto-naming).	string($date)	—	Yes	Yes
`status`	The status of the expense report. Possible values: O — open S — submitted A — approved R — rejected	string	—	Yes	Yes
`submitDate`	The date the expense report was submitted.	string($date)	Yes	Yes	—
`taxLocationId`	Default tax location for this expense report.	integer($int64)	—	Yes	Yes
`total`	The total value of all the receipts in the expense report.	number($float)	—	Yes	—
`totalReceipts`	The total number of receipts in the expense report.	integer($int64)	Yes	Yes	—
`totalReimburse`	The total amount of reimbursable expenses in the expense report.	number($float)	Yes	Yes	—
`trackingNumber`	[REQUIRED] The expense report tracking number.	string	—	Yes	Yes
`updated`	The date the expense report was last updated or modified.	string ($date-time)	Yes	Yes	—
`userId`	The internal ID of the associated employee.	integer($int64)	Yes	Yes	Yes

Property

Description

Type

Read-only

Query allowed

Sorting allowed

accountingDate

The accounting period date of the expense report.

string($date)

—

Yes

advance

The amount of any cash advance on the expense report.

number($float)

—

Yes

—

approveDate

The date the expense report was approved.

string($date)

Yes

—

attachments

The attachments associated with this expense report. Array of internal IDs for attachment objects.

Array of {”id”: <integerValue>} objects.

Yes

—

balance

The outstanding balance on the expense report.

number($float)

—

Yes

—

created

The date the expense report was created.

string($date-time)

Yes

—

currency

The currency for monetary values in the expense report. Three-letter currency code.

string

—

Yes

—

customerId

The internal ID of the associated customer.

integer$(int64)

—

Yes

date

The date of the expense report.

string($date)

—

Yes

description

The description of the expense report (for example, reason for the trip).

string

—

Yes

—

endDate

The ending date of the expense report (only used with auto-naming).

string($date)

—

Yes

exported

The date and time the record was marked as "exported".

string($date-time)

—

Yes

—

externalId

The unique external ID of the expense report, if the record was imported from an external system.

string

—

Yes

id

The unique internal identifier of the expense report.

integer($int64)

Yes

isAccounting

A 1/0 field indicating if an envelope was submitted to an accounting partner.

Boolean

Yes

isAdjusting

A 1/0 field indicating if the expense report is an adjusting expense report.

Boolean

Yes

—

isForeignCurrencyExchangeIntolerance

A 1/0 field indicating if the record is within the specified foreign currency tolerance as defined in database data definitions.

Boolean

Yes

name

[REQUIRED] The name of the expense report.

string

—

Yes

—

notes

Notes about the expense report.

string

—

Yes

—

projectId

The internal ID of the associated project.

integer($int64)

—

Yes

startDate

The starting date of the expense report (only used with auto-naming).

string($date)

—

Yes

status

The status of the expense report. Possible values:

O — open
S — submitted
A — approved
R — rejected

string

—

Yes

submitDate

The date the expense report was submitted.

string($date)

Yes

—

taxLocationId

Default tax location for this expense report.

integer($int64)

—

Yes

total

The total value of all the receipts in the expense report.

number($float)

—

Yes

—

totalReceipts

The total number of receipts in the expense report.

integer($int64)

Yes

—

totalReimburse

The total amount of reimbursable expenses in the expense report.

number($float)

Yes

—

trackingNumber

[REQUIRED] The expense report tracking number.

string

—

Yes

updated

The date the expense report was last updated or modified.

string ($date-time)

Yes

—

userId

The internal ID of the associated employee.

integer($int64)

Yes

Note:

Access to certain object types and object attributes depend on the business logic configured for your SuiteProjects Pro account. It may vary depending on the role and access privileges associated with the access token and with the user who authorized the application.

Required and read-only attributes also depend on the business logic configured for each specific SuiteProjects Pro account. Some fields such as id, created, and updated are system-generated and always read-only.