Envelope
An expense report [Envelope
] is a collection of expense items (receipts) that employees can use in OpenAir to claim reimbursement.
Review the Usage Guidelines for the Envelope
object.
— |
XML |
SOAP |
REST |
Database table |
---|---|---|---|---|
Object |
|
|
|
|
Supported Commands |
|
|
— |
The Envelope
object has the following standard properties:
Envelope
object properties may also include custom fields. The object type supports the custom equal to
read method and the enable_custom
read attribute.
XML / SOAP |
REST |
Database |
Description |
---|---|---|---|
|
|
|
The accounting period date of the expense report. |
|
|
|
The amount of any cash advance on the expense report. |
|
|
|
[Read-only] The date the expense report was approved. See Date Fields |
|
— |
|
The internal ID of the employee who approved the expense report. |
|
|
|
[Read-only] The attachments associated with this expense report. Comma-separated list (SOAP, XML) or array (REST) of internal IDs for attachment objects. |
|
|
|
The outstanding balance on the expense report. |
|
|
|
[Read-only] The date the expense report was created. See Date Fields |
|
|
|
The currency for monetary values in the expense report. Three-letter currency code. |
|
|
|
A 1/0 field indicating if the record is within the specified foreign currency tolerance as defined in database data definitions. |
|
|
|
The internal ID of the associated customer. |
|
|
|
[Required] The date of the expense report. See Date Fields |
|
|
|
The ending date of the expense report (only used with auto-naming). See Date Fields |
|
|
|
The starting date of the expense report (only used with auto-naming). See Date Fields |
— |
|
|
The description of the expense report. This can hold the reason for the trip, for example. |
— |
|
|
The date and time the record was marked as "exported". See Date Fields |
|
|
|
The unique external ID of the expense report, if the record was imported from an external system. |
|
|
|
[Read-only] The unique internal identifier of the expense report. Automatically assigned by OpenAir. |
— |
|
|
[Read-only] A 1/0 field indicating if an envelope was submitted to an accounting partner. |
— |
|
|
[Read-only] A 1/0 field indicating if the expense report is an adjusting expense report. |
|
— |
|
[Read-only] A 1/0 field indicating if the expense report overlaps with another expense report. |
|
|
|
[Required] The name of the expense report. Required unless your company's account is configured to set the |
|
|
|
Notes about the expense report. |
|
|
|
The expense report tracking number. A value is automatically assigned if not set when adding ab object. |
|
|
|
The internal ID of the associated project. |
|
|
|
The status of the expense report. Defaults to Possible values:
|
|
|
|
[Read-only] The date the expense report was submitted. See Date Fields |
|
|
|
Default tax location for this expense report. |
|
— |
|
Used by thin clients to reconcile imported records. |
|
|
|
The total value of all the receipts in the expense report. |
|
|
|
[Read-only] The total amount of reimbursable expenses in the expense report. |
|
|
|
[Read-only] total number of receipts in the expense report. |
|
— |
|
The reason for the trip. |
|
|
|
[Read-only] The date the expense report was last updated or modified. See Date Fields |
|
|
|
The internal ID of the associated employee. Defaults to the authenticated user if not set when adding an object. |
Usage Guidelines
Review the following guidelines:
-
Your company's OpenAir account can be configured to allow using the API to modify approved expense reports. To enable the feature, contact OpenAir Customer Support.
-
The tracking number [
number
] must be unique for each object. When adding or modifying an object, if you setnumber
make sure the value is unique. -
If your company's OpenAir account is configured to name expense reports automatically, and no valid
date_start
value is set,date_start
anddate_end
are set automatically. -
Depending on your account configuration:
-
Modifying or deleting expense reports associated to a user other than the authenticated user unless the authenticated user is an account administrator.
-
Account administrators may not delete open and submitted expense reports associated to another user.
-
-
If your company's account configuration supports the unapprove operation, expense reports cannot be unapproved if there are any reimbursements associated wit the expense report, or, depending on your company's account configuration if the expense report was exported.
-
You cannot delete an
Envelope
object if this object is referenced by an object of any of the following type. Delete any dependent objects first before you delete anEnvelope
object.