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	`Ticket`	`oaTicket`	`Receipt`	`ticket`
Supported Commands	`Add`, `Read`, `Modify`, `Delete`, `Reject`	`add()`, `read()`, `modify()`, `upsert()`, `delete()`, `reject()`	—	—

—

XML

SOAP

REST

Database table

Object

Ticket

oaTicket

Receipt

ticket

Supported Commands

Add, Read, Modify, Delete, Reject

add(), read(), modify(), upsert(), delete(), reject()

—

The Ticket object has the following standard properties:

Note:

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
`acct_date`	`accountingDate`	`acct_date`	The accounting period date of the receipt. See Date Fields
`attachmentid`	`attachments`	`attachmentid`	The attachments associated with this expense report. Array (REST) or comma-delimited list (SOAP, XML) of internal IDs for attachment objects.
`categoryid`	—	—	The internal ID of the associated category.
`city`	`receiptLocation`	`city`	The city or location where the cost was incurred.
`cost`	`costPerUnit`	`cost`	The cost per unit of measure. Dated by the date field.
`cost_centerid`	`costCenterId`	`cost_centerid`	The internal ID of the cost center associated with the receipt.
`created`	`created`	`created`	[Read-only] The date the receipt was created. See Date Fields
`currency`	`currency`	`currency`	The currency for monetary values in the receipt record. Three-letter currency code.
`currency_cost`	`foreignCurrencyCost`	`currency_cost`	The cost per unit of measure in the selected foreign currency, if this is a foreign currency receipt.
`currency_exchange_intolerance`	`isForeignCurrencyExchangeIntolerance`	`currency_exchange_intolerance`	A 1/0 field indicating if the record is within the specified foreign currency tolerance.
`currency_rate`	`foreignCurrencyRate`	`currency_rate`	[Read-only] The foreign currency conversion rate, if this is a foreign currency receipt.
`currency_symbol`	`foreignCurrencySymbol`	`currency_symbol`	The foreign currency, if this is a foreign currency receipt. Three-letter currency code.
`currency_total_tax_paid`	`foreignCurrencyTotalTaxPaid`	`currency_total_tax_paid`	The tax paid in the foreign currency, if this is a foreign currency receipt.
`customerid`	`customerId`	`customerid`	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 SuiteProjects Pro (Administration > Application Settings > Expenses > Other Settings).
`date`	`date`	`date`	[Required] The date of the receipt. See Date Fields
`description`	`description`	`description`	The description of the receipt.
`envelopeid`	`expenseReportId`	`envelopeid`	[Required] The internal ID of the expense report associated with the receipt.
`externalid`	`externalId`	`externalid`	The unique external ID of the receipt, if the record was imported from an external system.
—	`federalTax`	—	The total federal tax for the receipt.
—	`federalTaxRate`	—	The federal tax rate for the receipt.
—	`gst`	—	The total GST tax for the receipt.
—	`gstRate`	—	The GST tax rate for the receipt.
—	`hst`	—	The total HST tax for the receipt.
—	`hstRate`	—	The HST tax rate for the receipt.
`id`	`id`	`id`	[Read-only] The unique internal identifier of the receipt. Assigned by SuiteProjects Pro.
– See `status`–	`isReimbursable`	– See `status`–	A 1/0 field indicating if the receipt is reimbursable.
—	`isTaxIncludedInCost`	—	A 1/0 field indicating if the cost includes the tax.
`itemid`	`itemId`	`itemid`	The internal ID of the item associated with the receipt. The type of item can be used to determine the receipt subtype.
`missing_receipt`	`isMissingPaperReceipt`	`missing_receipt`	A 1/0 field indicating if the paper receipt is missing for this receipt.
`non_billable`	`isNonBillable`	`non_billable`	A 1/0 field indicating if the receipt is not billable.
`notes`	`notes`	`notes`	Notes about the receipt.
`payment_typeid`	`paymentTypeId`	`payment_typeid`	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 `paymethod`.
`paymethod`	—	`payment_method`	[Deprecated] The payment method. Used for backward compatibility only. Use `payment_typeid` instead. Can be derived automatically from `payment_typeid`. See Paymenttype.
`project_taskid`	`projectTaskId`	`project_taskid`	The internal ID of the project task associated with the receipt. Requires an option to be enabled in SuiteProjects Pro (Administration > Application Settings > Expenses > Other settings).
`projectid`	`projectId`	`projectid`	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 SuiteProjects Pro (Administration > Application Settings > Expenses > Other Settings).
`projecttask_typeid`	—	`projecttask_typeid`	The international ID of project task type of the associated project task. Requires an option to be enabled in SuiteProjects Pro (Administration > Application Settings > Expenses > Other settings). Automatically set to an empty value if `project_taskid` is set to an empty value.
—	`pst`	—	The total PST tax for the receipt.
—	`pstRate`	—	The PST tax rate for the receipt.
`quantity`	`quantity`	`quantity`	The quantity (number of units of measure).
`reference_number`	`trackingNumber`	`reference_number`	The unique reference number of the receipt within the associated expense report. This attribute is used to cross-reference digital receipts with paper receipts.
`slipid`	`slipId`	`slipid`	[Read-only] The internal ID of the charge (slip) associated with the receipt, if the expense was billed.
—	`stateTax`	—	The total state tax for the receipt.
—	`stateTaxRate`	—	The state tax rate for the receipt.
`status`	See `isReimbursable`	`status`	The status of the ticket: R – reimbursable N – non-reimbursable Can be derived automatically from `payment_typeid`.
`tax_location_id`	`taxLocationId`	—	The internal ID of the tax location associated with the receipt.
`tax_location_name`	—	—	The name of the tax location associated with the receipt.
`tax_rateid`	—	`tax_rateid`	The internal ID of the associated tax rate.
`thin_client_id`	—	`thin_client_id`	Used by thin clients to reconcile imported records.
`total`	`total`	`total`	The total value of the receipt. Dated by the `date` field.
`total_no_tax`	`totalNoTax`	—	The total value of the receipt excluding tax. Dated by the `date` field.
`total_tax_paid`	`totalTaxPaid`	`total_tax_paid`	The total tax paid. Dated by the `date` field.
`unitm`	—	`um`	The unit of measure.
`updated`	`updated`	`updated`	[Read-only] The date the receipt was last updated or modified. See Date Fields
`use_server_currency_rate`	—	—	[Read-only] A 1/0 field indicating whether `currency_rate` should be set to the foreign currency conversion rate for the company's SuiteProjects Pro account even if a `currency_rate` value is specified for the receipt. Always `1`.
`userid`	`userId`	`userid`	The internal ID of the employee associated with the receipt.
`user_locationid`	`userLocationId`	`user_locationid`	The internal ID of the employee location associated with the receipt.
—	`vehicleId`	The internal ID of the vehicle associated with the receipt.	The internal ID of the vehicle associated with the receipt.
`vendorid`	`vendorId`	`vendorid`	The internal ID of the vendor associated with the receipt.

XML/SOAP

REST

Database

Description

acct_date

accountingDate

acct_date

The accounting period date of the receipt.

See Date Fields

attachmentid

attachments

attachmentid

The attachments associated with this expense report. Array (REST) or comma-delimited list (SOAP, XML) of internal IDs for attachment objects.

categoryid

—

The internal ID of the associated category.

city

receiptLocation

city

The city or location where the cost was incurred.

cost

costPerUnit

cost

The cost per unit of measure. Dated by the date field.

cost_centerid

costCenterId

cost_centerid

The internal ID of the cost center associated with the receipt.

created

[Read-only] The date the receipt was created.

See Date Fields

currency

The currency for monetary values in the receipt record. Three-letter currency code.

currency_cost

foreignCurrencyCost

currency_cost

The cost per unit of measure in the selected foreign currency, if this is a foreign currency receipt.

currency_exchange_intolerance

isForeignCurrencyExchangeIntolerance

currency_exchange_intolerance

A 1/0 field indicating if the record is within the specified foreign currency tolerance.

currency_rate

foreignCurrencyRate

currency_rate

[Read-only] The foreign currency conversion rate, if this is a foreign currency receipt.

currency_symbol

foreignCurrencySymbol

currency_symbol

The foreign currency, if this is a foreign currency receipt. Three-letter currency code.

currency_total_tax_paid

foreignCurrencyTotalTaxPaid

currency_total_tax_paid

The tax paid in the foreign currency, if this is a foreign currency receipt.

customerid

customerId

customerid

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 SuiteProjects Pro (Administration > Application Settings > Expenses > Other Settings).

date

[Required] The date of the receipt.

See Date Fields

description

The description of the receipt.

envelopeid

expenseReportId

envelopeid

[Required] The internal ID of the expense report associated with the receipt.

externalid

externalId

externalid

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

—

federalTax

—

The total federal tax for the receipt.

—

federalTaxRate

—

The federal tax rate for the receipt.

—

gst

—

The total GST tax for the receipt.

—

gstRate

—

The GST tax rate for the receipt.

—

hst

—

The total HST tax for the receipt.

—

hstRate

—

The HST tax rate for the receipt.

id

[Read-only] The unique internal identifier of the receipt. Assigned by SuiteProjects Pro.

– See status–

isReimbursable

– See status–

A 1/0 field indicating if the receipt is reimbursable.

—

isTaxIncludedInCost

—

A 1/0 field indicating if the cost includes the tax.

itemid

itemId

itemid

The internal ID of the item associated with the receipt. The type of item can be used to determine the receipt subtype.

missing_receipt

isMissingPaperReceipt

missing_receipt

A 1/0 field indicating if the paper receipt is missing for this receipt.

non_billable

isNonBillable

non_billable

A 1/0 field indicating if the receipt is not billable.

notes

Notes about the receipt.

payment_typeid

paymentTypeId

payment_typeid

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 paymethod.

paymethod

—

payment_method

[Deprecated] The payment method. Used for backward compatibility only. Use payment_typeid instead. Can be derived automatically from payment_typeid. See Paymenttype.

project_taskid

projectTaskId

project_taskid

The internal ID of the project task associated with the receipt. Requires an option to be enabled in SuiteProjects Pro (Administration > Application Settings > Expenses > Other settings).

projectid

projectId

projectid

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 SuiteProjects Pro (Administration > Application Settings > Expenses > Other Settings).

projecttask_typeid

—

projecttask_typeid

The international ID of project task type of the associated project task. Requires an option to be enabled in SuiteProjects Pro (Administration > Application Settings > Expenses > Other settings). Automatically set to an empty value if project_taskid is set to an empty value.

—

pst

—

The total PST tax for the receipt.

—

pstRate

—

The PST tax rate for the receipt.

quantity

The quantity (number of units of measure).

reference_number

trackingNumber

reference_number

The unique reference number of the receipt within the associated expense report. This attribute is used to cross-reference digital receipts with paper receipts.

slipid

slipId

slipid

[Read-only] The internal ID of the charge (slip) associated with the receipt, if the expense was billed.

—

stateTax

—

The total state tax for the receipt.

—

stateTaxRate

—

The state tax rate for the receipt.

status

See isReimbursable

status

The status of the ticket:

R – reimbursable
N – non-reimbursable

Can be derived automatically from payment_typeid.

tax_location_id

taxLocationId

—

The internal ID of the tax location associated with the receipt.

tax_location_name

—

The name of the tax location associated with the receipt.

tax_rateid

—

tax_rateid

The internal ID of the associated tax rate.

thin_client_id

—

thin_client_id

Used by thin clients to reconcile imported records.

total

The total value of the receipt. Dated by the date field.

total_no_tax

totalNoTax

—

The total value of the receipt excluding tax. Dated by the date field.

total_tax_paid

totalTaxPaid

total_tax_paid

The total tax paid. Dated by the date field.

unitm

—

um

The unit of measure.

updated

[Read-only] The date the receipt was last updated or modified.

See Date Fields

use_server_currency_rate

—

[Read-only] A 1/0 field indicating whether currency_rate should be set to the foreign currency conversion rate for the company's SuiteProjects Pro account even if a currency_rate value is specified for the receipt. Always 1.

userid

userId

userid

The internal ID of the employee associated with the receipt.

user_locationid

userLocationId

user_locationid

The internal ID of the employee location associated with the receipt.

—

vehicleId

The internal ID of the vehicle associated with the receipt.

vendorid

vendorId

vendorid

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 SuiteProjects Pro 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 SuiteProjects Pro 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, or total 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 set quantity 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 this total value will be saved as is. By default the total value is calculated and cannot be modified.