Ticket
A receipt [Ticket
] is an expense items that contains information about cost incurred by an employee and collected in an expense report.
Review the Usage Guidelines for the Ticket
object.
— |
XML |
SOAP |
REST |
Database table |
---|---|---|---|---|
Object |
|
|
|
|
Supported Commands |
— |
— |
The Ticket
object has the following standard properties:
Ticket
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 receipt. See Date Fields |
|
|
|
The attachments associated with this expense report. Array (REST) or comma-delimited list (SOAP, XML) of internal IDs for attachment objects. |
|
— |
— |
The internal ID of the associated category. |
|
|
|
The city or location where the cost was incurred. |
|
|
|
The cost per unit of measure. Dated by the date field. |
|
|
|
The internal ID of the cost center associated with the receipt. |
|
|
|
[Read-only] The date the receipt was created. See Date Fields |
|
|
|
The currency for monetary values in the receipt record. Three-letter currency code. |
|
|
|
The cost per unit of measure in the selected foreign currency, if this is a foreign currency receipt. |
|
|
|
A 1/0 field indicating if the record is within the specified foreign currency tolerance. |
|
|
|
[Read-only] The foreign currency conversion rate, if this is a foreign currency receipt. |
|
|
|
The foreign currency, if this is a foreign currency receipt. Three-letter currency code. |
|
|
|
The tax paid in the foreign currency, if this is a foreign currency receipt. |
|
|
|
The internal ID of the customer associated with the receipt. Required if the Require a customer selection on receipts box is checked in the Expenses application settings in OpenAir (Administration > Application Settings > Expenses > Other Settings). |
|
|
|
[Required] The date of the receipt. See Date Fields |
|
|
|
The description of the receipt. |
|
|
|
[Required] The internal ID of the expense report associated with the receipt. |
|
|
|
The unique external ID of the receipt, if the record was imported from an external system. |
— |
|
— |
The total federal tax for the receipt. |
— |
|
— |
The federal tax rate for the receipt. |
— |
|
— |
The total GST tax for the receipt. |
— |
|
— |
The GST tax rate for the receipt. |
— |
|
— |
The total HST tax for the receipt. |
— |
|
— |
The HST tax rate for the receipt. |
|
|
|
[Read-only] The unique internal identifier of the receipt. Assigned by OpenAir. |
– See |
|
– See |
A 1/0 field indicating if the receipt is reimbursable. |
— |
|
— |
A 1/0 field indicating if the cost includes the tax. |
|
|
|
The internal ID of the item associated with the receipt. The type of item can be used to determine the receipt subtype. |
|
|
|
A 1/0 field indicating if the paper receipt is missing for this receipt. |
|
|
|
A 1/0 field indicating if the receipt is not billable. |
|
|
|
Notes about the receipt. |
|
|
|
The internal ID of the payment type associated with the receipt. The payment type indicates how the payment was made and may determine if the receipt is reimbursable. Can be derived automatically from |
|
— |
|
[Deprecated] The payment method. Used for backward compatibility only. Use |
|
|
|
The internal ID of the project task associated with the receipt. Requires an option to be enabled in OpenAir (Administration > Application Settings > Expenses > Other settings). |
|
|
|
The internal ID of the project associated with the receipt. Required if the Require a customer selection on receipts box is checked in the Expenses application settings in OpenAir (Administration > Application Settings > Expenses > Other Settings). |
|
— |
|
The international ID of project task type of the associated project task. Requires an option to be enabled in OpenAir (Administration > Application Settings > Expenses > Other settings). Automatically set to an empty value if |
— |
|
— |
The total PST tax for the receipt. |
— |
|
— |
The PST tax rate for the receipt. |
|
|
|
The quantity (number of units of measure). |
|
|
|
The unique reference number of the receipt within the associated expense report. This attribute is used to cross-reference digital receipts with paper receipts. |
|
|
|
[Read-only] The internal ID of the charge (slip) associated with the receipt, if the expense was billed. |
— |
|
— |
The total state tax for the receipt. |
— |
|
— |
The state tax rate for the receipt. |
|
See |
|
The status of the ticket:
Can be derived automatically from |
|
|
— |
The internal ID of the tax location associated with the receipt. |
|
— |
— |
The name of the tax location associated with the receipt. |
|
— |
|
The internal ID of the associated tax rate. |
|
— |
|
Used by thin clients to reconcile imported records. |
|
|
|
The total value of the receipt. Dated by the |
|
|
— |
The total value of the receipt excluding tax. Dated by the |
|
|
|
The total tax paid. Dated by the |
|
— |
|
The unit of measure. |
|
|
|
[Read-only] The date the receipt was last updated or modified. See Date Fields |
|
— |
— |
[Read-only] A 1/0 field indicating whether |
|
|
|
The internal ID of the employee associated with the receipt. |
|
|
|
The internal ID of the employee location associated with the receipt. |
— |
|
The internal ID of the vehicle associated with the receipt. |
The internal ID of the vehicle associated with the receipt. |
|
|
|
The internal ID of the vendor associated with the receipt. |
Usage Guidelines
Review the following guidelines:
-
The Require a task selection on receipts application setting (Administration > Application Settings > Expenses > Other settings) is not supported. The API lets you add or modify receipts without an associated task (
project_taskid
) even if a task is required on receipts in the OpenAir UI. -
You cannot modify a receipt [
Ticket
] if the authenticated user cannot modify the associated expense report [Envelope
], or if the Signers feature is enabled and the receipt [Ticket
] has been accepted (signed off). -
The following account configuration settings may impact the ability to add or modify
ticket
records using the API. To enable or disable any of these configuration settings, contact OpenAir Customer Support. See Creating a Support Case.-
Do not allow editing of receipts with an American Express transaction number — When this option is enabled, you cannot modify the fields
date
,quantity
,cost
,currency
,payment_typeid
, ortotal
for any tickets created using the American Express receipt import wizard. If editing is necessary, you can request for the switch to be temporarily disabled. -
Do not allow receipt quantity to be set to zero using API — By default, the API allows you to add or modify a ticket and set
quantity
to zero. If the switch is enabled, you cannot add or modify a ticket and setquantity
to zero and the API returns an error (1412 Invalid quantity: Quantity must be non-zero number). -
Allow the adjustment of the receipt total instead of total always being a calculated based on quantity and cost — When enabled, you can set a
total
value and thistotal
value will be saved as is. By default thetotal
value is calculated and cannot be modified.
-