openapi: 3.0.3 info: title: Expenses description: > Employees create and submit expense reports, consisting of individual line items, to receive reimbursement for approved out-of-pocket costs related to their jobs. version: '1' servers: - url: https://api.intacct.com/ia/api/v1 tags: - name: Electronic receipt lines description: >- Details for an electronic receipt line on an electronic receipt, including individual expenses and their attributes. x-displayName: Electronic receipt lines - name: Electronic receipts description: >- An electronic receipt is a digital version of a receipt that can be used for employee expense reports. Electronic receipts help to streamline the expense reporting process by allowing employees to easily upload and manage receipts. x-displayName: Electronic receipts - name: Employee expense adjustment lines description: >- Expense adjustment lines are individual entries in an employee expense adjustment that represent debits or credits payable to an employee. x-displayName: Employee expense adjustment lines - name: Employee expense adjustments description: >- Expense adjustments provide a way to correct the balance for an employee who is overpaid or underpaid for an expense. x-displayName: Employee expense adjustments - name: Employee expense lines description: >- Details for each expense line on the employee expense report. Employees create and submit expense reports, consisting of individual line items, to receive reimbursement for approved out-of-pocket costs related to their jobs. x-displayName: Employee expense lines - name: Employee expense payment types description: "Employee expense payment types track how expenses are paid. Expense payment types can be created for both non-reimbursable and reimbursable expenses. The most common use case is to create expense payment types for company credit cards or checks for non-reimbursable expenses. \n\nExpense payment types are applied to the line items in an employee expense report or an expense adjustment. \n" x-displayName: Employee expense payment types - name: Employee expense summaries description: >- Expense summaries are collections of the same type of transactions, grouped together for processing. Expense summaries are referenced by [employee expense](/openapi/ee/expenses.employee-expense/tag/Employee-expenses) objects. x-displayName: Employee expense summaries - name: Employee expense types description: "Expense types give recognizable names to GL accounts and are applied to line items in expense reports or expense adjustments. Expense types also act to restrict employee access to GL accounts to those defined in the expense types. \n\nExpense types can be created for expenses such as Mileage, Relocation, Entertainment, and so on. Expense types are the same for all users company wide. Any GL account can be assigned one or more expense types. A specific offsetting account can be assigned to an expense type as well. If no offsetting account is assigned, the default GL Account for Employee Liabilities is used. \n" x-displayName: Employee expense types - name: Employee expenses description: "Expense report header for employee expense lines. Employees create and submit expense reports, consisting of individual line items, to receive reimbursement for approved out-of-pocket costs related to their jobs. \n\nThe employees' managers must then approve the expenses. After approval, the expense reports become reimbursement request candidates for the accounting department to process into pending reimbursements, from which checks are printed.\n" x-displayName: Employee expenses - name: Expense lines to approve description: >- An employee creates and submits an expense report, which is routed to the employee's manager for approval. The individual line items on the expense report can be approved or declined for reimbursement. x-displayName: Expense lines to approve - name: Expenses to approve description: > An employee creates and submits an expense report, which is routed to the employee's manager for approval. In some cases, approvals are required from multiple users. After approval, an expense report becomes a reimbursement request, which is processed by accounting. x-displayName: Expenses to approve - name: Unit rates description: "When an employee enters a quantity for reimbursement, it's multiplied by the unit rate to\nproduce the reimbursement amount. An employee start date determines when the unit rate takes\neffect. \n\nThe rate applies only to the expense line items that have an expense date on or after the start date. See [Field description, Create expense reports](https://www.intacct.com/ia/docs/en_US/help_action/Time_and_Expenses/Employee_expenses/fbf-create-expense-reports.htm) in the Sage Intacct Help Center for more information. \n" x-displayName: Unit rates paths: /objects/expenses/electronic-receipt-line: get: summary: List electronic receipt lines description: >- Returns a collection with a key, ID, and link for each electronic receipt line. tags: - Electronic receipt lines operationId: list-expenses-electronic-receipt-line responses: '200': description: OK content: application/json: schema: type: object description: List of electronic receipt line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of electronic receipt lines: value: ia::result: - key: '100' id: '100' href: /objects/expenses/electronic-receipt-line/100 - key: '101' id: '101' href: /objects/expenses/electronic-receipt-line/101 - key: '102' id: '102' href: /objects/expenses/electronic-receipt-line/102 ia::meta: totalCount: 3 start: 1 pageSize: 5 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/electronic-receipt-line/{key}: parameters: - name: key description: System-assigned key for the electronic receipt line. in: path required: true schema: type: string example: '99' get: summary: Get an electronic receipt line description: Returns detailed information for a specified electronic receipt line. tags: - Electronic receipt lines operationId: get-expenses-electronic-receipt-line-key responses: '200': description: OK content: application/json: schema: type: object description: Details of the electronic receipt line properties: ia::result: $ref: '#/components/schemas/expenses-electronic-receipt-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an electronic receipt line: value: ia::result: key: '312' id: '312' electronic-receipt: id: '136' key: '136' href: /objects/expenses/electronic-receipt/136 glAccount: key: '158' id: '6775.30' name: Travel href: /objects/gl-account/account/158 entryDate: '2025-03-11' paidTo: Stella Johnson paidFor: Hotel stay dimensions: location: key: '1' id: '1' name: USA href: /objects/company-config/location/1 department: key: '1' id: '1' name: IT href: /objects/company-config/department/1 class: key: '731' id: REST_CLS_001 name: Education href: /objects/company-config/class/731 item: key: '13' id: '13' name: Support href: /objects/inventory-control/item/13 employee: key: '10' id: '10' href: /objects/company-config/employee/10 vendor: key: '357' id: '1605212096809' name: Boston Properties href: /objects/accounts-payable/vendor/357 customer: key: '13' id: '113' name: Jack In the Box href: /objects/accounts-payable/customer/13 project: key: '2' id: NET-XML30-2 name: Binford Implementation href: /objects/projects/project/2 task: key: '2' id: tet name: Implementation services href: /objects/projects/task/2 warehouse: key: '6' id: WH01 name: WH01 Name href: /objects/inventory-control/warehouse/6 lineNumber: 1 expenseType: key: Meals id: '6000' state: draft quantity: '5' unitRate: '20' currency: USD txnAmount: '100' href: /objects/expenses/electronic-receipt-line/312 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/electronic-receipt: get: summary: List electronic receipts description: >- Returns a collection with a key, ID, and link for each electronic receipt. tags: - Electronic receipts operationId: list-expenses-electronic-receipt responses: '200': description: OK content: application/json: schema: type: object title: List of electronic receipt objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List electronic receipts: value: ia::result: - key: '84' id: EXP-00001 href: /objects/expenses/electronic-receipt/84 - key: '85' id: EXP-00002 href: /objects/expenses/electronic-receipt/85 - key: '60' id: EXP-00003 href: /objects/expenses/electronic-receipt/60 ia::meta: totalCount: 3 start: 1 pageSize: 5 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an electronic receipt description: "Creates a new electronic receipt. Specify a unique electronic receipt ID when creating an electronic receipt unless document sequencing is configured. If document sequencing is configured, then the ID is auto-generated. " tags: - Electronic receipts operationId: post-expenses-electronic-receipt requestBody: description: Creates an electronic receipt required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/expenses-electronic-receipt' - $ref: '#/components/schemas/electronic-receiptRequiredProperties' examples: Create an electronic receipt: value: state: draft receiptNumber: EXP-00001 employee: key: '10' createdDate: '2021-03-11' description: Travel expense memo: Paid to employee lines: - glAccount: id: '6775.30' paidTo: Stella Johnson paidFor: Hotel stay quantity: '10' unitRate: '20' currency: INR txnAmount: '100' dimensions: location: id: '1' department: id: '1' class: id: REST_CLS_001 item: id: Case 13 employee: key: '10' vendor: id: '1605212096809' customer: id: '113' project: id: NET-XML30-2 warehouse: id: WH01 task: id: tet responses: '201': description: Created content: application/json: schema: type: object title: New electronic receipt properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new electronic receipt: value: ia::result: key: '124' id: '124' href: /objects/expenses/electronic-receipt/124 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/electronic-receipt/{key}: parameters: - name: key description: System-assigned key for the electronic-receipt. in: path required: true schema: type: string example: '99' get: summary: Get an electronic receipt description: Returns detailed information for a specified electronic receipt. tags: - Electronic receipts operationId: get-expenses-electronic-receipt-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the electronic receipt properties: ia::result: $ref: '#/components/schemas/expenses-electronic-receipt' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an electronic receipt: value: ia::result: receiptNumber: ER-0152 employee: id: EMP8 key: '10' href: /objects/company-config/employee/10 employeeContact: key: '977' id: Thomas, Glenn firstName: Glenn lastName: Thomas href: /objects/company-config/employee/10 key: '124' id: '124' createdDate: '2021-03-11' state: draft totalAmount: '1000' currency: USD baseCurrency: USD baseAmount: '120' description: Supplies for customer training lines: - key: '288' id: '288' electronicReceipt: id: '124' key: '124' href: /objects/expenses/electronic-receipt/124 quantity: '10' glAccount: key: '158' id: '6775.30' name: Travel href: /objects/general-ledger/account/158 entryDate: '2021-03-11' paidTo: Stella Johnson paidFor: Hotel stay expenseType: key: Meals id: '6000' state: draft unitRate: '100' lineNumber: 1 currency: INR txnAmount: '1000' attachment: key: '1' id: '1' href: /objects/company-config/attachment/12345 dimensions: location: key: '1' id: '1' name: USA href: /objects/company-config/location/1 department: key: '1' id: '1' name: IT href: /objects/company-config/department/1 class: key: '731' id: REST_CLS_001 name: Education href: /objects/company-config/class/731 item: key: '13' id: '13' name: Support href: /objects/inventory-control/item/13 employee: key: '10' id: EMP8 name: Thomas, Glenn href: /objects/company-config/employee/10 vendor: key: '357' id: '1605212096809' name: Boston Properties href: /objects/accounts-payable/vendor/357 customer: key: '13' id: '113' name: Jack In the Box href: /objects/accounts-payable/customer/13 project: key: '2' id: NET-XML30-2 name: Binford Implementation href: /objects/projects/project/2 task: key: '2' id: tet name: Implementation services href: /objects/projects/task/2 warehouse: key: '6' id: WH01 name: WH01 Name href: /objects/inventory-control/warehouse/6 href: /objects/expenses/electronic-receipt-line/288 memo: Covered by customer href: /objects/expenses/electronic-receipt/124 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an electronic receipt description: >- Updates an existing electronic receipt by setting field values. Any fields not provided remain unchanged. tags: - Electronic receipts operationId: patch-expenses-electronic-receipt-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/expenses-electronic-receipt' - type: object properties: createdDate: readOnly: true currency: readOnly: true employee: readOnly: true examples: Updates an electronic receipt: value: memo: Covered by customer responses: '200': description: OK content: application/json: schema: type: object title: Updated electronic receipt properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated electronic receipt: value: ia::result: key: '124' id: '124' href: /objects/expenses/electronic-receipt/124 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an electronic receipt description: Deletes an electronic receipt. tags: - Electronic receipts operationId: delete-expenses-electronic-receipt-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/employee-expense-adjustment-line: get: summary: List employee expense adjustment lines description: >- Returns a collection with a key, ID, and link for each employee expense adjustment line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Employee expense adjustment lines operationId: list-expenses-employee-expense-adjustment-line responses: '200': description: OK content: application/json: schema: type: object description: List of employee expense adjustment line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of employee expense adjustment line objects: value: ia::result: - key: '100' id: '100' href: /objects/expenses/employee-expense-adjustment-line/100 - key: '101' id: '101' href: /objects/expenses/employee-expense-adjustment-line/101 - key: '102' id: '102' href: /objects/expenses/employee-expense-adjustment-line/102 ia::meta: totalCount: 3 start: 1 pageSize: 5 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an employee expense adjustment line description: Creates a new employee expense adjustment line. tags: - Employee expense adjustment lines operationId: create-expenses-employee-expense-adjustment-line requestBody: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/expenses-employee-expense-adjustment-line' examples: Creates an employee expense adjustment line: value: account: id: '6775.3' paidTo: Hotel Westin paidFor: Not used isBillable: false form1099: isForm1099: 'true' type: MISC box: '3' paymentType: key: '1' name: Non-reimburse isNonreimbursable: false quantity: '10' unitrate: '20' txnCurrency: INR txnAmount: '100' transactionToReimburseConversion: exchangeRateDate: '2025-03-11' exchangeRateTypeId: Intacct Daily Rate dimensions: location: id: '1' department: id: '1' class: id: REST_CLS_001 item: id: Case 13 employee: id: '10' vendor: id: '1605212096809' customer: id: '113' project: id: NET-XML30-2 warehouse: id: WH01 task: id: tet responses: '201': description: Created content: application/json: schema: type: object title: Reference to new employee expense adjustment line properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new employee expense adjustment line: value: ia::result: key: '124' id: '124' href: /objects/expenses/employee-expense-adjustment-line/124 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/employee-expense-adjustment-line/{key}: parameters: - name: key description: System-assigned key for the employee expense adjustment line. in: path required: true schema: type: string example: '99' get: summary: Get an employee expense adjustment line description: >- Returns detailed information for a specified employee expense adjustment line. tags: - Employee expense adjustment lines operationId: get-expenses-employee-expense-adjustment-line-key responses: '200': description: OK content: application/json: schema: type: object description: Details of the employee expense adjustment line properties: ia::result: $ref: '#/components/schemas/expenses-employee-expense-adjustment-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the employee expense adjustment line: value: ia::result: key: '312' id: '312' employee-expense: id: '136' key: '136' href: /objects/expenses/employee-expense/136 glAccount: key: '158' id: '6775.30' name: Travel href: /objects/account/158 entryDate: '2025-03-11' paidTo: Hotel Westin paidFor: Not used reimburseToBase: baseAmount: '1.38' exchangeRateDate: '2025-03-11' exchangeRateTypeId: '-1' exchangeRate: '1.1899' dimensions: location: key: '1' id: '1' name: USA href: /objects/company-config/location/1 department: key: '12' id: '12' name: IT href: /objects/company-config/department/12 class: key: '731' id: REST_CLS_001 name: Enterprises href: /objects/company-config/class/731 item: key: '13' id: Case 13 name: Platform pack href: /objects/inventory-control/item/13 employee: key: '10' id: '10' href: /objects/company-config/employee/10 employeeContact: key: 20 id: Thomas, Glenn firstName: Glenn lastName: Thomas href: /objects/company-config/contact/20 vendor: key: '357' id: '1605212096809' name: GenLab href: /objects/accounts-payable/vendor/357 customer: key: '13' id: '113' name: Jack In the Box href: /objects/accounts-receivable/customer/13 project: key: '2' id: NET-XML30-2 name: Talcomp training href: /objects/projects/project/2 task: key: '2' id: tet name: Design href: /objects/projects/task/2 warehouse: key: '6' id: WH01 name: WH01 href: /objects/inventory-control/warehouse/6 lineNumber: 1 expenseType: key: Meals id: '6000' reimbursement: reimbursementAmount: '1.16' totalSelected: '0' totalPaid: '0' isBillable: false isBilled: false state: approved form1099: isForm1099: 'true' type: MISC box: '3' paymentType: key: '1' name: Non-reimburse isNonreimbursable: false quantity: '5' unitRate: '20' currency: txnCurrency: INR txnAmount: '4444' exchangeRateDate: '2025-03-11' exchangeRateTypeId: '-1' exchangeRate: '65' userExchangeRate: '5' href: /objects/expenses/employee-expense-adjustment-line/312 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an employee expense adjustment line description: >- Updates an existing employee expense adjustment line by setting field values. Any fields not provided remain unchanged. tags: - Employee expense adjustment lines operationId: update-expenses-employee-expense-adjustment-line-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/expenses-employee-expense-adjustment-line' - type: object properties: id: readOnly: true examples: Updates an employee expense adjustment line: value: id: '100' paidTo: Hotel Westin responses: '200': description: OK content: application/json: schema: type: object description: Updated employee expense adjustment line properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated employee expense adjustment line: value: ia::result: key: '124' id: '124' href: /objects/expenses/employee-expense-adjustment-line/124 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an employee expense adjustment line description: Deletes an employee expense adjustment line. tags: - Employee expense adjustment lines operationId: delete-expenses-employee-expense-adjustment-line-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/employee-expense-adjustment: get: summary: List employee expense adjustments description: >- Returns a collection with a key, ID, and link for each employee expense adjustment. tags: - Employee expense adjustments operationId: list-expenses-employee-expense-adjustment responses: '200': description: OK content: application/json: schema: type: object title: List of employee expense adjustment objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: Get list of employee expense adjustments: value: ia::result: - key: '84' id: EXP-00001 href: /objects/expenses/employee-expense-adjustment/84 - key: '85' id: EXP-00002 href: /objects/expenses/employee-expense-adjustment/85 - key: '60' id: EXP-00003 href: /objects/expenses/employee-expense-adjustment/60 ia::meta: totalCount: 3 start: 1 pageSize: 5 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an employee expense adjustment description: >- Creates a new employee expense adjustment. You must specify a unique employee expense ID when creating an employee expense unless document sequencing is configured, in which case the ID is auto-generated. tags: - Employee expense adjustments operationId: create-expenses-employee-expense-adjustment requestBody: description: Creates an employee expense adjustment required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/expenses-employee-expense-adjustment' examples: Reference to new employee expense adjustment: value: state: submitted expenseAdjustmentReportNumber: EXP-00001 employee: id: '10' createdDate: '2025-03-11' expenseSummary: postingDate: '2025-01-31' title: Expenses - Q1 batch state: open preventGLPosting: false basePayment: baseCurrency: USD reimbursement: reimbursementCurrency: EUR description: Travel expense memo: Paid by employee. lines: - paidTo: De Anza Hotel paidFor: Not used isBillable: false form1099: isForm1099: 'true' type: MISC box: '3' paymentType: key: '1' name: Non-reimburse isNonReimbursable: false quantity: '1' unitRate: '20' txnCurrency: INR txnAmount: '100' transactionToReimburseConversion: exchangeRateDate: '2025-03-11' exchangeRateTypeId: Intacct Daily Rate dimensions: location: id: '1' department: id: '1' class: id: REST_CLS_001 item: id: Case 13 employee: id: '10' vendor: id: '1605212096809' customer: id: '113' project: id: NET-XML30-2 warehouse: id: WH01 task: id: tet responses: '201': description: Created content: application/json: schema: type: object title: New employee expense adjustment properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: New employee expense adjustment: value: ia::result: key: '124' id: '124' href: /objects/expenses/employee-expense-adjustment/124 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/employee-expense-adjustment/{key}: parameters: - name: key description: System-assigned key for the employee-expense-adjustment. in: path required: true schema: type: string example: '99' get: summary: Get an employee expense adjustment description: >- Returns detailed information for a specified employee expense adjustment. tags: - Employee expense adjustments operationId: get-expenses-employee-expense-adjustment-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the employee expense adjustment properties: ia::result: $ref: '#/components/schemas/expenses-employee-expense-adjustment' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the employee expense adjustment: value: ia::result: expenseAdjustmentReportNumber: ER-0152 employee: id: '10' key: '10' href: /objects/company-config/employee/10 employeeContact: key: '977' id: Thomas Glenn firstName: Thomas lastName: Glenn href: /objects/company-config/contact/977 key: '124' id: '124' createdDate: '2025-03-11' expenseSummary: postingDate: '2025-01-31' title: Expenses - Q1 batch key: '3' id: '3' href: /objects/expenses/employee-expense-summary/3 basePaymentInformation: totalEntered: '1.38' totalPaid: '0' totalSelected: '0' totalDue: '1.38' baseCurrency: USD state: approved reimbursementInformation: totalEntered: '1.16' totalSelected: '0' totalPaid: '0' totalDue: '1.16' reimbursementCurrency: EUR description: Supplies for customer training nonReimbursable: baseTotalEntered: '0' reimbursementTotalEntered: '0' lines: - key: '288' id: '288' employee-expense: id: '136' key: '136' href: /objects/expenses/employee-expense/136 quantity: '0' glAccount: key: '158' id: '6775.30' name: Travel href: /objects/account/158 entryDate: '2025-03-11' paidTo: Hotel Westin paidFor: Not used baseAmount: '1.38' reimburseToBase: exchangeRateDate: '2025-03-11' exchangeRateTypeId: '-1' exchangeRate: '1.1899' expenseType: key: Hotel id: '5000' reimbursementInformation: reimbursementAmount: '700.16' totalSelected: '0' totalPaid: '0' isBillable: false isBilled: false state: approved form1099: isForm1099: 'true' type: MISC box: '3' paymentType: key: '1' name: Non-reimburse isNonreimbursable: false unitRate: '10' lineNumber: 1 currency: txnCurrency: INR txnAmount: '100' exchangeRateDate: '2025-03-11' exchangeRateTypeId: Intacct Daily Rate exchangeRate: '1' attachment: key: '1' id: '1' dimensions: location: key: '11' id: '1' name: USA href: /objects/company-config/location/11 department: key: '15' id: '1' name: IT href: /objects/company-config/department/15 class: key: '731' id: REST_CLS_001 name: Education href: /objects/company-config/class/731 item: key: '13' id: '13' name: Support href: /objects/inventory-control/item/13 employee: key: '10' id: '10' href: /objects/company-config/employee/10 vendor: key: '357' id: '1605212096809' name: Boston Properties href: /objects/accounts-payable/vendor/357 customer: key: '13' id: '113' name: Jack In the Box href: /objects/accounts-receivable/customer/13 project: key: '2' id: NET-XML30-2 name: Binford Implementation href: /objects/projects/project/2 task: key: '2' id: tet name: Implementation services href: /objects/projects/task/2 warehouse: key: '6' id: WH01 name: WH01 Name href: /objects/inventory-control/warehouse/6 href: '/objects/expenses/employee-expense-adjustment-line/288' memo: Covered by customer entity: key: '46' id: Western Region name: Western Region href: /objects/company-config/entity/46 adjustmentType: debit referenceEmployeeExpense: id: '124' key: '124' href: /objects/expenses/employee-expense/124 href: /objects/expenses/employee-expense-adjustment/124 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an employee expense adjustment description: >- Updates an existing employee expense adjustment by setting field values. Any fields not provided remain unchanged. tags: - Employee expense adjustments operationId: update-expenses-employee-expense-adjustment-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/expenses-employee-expense-adjustment' - type: object properties: id: readOnly: true examples: Updates an employee expense adjustment: value: memo: Covered by customer responses: '200': description: OK content: application/json: schema: type: object title: Updated employee expense adjustment properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Updated employee expense adjustment: value: ia::result: key: '124' id: '124' href: /objects/expenses/employee-expense-adjustment/124 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an employee expense adjustment description: Deletes an employee expense adjustment. tags: - Employee expense adjustments operationId: delete-expenses-employee-expense-adjustment-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/employee-expense-line: get: summary: List employee expense lines description: >- Returns a collection with a key, ID, and link for each employee expense line. tags: - Employee expense lines operationId: list-expenses-employee-expense-line responses: '200': description: OK content: application/json: schema: type: object description: List of employee expense line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List employee expense lines: value: ia::result: - key: '100' id: '100' href: /objects/expenses/employee-expense-line/100 - key: '101' id: '101' href: /objects/expenses/employee-expense-line/101 - key: '102' id: '102' href: /objects/expenses/employee-expense-line/102 ia::meta: totalCount: 3 start: 1 pageSize: 5 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an employee expense line description: Creates a new employee expense line. tags: - Employee expense lines operationId: create-expenses-employee-expense-line requestBody: description: Creates an employee expense line required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/expenses-employee-expense-line' - $ref: '#/components/schemas/expenses-employee-expense-lineRequiredProperties' examples: Create an employee expense line: value: account: id: '6775.3' paidTo: Stella Johnson paidFor: Hotel stay isBillable: false form1099: isForm1099: 'true' type: MISC box: '3' paymentType: key: '1' id: Non-reimburse isNonreimbursable: false quantity: '10' unitrate: '20' txnCurrency: INR txnAmount: '100' transactionToReimburseConversion: exchangeRateDate: '2021-03-11' exchangeRateTypeId: Intacct Daily Rate dimensions: location: id: '1' department: id: '1' class: id: REST_CLS_001 item: id: Case 13 employee: id: '10' vendor: id: '1605212096809' customer: id: '113' project: id: NET-XML30-2 warehouse: id: WH01 task: id: tet responses: '201': description: Created content: application/json: schema: type: object title: New employee expense line properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new employee expense line: value: ia::result: key: '124' id: '124' href: /objects/expenses/employee-expense-line/124 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/employee-expense-line/{key}: parameters: - name: key description: System-assigned key for the employee expense line. in: path required: true schema: type: string example: '99' get: summary: Get an employee expense line description: Returns detailed information for a specified employee expense line. tags: - Employee expense lines operationId: get-expenses-employee-expense-line-key responses: '200': description: OK content: application/json: schema: type: object description: Details of the employee expense line properties: ia::result: $ref: '#/components/schemas/expenses-employee-expense-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an employee expense line: value: ia::result: key: '312' id: '312' employee-expense: id: '136' key: '136' href: /objects/expenses/employee-expense/136 glAccount: key: '158' id: '6775.30' name: Travel href: /objects/account/158 entryDate: '2021-03-11' paidTo: Stella Johnson paidFor: Hotel stay reimburseToBase: baseAmount: '1.38' exchangeRateDate: '2021-03-11' exchangeRateTypeId: '-1' exchangeRate: '1.1899' dimensions: location: key: '1' id: '1' name: USA href: /objects/company-config/location/1 department: key: '1' id: '1' name: IT href: /objects/company-config/department/1 class: key: '731' id: REST_CLS_001 name: Enterprises href: /objects/company-config/class/731 item: key: '13' id: Case 13 name: Platform pack href: /objects/inventory-control/item/13 employee: key: '10' id: '10' name: Thomas, Glenn href: /objects/company-config/employee/10 vendor: key: '357' id: '1605212096809' name: GenLab href: /objects/accounts-payable/vendor/357 customer: key: '13' id: '113' name: Jack In the Box href: /objects/accounts-receivable/customer/13 project: key: '2' id: NET-XML30-2 name: Talcomp training href: /objects/projects/project/2 task: key: '2' id: tet name: Design href: /objects/projects/task/2 warehouse: key: '6' id: WH01 name: WH01 href: /objects/inventory-control/warehouse/6 lineNumber: 1 expenseType: key: Meals id: '6000' reimbursement: reimbursementAmount: '1.16' totalSelected: '0' totalPaid: '0' isBillable: false isBilled: false state: approved form1099: isForm1099: 'true' type: MISC box: '3' paymentType: key: '1' id: Non-reimburse isNonreimbursable: false quantity: '5' unitRate: '20' currency: txnCurrency: INR txnAmount: '4444' exchangeRateDate: '2021-03-11' exchangeRateTypeId: '-1' exchangeRate: '65' userExchangeRate: '5' href: /objects/expenses/employee-expense-line/312 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an employee expense line description: >- Updates an existing employee expense line by setting field values. Any fields not provided remain unchanged. tags: - Employee expense lines operationId: update-expenses-employee-expense-line-key requestBody: content: application/json: schema: $ref: '#/components/schemas/expenses-employee-expense-line' examples: Update an employee expense line: value: paidTo: Travel expense responses: '200': description: OK content: application/json: schema: type: object description: Updated employee expense line properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated employee expense line: value: ia::result: key: '124' id: '124' href: /objects/expenses/employee-expense-line/124 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an employee expense line description: Deletes an employee expense line. tags: - Employee expense lines operationId: delete-expenses-employee-expense-line-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/employee-expense-payment-type: get: summary: List employee expense payment types description: >- Returns a collection with a key, ID, and link for each employee expense payment type. tags: - Employee expense payment types operationId: list-expenses-employee-expense-payment-type responses: '200': description: OK content: application/json: schema: type: object title: List employee expense payment types properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List employee expense payment types: value: ia::result: - key: '100' id: Non-reimburse href: /objects/expenses/employee-expense-payment-type/100 - key: '101' id: Reimburse href: /objects/expenses/employee-expense-payment-type/101 - key: '102' id: Billable href: /objects/expenses/employee-expense-payment-type/102 ia::meta: totalCount: 3 start: 1 pageSize: 5 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an employee expense payment type description: Creates a new employee expense payment type. tags: - Employee expense payment types operationId: create-expenses-employee-expense-payment-type requestBody: description: Creates an employee expense payment type. required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/expenses-employee-expense-payment-type' - $ref: '#/components/schemas/employeeExpensePaymentTypeRequiredProperties' examples: Create an employee expense payment type: value: id: Non Reimburse status: active description: Non reimbursable payment type offsetAccount: id: '2420' responses: '201': description: Created content: application/json: schema: type: object title: New employee expense payment type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new employee expense payment type: value: ia::result: key: '18' id: Non Reimburse href: /objects/expenses/employee-expense-payment-type/12345 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/employee-expense-payment-type/{key}: parameters: - name: key description: System-assigned key for the employee expense payment type. in: path required: true schema: type: string example: '99' get: summary: Get an employee expense payment type description: >- Returns detailed information for a specified employee expense payment type. tags: - Employee expense payment types operationId: get-expenses-employee-expense-payment-type-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the employee expense payment type properties: ia::result: $ref: '#/components/schemas/expenses-employee-expense-payment-type' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an employee expense payment type: value: ia::result: key: '10' id: Non Reimburse description: description isNonReimbursable: true offsetGLAccount: key: '70' id: '2420' name: EE-Office Supplies href: /objects/account/70 status: active audit: createdDateTime: '2021-09-02T08:38:53Z' modifiedDateTime: '2021-09-02T08:38:53Z' createdBy: '1' modifiedBy: '1' entity: key: '46' id: Western Region name: Western Region href: /objects/company-config/entity/46 href: /objects/expenses/employee-expense-payment-type/10 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an employee expense payment type description: >- Updates an existing employee expense payment type by setting field values. Any fields not provided remain unchanged. tags: - Employee expense payment types operationId: update-expenses-employee-expense-payment-type-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/expenses-employee-expense-payment-type' - type: object properties: id: readOnly: true examples: Update an employee expense payment type: value: status: active description: Non reimbursable payment type responses: '200': description: OK content: application/json: schema: type: object title: Updated employee expense payment type properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated employee expense payment type: value: ia::result: key: '10' id: Non Reimburse href: /objects/expenses/employee-expense-payment-type/10 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an employee expense payment type description: Deletes an employee expense payment type. tags: - Employee expense payment types operationId: delete-expenses-employee-expense-payment-type-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/employee-expense-summary: get: summary: List employee expense summaries description: > Returns up to 100 expense summaries from the collection with a key, ID, and link for each summary. This operation is mostly for use in testing; use the query service to find expense summaries that meet certain criteria and to specify the properties that are returned. tags: - Employee expense summaries operationId: list-expenses-employee-expense-summary responses: '200': description: OK content: application/json: schema: type: object description: List of employee expense summary objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List employee expense summaries: value: ia::result: - key: '13' id: '13' href: /objects/expenses/employee-expense-summary/13 - key: '15' id: '15' href: /objects/expenses/employee-expense-summary/15 - key: '16' id: '16' href: /objects/expenses/employee-expense-summary/16 ia::meta: totalCount: 3 start: 1 pageSize: 3 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an employee expense summary description: Creates a new employee expense summary. tags: - Employee expense summaries operationId: create-expenses-employee-expense-summary requestBody: description: Employee expense summary to create required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/expenses-employee-expense-summary' - $ref: '#/components/schemas/expenses-employeeExpenseSummaryRequiredProperties' examples: Create an employee expense summary: value: name: Expenses (USD) Q1 Batch title: Expenses (USD) Q1 Batch postingDate: '2021-01-23' totalAmount: '100' recordType: expense status: active responses: '201': description: Created content: application/json: schema: type: object description: New employee expense summary properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new employee expense summary: value: ia::result: key: '10' id: '10' href: /objects/expenses/employee-expense-summary/10 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/employee-expense-summary/{key}: parameters: - name: key description: System-assigned key for the employee expense summary. in: path required: true schema: type: string example: '99' get: summary: Get an employee expense summary description: Returns detailed information for a specified employee expense summary. tags: - Employee expense summaries operationId: get-expenses-employee-expense-summary-key responses: '200': description: OK content: application/json: schema: type: object description: Details of the employee expense summary properties: ia::result: $ref: '#/components/schemas/expenses-employee-expense-summary' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an employee expense summary: value: ia::result: key: '18' id: '18' title: Expense reports for week 03 postingDate: '2023-01-20' totalAmount: '100' state: open recordType: expense summaryCreationType: manual entity: key: '46' id: Western Region name: Western Region href: /objects/company-config/entity/46 bankAccount: key: '1' id: BOA href: /objects/cash-management/bank-account/1 preventGLPosting: false href: /objects/expenses/employee-expense-summary/18 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an employee expense summary description: >- Updates an existing employee expense summary by setting field values. Any fields not provided remain unchanged. tags: - Employee expense summaries operationId: update-expenses-employee-expense-summary-key requestBody: content: application/json: schema: $ref: '#/components/schemas/expenses-employee-expense-summary' examples: Update an employee expense summary: value: name: Expense report for January responses: '200': description: OK content: application/json: schema: type: object description: Updated employee expense summary properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated employee expense summary: value: ia::result: key: '124' id: '124' href: /objects/expenses/employee-expense-summary/124 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an employee expense summary description: Deletes an employee expense summary. tags: - Employee expense summaries operationId: delete-expenses-employee-expense-summary-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/employee-expense-type: get: summary: List employee expense types description: > Returns up to 100 expense types from the collection with a key, ID, and link for each type. This operation is mostly for use in testing; use the query service to find expense types that meet certain criteria and to specify the properties that are returned. tags: - Employee expense types operationId: list-expenses-employee-expense-type responses: '200': description: OK content: application/json: schema: type: object description: List of employee expense type objects. properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List employee expense types: value: ia::result: - key: '46' id: Travel href: /objects/expenses/employee-expense-type/46 - key: '44' id: Transportation href: /objects/expenses/employee-expense-type/44 - key: '40' id: Compensation href: /objects/expenses/employee-expense-type/40 ia::meta: totalCount: 3 start: 1 pageSize: 5 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an employee expense type description: Creates a new employee expense type. tags: - Employee expense types operationId: create-expenses-employee-expense-type requestBody: description: Creates an employee expense type. required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/expenses-employee-expense-type' - $ref: '#/components/schemas/expenses-employee-expense-typeRequiredProperties' examples: Create an employee expense type: value: id: Travel status: active description: Travel fare unitCurrency: USD glAccount: id: Travel expenses unitRates: - rate: '200' startDate: '2021-01-23' - rate: '100' startDate: '2021-03-23' responses: '201': description: Created content: application/json: schema: type: object description: New employee expense type. properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new employee expense type: value: ia::result: key: '10' id: Travel href: /objects/expenses/employee-expense-type/10 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/employee-expense-type/{key}: parameters: - name: key description: System-assigned key for the employee expense type. in: path required: true schema: type: string example: '99' get: summary: Get an employee expense type description: Returns detailed information for a specified employee expense type. tags: - Employee expense types operationId: get-expenses-employee-expense-type-key responses: '200': description: OK content: application/json: schema: type: object description: Details of the employee expense type. properties: ia::result: $ref: '#/components/schemas/expenses-employee-expense-type' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an employee expense type: value: ia::result: key: '63' audit: createdDateTime: '2023-12-21T08:40:05Z' modifiedDateTime: '2023-12-21T08:47:08Z' createdBy: '1' modifiedBy: '1' id: Travel description: Travel fare glAccount: key: '5500' id: Travel expenses name: Automobile expenses href: /objects/general-ledger/account/5500 status: active offsetGLAccount: key: '6000' id: Offset travel expenses name: Offset automobile expenses href: /objects/general-ledger/account/6000 item: key: '311' id: '10' name: Laptop href: /objects/inventory-control/item/311 form1099: type: W-2G box: '1' unitCurrency: USD unitRates: - id: '28' key: '28' employeeExpenseType: id: '63' key: '63' href: /objects/expenses/employee-expense-type/63 rate: '200' startDate: '2021-01-23' audit: createdDateTime: '2023-12-21T08:47:08Z' modifiedDateTime: '2023-12-21T08:47:08Z' createdBy: '1' modifiedBy: '1' href: /objects/expenses/unit-rate/28 - id: '29' key: '29' employeeExpenseType: id: '63' key: '63' href: /objects/expenses/employee-expense-type/63 rate: '100' startDate: '2021-01-23' audit: createdDateTime: '2023-12-21T08:47:08Z' modifiedDateTime: '2023-12-21T08:47:08Z' createdBy: '1' modifiedBy: '1' href: /objects/expenses/unit-rate/29 entity: key: '46' id: Western Region name: Western Region href: /objects/company-config/entity/46 href: /objects/expenses/employee-expense-type/63 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an employee expense type description: >- Updates an existing employee expense type by setting field values. Any fields not provided remain unchanged. tags: - Employee expense types operationId: update-expenses-employee-expense-type-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/expenses-employee-expense-type' - type: object properties: id: readOnly: true examples: Update an employee expense type: value: description: Personal travel responses: '200': description: OK content: application/json: schema: type: object description: Updated employee expense type. properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated employee expense type: value: ia::result: key: '47' id: Travel href: /objects/expenses/employee-expense-type/124 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an employee expense type description: Deletes an employee expense type. tags: - Employee expense types operationId: delete-expenses-employee-expense-type-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/employee-expense: get: summary: List employee expenses description: > Returns up to 100 employee expense objects from the collection with a key, ID, and link for each expense. This operation is mostly for use in testing; use the query service to find expense objects that meet certain criteria and to specify the properties that are returned. tags: - Employee expenses operationId: list-expenses-employee-expense responses: '200': description: OK content: application/json: schema: type: object title: List of employee expense objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List employee expenses: value: ia::result: - key: '84' id: EXP-00001 href: /objects/expenses/employee-expense/84 - key: '85' id: EXP-00002 href: /objects/expenses/employee-expense/85 - key: '60' id: EXP-00003 href: /objects/expenses/employee-expense/60 ia::meta: totalCount: 3 totalSuccess: 3 totalError: 0 start: 1 pageSize: 5 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] post: summary: Create an employee expense description: >- Creates a new employee expense. You must specify a unique employee expense ID when creating an employee expense unless document sequencing is configured, in which case the ID is auto-generated. tags: - Employee expenses operationId: create-expenses-employee-expense requestBody: description: Creates an employee expense required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/expenses-employee-expense' - $ref: '#/components/schemas/expenses-employee-expenseRequiredProperties' examples: Create an employee expense: value: state: submitted expenseReportNumber: EXP-00001 employee: id: '10' createdDate: '2021-03-11' expenseSummary: postingDate: '2021-01-31' title: Expenses - Q1 batch basePaymentInformation: baseCurrency: USD reimbursementInformation: reimbursementCurrency: EUR description: Travel expense memo: Paid to employee lines: - account: null id: '6775.30' paidTo: paid To paidFor: paid For isBillable: false form1099: isForm1099: 'true' type: MISC box: '3' paymentType: key: '1' name: Non-reimburse isNonreimbursable: false quantity: '10' unitrate: '20' txnCurrency: INR txnAmount: '100' transactionToReimburseConversion: exchangeRateDate: '2021-03-11' exchangeRateTypeId: Intacct Daily Rate dimensions: location: id: '1' department: id: '1' class: id: REST_CLS_001 item: id: Case 13 employee: id: '10' vendor: id: '1605212096809' customer: id: '113' project: id: NET-XML30-2 warehouse: id: WH01 task: id: tet responses: '201': description: Created content: application/json: schema: type: object title: New employee expense properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to new employee expense: value: ia::result: key: '124' id: '124' href: /objects/expenses/employee-expense/124 ia::meta: totalCount: 1 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/employee-expense/{key}: parameters: - name: key description: System-assigned key for the employee-expense. in: path required: true schema: type: string example: '99' get: summary: Get an employee expense description: Returns detailed information for a specified employee expense. tags: - Employee expenses operationId: get-expenses-employee-expense-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the employee expense properties: ia::result: $ref: '#/components/schemas/expenses-employee-expense' ia::meta: $ref: '#/components/schemas/metadata' examples: Get an employee expense: value: ia::result: expenseReportNumber: ER-0152 employee: id: '10' key: '10' href: /objects/company-config/employee/10 employeeContact: key: '977' id: Thomas Glenn firstName: Thomas lastName: Glenn href: /objects/company-config/contact/977 key: '124' id: '124' createdDate: '2021-03-11' expenseSummary: postingDate: '2021-01-31' title: Expenses - Q1 batch key: '3' id: '3' state: open preventGLPosting: false href: /objects/expenses/employee-expense-summary/3 basePaymentInformation: totalEntered: '1.38' totalPaid: '0' totalSelected: '0' totalDue: '1.38' baseCurrency: USD state: approved reimbursementInformation: totalEntered: '1.16' totalSelected: '0' totalPaid: '0' totalDue: '1.16' reimbursementCurrency: EUR description: Supplies for customer training nonReimbursable: baseTotalEntered: '0' reimbursementTotalEntered: '0' lines: - key: '288' id: '288' employee-expense: id: '124' key: '124' href: /objects/expenses/employee-expense/124 quantity: '0' glAccount: key: '158' id: '6775.30' name: Travel href: /objects/account/158 entryDate: '2021-03-11' paidTo: paid To paidFor: paid For baseAmount: '1.38' reimburseToBase: exchangeRateDate: '2021-03-11' exchangeRateTypeId: '-1' exchangeRate: '1.1899' expenseType: key: Meals id: '6000' reimbursementInformation: reimbursementAmount: '1.16' totalSelected: '0' totalPaid: '0' isBillable: false isBilled: false state: approved form1099: isForm1099: 'true' type: MISC box: '3' paymentType: isNonreimbursable: false unitrate: '10' lineNumber: 1 currency: txnCurrency: INR txnAmount: '100' exchangeRateDate: '2021-03-11' exchangeRateTypeId: Intacct Daily Rate exchangeRate: '1' attachment: key: '1' id: '1' dimensions: location: key: '1' id: '1' name: USA href: /objects/company-config/location/1 department: key: '1' id: '1' name: IT href: /objects/company-config/department/1 class: key: '731' id: REST_CLS_001 name: Education href: /objects/company-config/class/731 item: key: '13' id: '13' name: Support href: /objects/inventory-control/item/13 employee: key: '10' id: '10' href: /objects/company-config/employee/10 vendor: key: '357' id: '1605212096809' name: Boston Properties href: /objects/accounts-payable/vendor/357 customer: key: '13' id: '113' name: Jack In the Box href: /objects/accounts-receivable/customer/13 project: key: '2' id: NET-XML30-2 name: Binford Implementation href: /objects/projects/project/2 task: key: '2' id: tet name: Implementation services href: /objects/projects/task/2 warehouse: key: '6' id: WH01 name: WH01 Name href: /objects/inventory-control/warehouse/6 href: /objects/expenses/employee-expense-line/288 memo: Covered by customer entity: key: '46' id: Western Region name: Western Region href: /objects/company-config/entity/46 href: /objects/expenses/employee-expense/124 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] patch: summary: Update an employee expense description: >- Updates an existing employee expense by setting field values. Any fields not provided remain unchanged. tags: - Employee expenses operationId: update-expenses-employee-expense-key requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/expenses-employee-expense' - type: object properties: reimbursement: properties: reimbursementCurrency: readOnly: true examples: Updates an employee expense: value: memo: Covered by customer responses: '200': description: OK content: application/json: schema: type: object title: Updated employee expense properties: ia::result: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata' examples: Reference to updated employee expense: value: ia::result: key: '124' id: '124' href: /objects/expenses/employee-expense/124 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] delete: summary: Delete an employee expense description: Deletes an employee expense. tags: - Employee expenses operationId: delete-expenses-employee-expense-key responses: '204': description: No Content '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/expense-to-approve-line: get: summary: List employee expense lines to approve description: >- Returns a collection with a key, ID, and link for each expense to approve line. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Expense lines to approve operationId: list-expenses-expense-to-approve-line responses: '200': description: OK content: application/json: schema: type: object title: List of expense-to-approve-line objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List of expense to approve lines: value: ia::result: - key: '101' id: '101' href: /objects/expenses/expense-to-approve-line/101 - key: '102' id: '102' href: /objects/expenses/expense-to-approve-line/102 - key: '103' id: '103' href: /objects/expenses/expense-to-approve-line/103 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/expense-to-approve-line/{key}: parameters: - name: key description: System-assigned unique key for the expense to approve line. in: path required: true example: '312' schema: type: string get: summary: Get an approve employee expense line description: Returns detailed information for a specified expense to approve line. tags: - Expense lines to approve operationId: get-expenses-expense-to-approve-line-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the expense to approve line properties: ia::result: $ref: '#/components/schemas/expenses-expense-to-approve-line' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the approve employee expense line: value: ia::result: key: '312' id: '312' entryDate: '2021-01-23' baseCurrency: USD baseAmount: '123.45' reimbursementCurrency: CAD reimbursementAmount: '123.45' txnCurrency: INR txnAmount: '123.45' totalSelected: '123.45' totalPaid: '123.45' quantity: '5.75' unitRate: '20.00' paidTo: Hotel Westin paidFor: Attending conference glAccount: key: '158' id: '6775.30' name: Travel href: /objects/general-ledger/account/23 expenseType: key: '6000' id: Meals href: /objects/expense-type/34 lineNumber: 1 reimburseToBaseConversion: exchangeRateDate: '2021-01-23' exchangeRateTypeId: '-1' exchangeRate: '1.18999' transactionToReimburseConversion: exchangeRate: '65' exchangeRateDate: '2021-01-23' exchangeRateTypeId: '-1' state: draft isBillable: false isBilled: false form1099: isForm1099: 'true' type: MISC box: '3' paymentType: key: '1' id: '1' name: Non-reimburse isNonReimbursable: false href: string audit: createdDateTime: '2022-04-20T16:20:00Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' dimensions: location: key: '1' id: '1' name: USA department: key: '1' id: '1' name: IT employee: key: '10' id: EMP-10 href: /objects/company-config/employee/10 employeeContact: key: 20 id: Thomas, Glenn href: /objects/company-config/contact/20 project: key: '2' id: NET-XML30-2 name: Talcomp training href: /objects/projects/project/2 customer: key: '13' id: CUST-13 name: Jack In the Box href: /objects/accounts-receivable/customer/13 vendor: key: '357' id: '1605212096809' name: GenLab href: /objects/accounts-payable/vendor/357 item: key: '13' id: Case 13 name: Platform pack href: /objects/inventory-control/item/13 warehouse: key: '6' id: WH01 name: WH01 href: /objects/inventory-control/warehouse/6 class: key: '731' id: REST_CLS_001 name: Enterprises href: /objects/company-config/class/731 task: id: '1' key: '1' name: Project Task href: /objects/projects/task/1 costType: id: '2' key: '2' name: Project Expense href: /objects/construction/cost-type/2 asset: id: A001 key: '1' name: Laptop 1 href: /objects/asset/1 contract: id: CON-0045-1 key: '12' name: ACME Widgets - Service href: /objects/contracts/contract/12 approveEmployeeExpense: id: '1' key: '1' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/expense-to-approve: get: summary: List employee expenses to approve description: >- Returns a collection with a key, ID, and link for each expense to approve. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned. tags: - Expenses to approve operationId: list-expenses-expense-to-approve responses: '200': description: OK content: application/json: schema: type: object title: List of expense-to-approve objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List employee expenses to approve: value: ia::result: - key: '101' id: '101' href: /objects/expenses/expense-to-approve/101 - key: '102' id: '102' href: /objects/expenses/expense-to-approve/102 - key: '103' id: '103' href: /objects/expenses/expense-to-approve/103 ia::meta: totalCount: 3 start: 1 pageSize: 100 next: 0 previous: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/expense-to-approve/{key}: parameters: - name: key description: system-assigned unique key for the expense-to-approve. in: path required: true schema: type: string example: '99' get: summary: Get an employee expense to approve description: Returns detailed information for a specified expense to approve. tags: - Expenses to approve operationId: get-expenses-expense-to-approve-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the expense-to-approve properties: ia::result: $ref: '#/components/schemas/expenses-expense-to-approve' ia::meta: $ref: '#/components/schemas/metadata' examples: Details of the approve employee expense: value: ia::result: key: '124' id: '124' createdDate: '2021-01-23' employee: key: '12345' id: EMP-025 href: /objects/company-config/employee/12345 employeeContact: key: '20' id: Thomas, Glenn firstName: Glenn lastName: Thomas href: /objects/company-config/contact/20 state: draft basePayment: baseCurrency: USD paidDate: '2021-01-23' totalEntered: '123.45' totalPaid: '123.45' totalDue: '123.45' totalSelected: '110.00' reimbursement: reimbursementCurrency: EUR totalEntered: '123.16' totalPaid: '123.16' totalDue: '123.16' totalSelected: '123.16' expenseReportNumber: EXP-00001 expenseSummary: key: '334' id: '334' title: Expenses 2023/01/31 batch postingDate: '2021-01-23' state: open preventGLPosting: false href: /objects/projects/employee-expense-summary/12345 nonReimbursable: baseTotalEntered: '123.45' reimbursementTotalEntered: '123.45' memo: Paid to employee description: Supplies for customer training reclassificationNotes: Classified as supplies, not travel expense attachment: key: '1' id: '1' href: /objects/company-config/attachment/12345 audit: createdDateTime: '2014-01-08T11:28:12Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' lines: - key: '312' id: '312' entryDate: '2021-01-23' baseCurrency: USD baseAmount: '123.45' reimbursementCurrency: CAD reimbursementAmount: '123.45' txnCurrency: INR txnAmount: '123.45' totalSelected: '123.45' totalPaid: '123.45' quantity: '5.75' unitRate: '20.00' paidTo: Hotel Westin paidFor: Attending conference glAccount: key: '158' id: '6775.30' name: Travel href: /objects/general-ledger/account/23 expenseType: key: '6000' id: Meals href: /objects/expense-type/34 lineNumber: 1 reimburseToBaseConversion: exchangeRateDate: '2021-01-23' exchangeRateTypeId: '-1' exchangeRate: '1.18999' transactionToReimburseConversion: exchangeRate: '65' exchangeRateDate: '2021-01-23' exchangeRateTypeId: '-1' state: draft isBillable: false isBilled: false form1099: isForm1099: 'true' type: MISC box: '3' paymentType: key: '1' id: '1' name: Non-reimburse isNonReimbursable: false href: string audit: createdDateTime: '2022-04-20T16:20:00Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' entity: key: '46' id: Western Region name: Western Region href: /objects/company-config/entity/46 dimensions: location: key: '1' id: '1' name: USA department: key: '1' id: '1' name: IT employee: key: '10' id: EMP-10 href: /objects/company-config/employee/10 employeeContact: key: 20 id: Thomas, Glenn firstName: Glenn lastName: Thomas href: /objects/company-config/contact/20 project: key: '2' id: NET-XML30-2 name: Talcomp training href: /objects/projects/project/2 customer: key: '13' id: CUST-13 name: Jack In the Box href: /objects/accounts-receivable/customer/13 vendor: key: '357' id: '1605212096809' name: GenLab href: /objects/accounts-payable/vendor/357 item: key: '13' id: Case 13 name: Platform pack href: /objects/inventory-control/item/13 warehouse: key: '6' id: WH01 name: WH01 href: /objects/inventory-control/warehouse/6 class: key: '731' id: REST_CLS_001 name: Enterprises href: /objects/company-config/class/731 task: id: '1' key: '1' name: Project Task href: /objects/projects/task/1 costType: id: '2' key: '2' name: Project Expense href: /objects/construction/cost-type/2 asset: id: A001 key: '1' name: Laptop 1 href: /objects/asset/1 contract: id: CON-0045-1 key: '12' name: ACME Widgets - Service href: /objects/contracts/contract/12 approveEmployeeExpense: id: '1' key: '1' ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /workflows/expenses/expense-to-approve/approve: post: summary: Approve an employee expense description: "The approve workflow is used to set a submitted expense and its expense lines to 'approved' or 'partiallyApproved'. The submitted expense's beginning state depends on where the expense already is in the approval cycle and can include 'submitted', 'partiallyApproved', or 'partiallyDeclined'. \n\nFor example, new expenses will have a state of 'submitted', while an existing expense that's been partially approved can have a state of 'partiallyApproved' until all approvals are received. When an expense is fully approved, its state changes to 'approved'. \n" tags: - Expenses to approve operationId: approve-employee-expense requestBody: content: application/json: schema: $ref: '#/components/schemas/expenses-expense-to-approve-actions-approve-request' responses: '200': description: OK content: application/json: schema: type: object properties: ia::result: $ref: '#/components/schemas/expenses-expense-to-approve-actions-approve-response' ia::meta: $ref: '#/components/schemas/metadata' '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /workflows/expenses/expense-to-approve/decline: post: summary: Decline an employee expense description: "The decline workflow is used to set a submitted expense and its expense lines to 'declined' or 'partiallyDeclined'. The submitted expense's beginning state depends on where the expense already is in the approval cycle and can include 'submitted', 'partiallyApproved', or 'partiallyDeclined'. \n\nFor example, new expenses will have a state of 'submitted', while an existing expense that's been partially approved can have a state of 'partiallyApproved' until all approvals are received. When an expense is declined, its state changes to 'declined'. \n" tags: - Expenses to approve operationId: decline-employee-expense requestBody: content: application/json: schema: $ref: '#/components/schemas/expenses-expense-to-approve-actions-decline-request' responses: '200': description: OK content: application/json: schema: type: object properties: ia::result: $ref: '#/components/schemas/expenses-expense-to-approve-actions-decline-response' ia::meta: $ref: '#/components/schemas/metadata' '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/unit-rate: get: summary: List unit rates description: "Returns a collection with a key, ID, and link for each unit rate. This operation is mostly for use in testing; use query to find objects that meet certain criteria and specify the properties that are returned. \n" tags: - Unit rates operationId: list-expenses-unit-rate responses: '200': description: OK content: application/json: schema: type: object title: List of unit rate objects properties: ia::result: type: array items: $ref: '#/components/schemas/object-reference' ia::meta: $ref: '#/components/schemas/metadata-pages' examples: List unit rates: value: ia::result: - key: '12345' id: Travel-rate href: /objects/expenses/unit-rate/12345 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 start: 1 pageSize: 100 next: 101 previous: null '400': $ref: '#/components/responses/400error' security: - OAuth2: [] /objects/expenses/unit-rate/{key}: parameters: - name: key description: System-assigned unique key for the unit rate. in: path required: true schema: type: string example: '99' get: summary: Get a unit rate description: Returns detailed information for a specified unit rate. tags: - Unit rates operationId: get-expenses-unit-rate-key responses: '200': description: OK content: application/json: schema: type: object title: Details of the unit rate properties: ia::result: $ref: '#/components/schemas/expenses-unit-rate' ia::meta: $ref: '#/components/schemas/metadata' examples: Get a unit rate: value: ia::result: key: '23' id: '23' href: /objects/expenses/unit-rate/23 rate: '10' startDate: '2021-01-23' audit: createdDateTime: '2022-04-20T16:20:00Z' modifiedDateTime: '2022-04-20T16:20:00Z' createdBy: '1' modifiedBy: '95' employeeExpenseType: name: Travel key: '47' id: '47' href: /objects/expenses/employee-expense-type/47 ia::meta: totalCount: 1 totalSuccess: 1 totalError: 0 '400': $ref: '#/components/responses/400error' security: - OAuth2: [] components: schemas: electronic-receipt-line: $ref: '#/components/schemas/expenses-electronic-receipt-line' object-reference: type: object description: Reference to created or updated object properties: key: type: string example: '12345' id: type: string example: ID123 href: type: string readOnly: true example: /objects///12345 metadata-pages: description: Metadata for collection response type: object properties: totalCount: type: integer description: Total count readOnly: true example: 3 start: type: integer description: Start element number readOnly: true example: 1 pageSize: type: integer description: Page size readOnly: true example: 100 next: type: integer description: Next element number readOnly: true nullable: true example: 101 previous: type: integer description: Previous element number readOnly: true nullable: true example: null metadata: description: Metadata for response type: object properties: totalCount: type: integer description: Total count readOnly: true example: 3 totalSuccess: type: integer description: Total success readOnly: true example: 2 totalError: type: integer description: Total errors readOnly: true example: 1 error-response: type: object description: Error response properties: ia::result: type: object properties: ia::error: type: object properties: code: type: string example: invalidRequest message: type: string example: Payload contains errors supportId: type: string example: sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ errorId: type: string example: REST-1064 additionalInfo: type: object properties: messageId: type: string example: IA.PAYLOAD_CONTAINS_ERRORS placeholders: type: object example: {} propertySet: type: object example: {} details: type: array items: type: object properties: code: type: string example: invalidRequest message: type: string example: /newDate is not a valid field errorId: type: string example: REST-1043 target: type: string example: /newDate additionalInfo: type: object properties: messageId: type: string example: IA.NOT_A_VALID_FIELD placeholders: type: object example: {} propertySet: type: object example: {} ia::meta: $ref: '#/components/schemas/metadata' example: ia::result: ia::error: code: invalidRequest message: A POST request requires a payload errorId: REST-1028 additionalInfo: messageId: IA.REQUEST_REQUIRES_A_PAYLOAD placeholders: OPERATION: POST propertySet: {} supportId: Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo ia::meta: totalCount: 1 totalSuccess: 0 totalError: 1 audit: type: object readOnly: true properties: createdDateTime: description: Date-time when this record was created. type: string format: date-time readOnly: true example: '2023-05-16T15:34:35Z' modifiedDateTime: description: Date-time when this record was modified. type: string format: date-time readOnly: true example: '2024-09-14T21:23:42Z' createdBy: description: Key for the user who created this object. type: string readOnly: true nullable: true deprecated: true example: '436' modifiedBy: description: Key for the user who last modified this object. type: string readOnly: true nullable: true deprecated: true example: '3086' createdByUser: type: object description: The user who created this object. readOnly: true properties: key: type: string description: User key. readOnly: true nullable: true example: '436' id: type: string description: User login ID. readOnly: true nullable: true example: JohnDoe href: type: string readOnly: true description: URL endpoint for the user. example: /objects/company-config/user/436 modifiedByUser: type: object description: The user who last modified this object. readOnly: true properties: key: type: string description: User key. readOnly: true nullable: true example: '3086' id: type: string description: User login ID. readOnly: true nullable: true example: JaneDoe href: type: string readOnly: true description: URL endpoint for the user. example: /objects/company-config/user/3086 dimension-ref: type: object properties: location: type: object properties: key: type: string description: Location key example: '22' nullable: true id: type: string description: Location ID example: LOC-22 nullable: true name: type: string description: Location name readOnly: true example: California nullable: true href: type: string readOnly: true example: /objects/company-config/location/22 department: type: object properties: key: type: string description: Department key example: '11' nullable: true id: type: string description: Department ID example: DEP-11 nullable: true name: type: string description: Department name readOnly: true example: Sales and Marketing nullable: true href: type: string readOnly: true example: /objects/company-config/department/11 employee: type: object properties: key: type: string description: Employee key example: '10' nullable: true id: type: string description: Employee ID example: EMP-10 nullable: true name: type: string description: Employee name readOnly: true example: Thomas, Glenn nullable: true href: type: string example: /objects/company-config/employee/10 readOnly: true project: type: object properties: key: type: string description: Project key example: '2' nullable: true id: type: string description: Project ID example: NET-XML30-2 nullable: true name: type: string description: Project name readOnly: true example: Talcomp training nullable: true href: type: string readOnly: true example: /objects/projects/project/2 customer: type: object properties: key: type: string description: Customer key example: '13' nullable: true id: type: string description: Customer ID example: CUST-13 nullable: true name: type: string description: Customer name readOnly: true example: Jack In the Box nullable: true href: type: string readOnly: true example: /objects/accounts-receivable/customer/13 vendor: type: object properties: key: type: string description: Vendor key example: '357' nullable: true id: type: string description: Vendor ID example: '1605212096809' nullable: true name: type: string description: Vendor name readOnly: true example: GenLab nullable: true href: type: string readOnly: true example: /objects/accounts-payable/vendor/357 item: type: object properties: key: type: string description: Item key example: '13' nullable: true id: type: string description: Item ID example: Case 13 nullable: true name: type: string description: Item name readOnly: true example: Platform pack nullable: true href: type: string readOnly: true example: /objects/inventory-control/item/13 warehouse: type: object properties: key: type: string description: Warehouse key example: '6' nullable: true id: type: string description: Warehouse ID example: WH01 nullable: true name: type: string description: Warehouse name readOnly: true example: WH01 nullable: true href: type: string readOnly: true example: /objects/inventory-control/warehouse/6 class: type: object properties: key: type: string description: Class key example: '731' nullable: true id: type: string description: Class ID example: REST_CLS_001 nullable: true name: type: string description: Class name readOnly: true example: Enterprises nullable: true href: type: string readOnly: true example: /objects/company-config/class/731 task: type: object properties: id: type: string description: Task ID example: '1' nullable: true key: type: string description: Task key example: '1' nullable: true name: type: string description: Task name readOnly: true example: Project Task nullable: true href: type: string readOnly: true example: /objects/projects/task/1 costType: type: object properties: id: type: string description: Cost Type ID example: '2' nullable: true key: type: string description: Cost Type key example: '2' nullable: true name: type: string description: Cost Type name readOnly: true example: Project Expense nullable: true href: type: string readOnly: true example: /objects/construction/cost-type/2 asset: type: object properties: id: type: string description: Asset ID example: A001 nullable: true key: type: string description: Asset key example: '1' nullable: true name: type: string description: Asset name readOnly: true example: Laptop 1 nullable: true href: type: string readOnly: true example: /objects/fixed-assets/asset/1 contract: type: object properties: id: type: string description: Contract ID example: CON-0045-1 nullable: true key: type: string description: Contract key example: '12' nullable: true name: type: string description: Contract name readOnly: true example: ACME Widgets - Service nullable: true href: type: string readOnly: true example: /objects/contracts/contract/12 affiliateEntity: type: object properties: key: type: string description: Affiliate entity key example: '23' nullable: true id: type: string description: Affiliate entity ID example: AFF-23 nullable: true href: type: string readOnly: true example: /objects/affiliate-entity/23 name: type: string readOnly: true description: Affiliate entity name example: 100-USA nullable: true expenses-electronic-receipt-line: type: object description: An individual line on an employee electronic receipt. properties: key: type: string description: System-assigned unique key for the electronic receipt line. readOnly: true example: '312' id: type: string description: >- Unique identifier for the electronic receipt line. This value is the same as the key for this object. readOnly: true example: '312' href: type: string readOnly: true description: URL endpoint for the electronic receipt line. example: /objects/expenses/electronic-receipt-line/312 entryDate: type: string format: date description: Date filed. example: '2025-01-23' currency: type: string description: Transaction currency of the receipt. example: INR txnAmount: type: string description: Transaction amount. format: decimal-precision-2 example: '123.45' nullable: true baseCurrency: type: string description: Base currency of the receipt. readOnly: true example: USD baseAmount: type: string description: Amount of the expense in base currency. readOnly: true format: decimal-precision-2 example: '123.45' quantity: type: string description: Quantity for a rate-based receipt, such as for mileage. format: decimal-precision-2 example: '5.75' unitRate: type: string description: Monetary amount for a rate-based receipt, such as for mileage. format: decimal-precision-2 example: '20.00' paidTo: type: string description: Notes regarding to whom you paid the amount. example: Hotel Westin paidFor: type: string description: Notes regarding what the receipt was for. example: Attending conference glAccount: type: object description: >- General ledger account associated with the line item. Used when no expense type is assigned. properties: key: type: string description: Unique key for the GL account. example: '158' id: type: string description: Unique identifier for the GL account. example: '158' name: type: string description: Name of the GL account. example: Travel readOnly: true href: type: string description: URL endpoint for the GL account. readOnly: true example: /objects/general-ledger/account/158 expenseType: type: object description: An expense type defined in the company. properties: key: type: string description: Unique key for the expense type. example: '6000' id: type: string description: Unique identifier for the expense type. example: Meals href: type: string description: URL endpoint for the expense type. readOnly: true example: /objects/expenses/expense-type/6000 lineNumber: type: integer description: Line number of the electronic receipt. readOnly: true example: 1 state: type: string description: Status of the employee electronic receipt line. enum: - draft - used - review - analyzing readOnly: true example: draft audit: $ref: '#/components/schemas/audit' dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object properties: key: type: string description: Unique key for the location. example: '1' nullable: true id: type: string description: Unique identifier for the location. example: '1' nullable: true name: readOnly: true type: string description: Location name example: USA nullable: true href: type: string description: URL endpoint for the location. readOnly: true example: /objects/company-config/location/1 department: type: object properties: key: type: string description: Unique key for the department. example: '12' nullable: true id: type: string description: Unique identifier for the department. example: '12' nullable: true name: type: string description: Department name readOnly: true example: IT nullable: true href: type: string description: URL endpoint for the department. readOnly: true example: /objects/company-config/department/12 electronicReceipt: type: object readOnly: true properties: id: type: string description: Unique identifier for the electronic receipt. readOnly: true example: '124' key: type: string description: Unique key for the electronic receipt. readOnly: true example: '124' href: type: string readOnly: true description: URL endpoint for the electronic receipt. example: /objects/expenses/electronic-receipt/124 electronic-receipt: $ref: '#/components/schemas/expenses-electronic-receipt' electronic-receiptRequiredProperties: type: object required: - employee - createdDate entity-ref: type: object description: >- The entity that the object is associated with. Objects created at the top level do not have an entity reference so the `key`, `id`, and `name` properties will be `null`. readOnly: true properties: key: type: string description: Entity key. readOnly: true nullable: true example: '46' id: type: string description: Entity ID. readOnly: true nullable: true example: CORP name: type: string description: Entity name. readOnly: true nullable: true example: Corp href: type: string description: URL endpoint for the entity. readOnly: true example: /objects/company-config/entity/46 expenses-electronic-receipt: type: object description: Electronic receipt for an employee. properties: key: type: string description: System-assigned unique key for the electronic receipt. readOnly: true example: '124' id: type: string description: >- Unique identifier for the electronic receipt. This value is the same as the key for this object. readOnly: true example: '124' href: type: string readOnly: true description: URL endpoint for the electronic receipt. example: /objects/expenses/electronic-receipt/124 createdDate: type: string format: date example: '2021-01-23' description: Date the electronic receipt was created. nullable: false employee: type: object description: Employee that incurred the expense. nullable: false properties: key: type: string description: Unique key for the employee. example: '259' id: type: string description: Unique ID for the employee. example: '259' href: type: string readOnly: true description: URL endpoint for the employee. example: /objects/company-config/employee/259 employeeContact: type: object description: The contact for the employee. readOnly: true properties: key: type: string description: Unique key for the contact. readOnly: true example: '977' id: type: string description: Unique identifier for the contact. readOnly: true example: Thomas, Glenn firstName: type: string description: First name of the employee. readOnly: true example: Glenn lastName: type: string description: Last name of the employee. readOnly: true example: Thomas href: type: string example: /objects/company-config/contact/977 description: URL endpoint for the contact. readOnly: true state: type: string description: Status of the electronic receipt in the expense cycle. enum: - draft - used - review - analyzing default: draft example: draft receiptNumber: type: string description: Alpha-numeric string associated with the electronic receipt. example: EXP-00001 description: type: string description: Reason for and description of the receipt. example: Supplies for customer training. currency: type: string description: Transaction currency. readOnly: true example: USD totalAmount: type: string description: Total receipt amount. readOnly: true format: decimal-precision-2 example: '123.16' baseCurrency: type: string description: Base currency for the electronic receipt. readOnly: true example: USD baseTotal: type: string description: Total transaction amount in base currency. format: decimal-precision-2 readOnly: true example: '123.45' attachment: type: object description: >- Attachment for an electronic receipt that is scanned or is a digital receipt. properties: key: type: string description: Unique key for the attachment. example: '10' id: type: string description: Unique ID for the attachment. example: '10' href: type: string description: URL endpoint for the attachment. example: /objects/company-config/attachment/10 readOnly: true audit: type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdDateTime: type: string description: Time of the submission. format: date-time example: '2014-01-08T11:28:12Z' readOnly: true entity: $ref: '#/components/schemas/entity-ref' lines: type: array description: Line items of the electronic receipt. items: $ref: '#/components/schemas/expenses-electronic-receipt-line' expenses-employee-expense-adjustment-line: type: object description: >- Line items in an employee expense adjustment and represent debits or credits payable to an employee. properties: key: type: string description: System-assigned key for the employee expense adjustment line item. readOnly: true example: '312' id: type: string description: >- Unique identifier for the employee expense adjustment line item. This value is the same as the key for this object. readOnly: true example: '312' entryDate: type: string format: date description: Date the adjustment item is filed. example: '2025-01-23' baseCurrency: type: string description: Base currency of the expense adjustment. readOnly: true example: USD baseAmount: type: string description: Amount of the expense adjustment in base currency. readOnly: true format: decimal-precision-2 example: '123.45' reimbursementCurrency: type: string description: >- In multi-currency companies, the currency used to pay for the reimbursement. readOnly: true example: CAD reimbursementAmount: type: string description: Reimbursement amount. readOnly: true format: decimal-precision-2 example: '123.45' txnCurrency: type: string description: In multi-currency companies, the currency used for the transaction. example: INR txnAmount: type: string description: Transaction amount. format: decimal-precision-2 example: '123.45' nullable: true totalSelected: type: string description: Amount selected to pay in transaction currency. readOnly: true format: decimal-precision-2 example: '123.45' totalPaid: type: string description: Amount paid in transaction currency. readOnly: true format: decimal-precision-2 example: '123.45' quantity: type: string description: Quantity for a rate-based expense adjustment, such as mileage. format: decimal-precision-2 example: '5.75' unitRate: type: string description: >- Monetary amount for a rate-based expense adjustment, such as mileage. format: decimal-precision-6 example: '20.000000' paidTo: type: string description: Notes regarding to whom the amount was paid. example: Hotel Westin glAccount: type: object description: >- General ledger account associated with the line item. Used when no expense adjustment type is assigned. properties: key: type: string description: Unique key for the GL account. example: '158' id: type: string description: Unique identifier for the GL account. example: '6775.30' name: type: string description: Name of the GL account. readOnly: true example: Travel href: type: string description: Endpoint for the GL account object. readOnly: true example: /objects/general-ledger/account/23 expenseType: type: object description: An expense type defined in the company. properties: key: type: string description: Unique key for the expense type. example: '6000' id: type: string description: Unique identifier for the expense type. example: Meals href: type: string description: Endpoint for the expense type object. readOnly: true example: /objects/expense-type/34 lineNumber: type: number description: Line number of the employee expense adjustment. readOnly: true example: 1 reimburseToBaseConversion: type: object description: Details of reimbursement currency to base currency conversion. properties: exchangeRateDate: type: string format: date description: Date the exchange rate conversion was applied. example: '2025-01-23' readOnly: true exchangeRateTypeId: type: string description: Type of the expense adjustment line exchange rate. example: '-1' readOnly: true exchangeRate: type: string description: Value of the expense adjustment line exchange rate. readOnly: true format: decimal-precision-5 example: '1.18999' transactionToReimburseConversion: type: object description: Details of the conversion to base currency. properties: exchangeRate: type: string description: Exchange rate for the transaction. format: decimal-precision-5 example: '65' exchangeRateDate: type: string format: date example: '2025-01-23' description: Date for the exchange rate. exchangeRateTypeId: type: string description: Exchange rate type. example: '-1' state: type: string description: Status of the employee expense adjustment report line. enum: - draft - submitted - partiallyApproved - partiallyDeclined - approved - posted - declined - reversalPending - reversed - reversal - paid - confirmed - voided - partiallyPaid - saved - null default: submitted nullable: true readOnly: true example: draft isBillable: type: boolean default: false description: Indicates whether a line item is billable. example: false isBilled: type: boolean default: false description: Indicates whether a line item is billed. readOnly: true example: false paymentType: type: object properties: key: type: string description: Unique key for the expense payment type. example: '1' id: type: string description: Unique identifier for the expense payment type. example: '1' name: type: string description: Name of the expense payment type. example: Non-reimburse isNonReimbursable: type: boolean default: false description: Non-reimbursable expense. example: false href: type: string readOnly: true example: /objects/expenses/employee-expense-payment-type/1 audit: $ref: '#/components/schemas/audit' dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object properties: key: type: string description: Unique key for the location. example: '1' id: type: string description: Unique identifier for the location. example: '1' name: readOnly: true type: string description: Location name example: USA department: type: object properties: key: type: string description: Unique key for the department. example: '12' id: type: string description: Unique identifier for the department. example: '12' name: type: string description: Department name readOnly: true example: IT employeeExpenseAdjustment: type: object properties: id: type: string description: Unique identifier for the employee expense adjustment. example: '138' key: type: string description: Unique key for the employee expense adjustment. example: '138' href: type: string description: URL endpoint for the employee expense adjustment. readOnly: true example: /objects/expenses/employee-expense-adjustment/138 employeeExpenseAdjustmentRequiredProperties: type: object required: - createdDate expenses-employee-expense-adjustment: type: object description: Expense adjustment for an employee. properties: key: type: string description: System-assigned key for the employee expense adjustment. readOnly: true example: '124' id: type: string description: >- Unique identifier for the employee expense adjustment. This value is the same as the key for this object. readOnly: true example: '124' href: type: string description: URL endpoint for the employee expense adjustment. readOnly: true example: /objects/company-config/user-group/124 adjustmentType: type: string enum: - debit - credit description: >- Adjustment type. Options are credit (increases the amount due to the employee) or debit (decreases the amount due to the employee). example: debit default: debit referenceEmployeeExpense: type: object description: The expense report to which the adjustment applies. properties: key: type: string description: Unique key for the referenced employee expense. example: '2534' id: type: string description: Unique identifier for the referenced employee expense. example: '124' href: type: string readOnly: true description: URL endpoint for the employee expense. example: /objects/expenses/employee-expense/2534 description: type: string description: Description of the employee expense adjustment. example: Corrects underpayment of mileage for conference travel. createdDate: type: string format: date example: '2025-01-23' description: Creation date of the employee expense adjustment. nullable: false employee: type: object description: Employee that incurred the expense adjustment. properties: key: type: string description: Unique key for the employee. example: '482' id: type: string description: Unique identifier for the employee. example: EMP-025 href: type: string readOnly: true description: URL endpoint for the employee. example: /objects/company-config/employee/482 employeeContact: type: object description: The contact for the employee. readOnly: true properties: key: type: string description: Unique key for the employee contact. readOnly: true example: '973' id: type: string description: Unique identifier for the employee contact. readOnly: true example: Thomas, Glenn firstName: type: string description: First name of the employee contact. readOnly: true example: Glenn lastName: type: string description: Last name of the employee contact. readOnly: true example: Thomas href: type: string description: URL endpoint for the employee contact. readOnly: true example: /objects/company-config/contact/973 state: type: string description: >- Status of the employee expense adjustment. Expense adjustments are posted to the general ledger when approved. enum: - draft - approved - partiallyApproved - submitted - declined - partiallyDeclined - resubmitted - selected - paid - partiallyPaid default: submitted example: draft basePayment: type: object description: Base payment details for the employee expense adjustment report. properties: baseCurrency: type: string description: >- Base currency used for the employee expense adjustment report. The currency is determined by the company's default currency for reporting. example: USD paidDate: type: string format: date example: '2025-01-23' description: Date when the employee expense adjustment was fully paid. readOnly: true totalEntered: type: string description: Total transaction amount entered for the payment. readOnly: true example: '123.45' format: decimal-precision-2 totalPaid: type: string description: Total amount paid for the employee expense adjustment. readOnly: true example: '123.45' format: decimal-precision-2 totalDue: type: string description: Total amount due for the employee expense adjustment. readOnly: true example: '123.45' format: decimal-precision-2 totalSelected: type: string description: Amount selected for the employee expense adjustment. readOnly: true example: '110.00' format: decimal-precision-2 reimbursement: type: object description: Reimbursement details for the employee expense adjustment. properties: reimbursementCurrency: type: string description: >- For companies that use multiple transaction currencies, the currency used to pay for the reimbursement. example: EUR totalEntered: type: string description: Total reimbursable amount. readOnly: true format: decimal-precision-2 example: '123.16' totalPaid: type: string description: >- Total amount paid for the employee expense adjustment reimbursement. readOnly: true format: decimal-precision-2 example: '123.16' totalDue: type: string description: >- Total amount due for the employee expense adjustment reimbursement; amount can differ from the `totalPaid`. readOnly: true format: decimal-precision-2 example: '123.16' totalSelected: type: string description: Amount selected for employee expense adjustment reimbursement. readOnly: true format: decimal-precision-2 example: '123.16' expenseAdjustmentReportNumber: type: string description: >- Adjustment report number associated with the employee expense adjustment. This field is auto-populated if Time & Expense is configured to auto-number credit and debit adjustments using Company Document sequences. example: EXP-00001 expenseSummary: type: object description: Expense summary that this expense is reported on. properties: key: type: string description: Unique key for the employee expense summary. example: '334' id: type: string description: Unique identifier for the expense summary. example: '334' title: type: string description: Title of the employee expense summary. readOnly: true example: Expenses 2024/01/31 batch postingDate: type: string format: date example: '2025-01-23' description: >- The general ledger posting date for the employee expense summary. state: type: string description: Indicates whether the expense summary is open or closed. enum: - open - closed example: open readOnly: true default: open preventGLPosting: type: boolean default: false description: >- Indicates whether the expense summary is posted to the general ledger. readOnly: true example: false href: type: string readOnly: true description: URL endpoint for the employee expense summary. example: /objects/expenses/employee-expense-summary/334 nonReimbursable: type: object description: Non-reimbursable amount of the employee expense adjustment. properties: baseTotalEntered: type: string description: Total non-reimbursable amount in base currency. readOnly: true format: decimal-precision-2 example: '123.45' reimbursementTotalEntered: type: string description: Total reimbursable amount in base currency. readOnly: true format: decimal-precision-2 example: '123.45' memo: type: string description: Memo about the employee expense adjustment. example: Paid by employee. reclassificationNotes: type: string description: Reason for the reclassification. example: Classified as supplies, not travel expense adjustment attachment: type: object description: >- An attachment for employee expense adjustment. Can include scanned or digital receipts. properties: key: type: string description: Unique key for the attachment. example: '152' id: type: string description: Unique identifier of the attachment. example: '1' href: type: string description: URL endpoint for the attachment. example: /objects/company-config/attachment/152 readOnly: true entity: $ref: '#/components/schemas/entity-ref' audit: type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdDateTime: type: string description: Time of the submission. format: date-time example: '2014-01-08T11:28:12Z' readOnly: true lines: type: array description: Line items of the employee expense adjustment. items: $ref: '#/components/schemas/expenses-employee-expense-adjustment-line' expenses-employee-expense-lineRequiredProperties: type: object required: - txnAmount expenses-employee-expense-line: type: object description: >- Line items in an employee expense report represent individual expenses to reimburse to the employee. properties: key: type: string description: System-assigned unique key for the employee expense line. readOnly: true example: '312' id: type: string description: >- Unique identifier for the employee expense line. This value is the same as key for this object. readOnly: true example: '312' href: type: string readOnly: true description: URL endpoint for the employee expense line. example: /objects/expenses/employee-expense-line/312 entryDate: type: string format: date description: Date that the expense was incurred. example: '2021-01-23' nullable: true baseCurrency: type: string description: >- Base currency used for the expense report and determined by company currency used for reporting. readOnly: true example: USD baseAmount: type: string description: Amount of the expense in base currency. readOnly: true format: decimal-precision-2 example: '123.45' reimbursementCurrency: type: string description: >- The currency used to pay for the expense. For multi-currency companies. readOnly: true example: CAD reimbursementAmount: type: string description: Reimbursement amount in the reimbursement currency. readOnly: true format: decimal-precision-2 example: '123.45' txnCurrency: type: string description: Transaction currency. For multi-currency companies. example: INR nullable: true txnAmount: type: string description: Transaction amount. For multi-currency companies. format: decimal-precision-2 example: '123.45' totalSelected: type: string description: Amount selected to pay in transaction currency. readOnly: true format: decimal-precision-2 example: '123.45' totalPaid: type: string description: Amount paid in transaction currency. readOnly: true format: decimal-precision-2 example: '123.45' quantity: type: string description: Quantity for a rate-based expense such as mileage. format: decimal-precision-2 example: '5.75' nullable: true unitRate: type: string description: Monetary amount for a rate-based expense, such as mileage. format: decimal-precision-2 example: '20.00' nullable: true paidTo: type: string description: Notes regarding to whom the amount was paid. example: Hotel Westin nullable: true paidFor: type: string description: Notes regarding what the expense was for. example: 2024 Hawaii Conference nullable: true glAccount: type: object description: >- General ledger account associated with the line item. Used when no expense type is assigned. properties: key: type: string description: Unique key for the GL account. example: '158' id: type: string description: Unique identifier for the GL account. example: '6775.30' name: type: string description: Name of the GL account. readOnly: true example: Travel href: type: string description: URL endpoint for the GL account. readOnly: true example: /objects/general-ledger/account/158 expenseType: type: object description: An expense type defined in the company. properties: key: type: string description: Unique key for the expense type. example: '6000' id: type: string description: Unique identifier for the expense type. example: Meals href: type: string description: URL endpoint for the expense type. readOnly: true example: /objects/expense-type/6000 lineNumber: type: number description: Line number of the employee expense. readOnly: true example: 1 reimburseToBaseConversion: type: object description: >- Details of reimbursement currency to base currency conversion. For multi-currency companies. readOnly: true properties: exchangeRateDate: type: string format: date description: Date the exchange rate conversion was applied. example: '2021-01-23' readOnly: true exchangeRateTypeId: type: string description: Type of the expense line exchange rate. example: '-1' readOnly: true exchangeRate: type: string description: Value of the expense line exchange rate. readOnly: true format: decimal-precision-5 example: '1.18999' transactionToReimburseConversion: type: object description: >- Details of the conversion to base currency. For multi-currency companies. properties: exchangeRate: type: string description: Exchange rate for the transaction. format: decimal-precision-5 example: '65.095' nullable: true exchangeRateDate: type: string format: date example: '2021-01-23' description: Date for the exchange rate. nullable: true exchangeRateTypeId: type: string description: Exchange rate type. example: '-1' nullable: true state: type: string description: Status of the employee expense report line. enum: - draft - submitted - partiallyApproved - partiallyDeclined - approved - posted - declined - reversalPending - reversed - reversal - paid - confirmed - voided - partiallyPaid - saved - null default: submitted nullable: true readOnly: true example: draft isBillable: type: boolean default: false description: Indicates whether a line item is billable. example: false isBilled: type: boolean default: false description: Indicates whether a line item is billed. readOnly: true example: false form1099: type: object description: Form 1099 information for the line item. properties: isForm1099: type: string description: If set to true, the line item amount is added to the form 1099. example: true nullable: true type: type: string description: Type of form 1099. example: MISC nullable: true box: type: string description: Box value of form 1099. example: '3' nullable: true paymentType: type: object description: The payment type defined in `employee-expense-payment-type`. properties: key: type: string description: Unique key for the expense payment type. example: '23' nullable: true id: type: string description: Unique identifier for the payment type. example: Non-reimburse nullable: true isNonReimbursable: type: boolean default: false description: >- Non-reimbursable expense as defined in `employee-expense-payment-type.isNonReimbursable`. readOnly: true example: false href: type: string description: URL endpoint for the payment type. example: /objects/expenses/employee-expense-payment-type/23 readOnly: true electronicReceipt: type: object properties: id: type: string description: Unique identifier for the electronic receipt. example: '124' key: type: string description: Unique key for the electronic receipt. example: '124' href: type: string description: URL endpoint for the electronic receipt. readOnly: true example: /objects/expenses/electronic-receipt/124 electronicReceiptLine: type: object properties: id: type: string description: Unique identifier for the electronic receipt line. example: '128' key: type: string description: Unique key for the electronic receipt line. example: '128' href: type: string description: URL endpoint for the electronic receipt. readOnly: true example: /objects/expenses/electronic-receipt-line/128 audit: $ref: '#/components/schemas/audit' dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object properties: key: type: string description: Unique key for the location. example: '1' nullable: true id: type: string description: Unique identifier for the location. example: '1' nullable: true name: readOnly: true type: string description: Location name example: USA nullable: true href: type: string description: URL endpoint for the location. readOnly: true example: /objects/company-config/location/1 department: type: object properties: key: type: string description: Unique key for the department. example: '11' nullable: true id: type: string description: Unique identifier for the department. example: '1' nullable: true name: type: string description: Department name readOnly: true example: Content development nullable: true href: type: string description: URL endpoint for the department. readOnly: true example: /objects/company-config/department/11 employeeExpense: type: object properties: id: type: string description: Unique identifier for the employee expense. example: '124' key: type: string description: Unique key for the employee expense. example: '124' href: type: string description: URL endpoint for the employee expense. readOnly: true example: /objects/expenses/employee-expense/124 employeeExpensePaymentTypeRequiredProperties: type: object required: - id status: type: string description: >- Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. enum: - active - inactive default: active example: active expenses-employee-expense-payment-type: type: object description: >- User-defined payment type for a line item of an employee expense report or an expense adjustment. properties: key: type: string description: System-assigned key for the employee expense payment type. readOnly: true example: '10' id: type: string description: Unique identifier for the employee expense payment type. example: Non-reimburse description: type: string description: Description of the employee expense payment type. example: Non-reimbursable payment nullable: true isNonReimbursable: type: boolean default: false description: >- If set to `true`, the employee expense payment type is not reimbursable. example: true offsetGLAccount: type: object description: Offset account assigned to the employee expense payment type. properties: key: type: string description: Unique key for the offset GL account. example: '70' nullable: true id: type: string description: Unique identifier of the offset GL account. example: '2420' nullable: true name: type: string description: Name of the offset GL account. readOnly: true example: EE-Office Supplies nullable: true href: type: string description: URL endpoint for the offset GL account. readOnly: true example: /objects/general-ledger/account/70 href: type: string description: URL endpoint for the employee expense payment type. readOnly: true example: /objects/expenses/employee-expense-payment-type/10 status: $ref: '#/components/schemas/status' audit: $ref: '#/components/schemas/audit' entity: $ref: '#/components/schemas/entity-ref' expenses-employeeExpenseSummaryRequiredProperties: type: object required: - name - postingDate expenses-employee-expense-summary: type: object description: Collection of expense transactions, grouped together for processing. properties: key: type: string description: System-assigned unique key for the employee expense summary. readOnly: true example: '13' id: type: string description: >- Unique identifier for the employee expense summary. This value is the same as the key for this object. readOnly: true example: '13' name: type: string description: Title of the summary. example: Expenses - Expenses (USD) Q3 Batch postingDate: type: string description: The GL posting date for the expense summary. format: date example: '2021-01-23' totalAmount: type: string description: Total amount of all employee expenses in the summary. example: '100.00' readOnly: true format: decimal-precision-2 nullable: true state: type: string enum: - open - closed description: State of the employee expense summary. example: open default: open recordType: type: string description: Record type enum: - expense - adjustment - reimbursement example: expense readOnly: true summaryCreationType: type: string description: "If set to manual, then the summary was created by a user. If set to system, then the summary was created by Sage Intacct based on the summary frequency. \n\nAutomatic summaries are created according to time intervals chosen by the expense administrator. Expense reports are grouped within the summary created for the time interval in which they were received. \n" enum: - system - manual default: manual example: manual readOnly: true bankAccount: type: object description: Bank account associated with the summary. readOnly: true properties: key: type: string description: Unique key for the bank account. example: '1' readOnly: true nullable: true id: type: string description: Unique identifier of the bank account. example: BOA readOnly: true nullable: true href: type: string description: URL endpoint for the bank account. readOnly: true example: /objects/cash-management/bank-account/1 preventGLPosting: type: boolean description: If `false`, the summary is posted to the General Ledger. example: false default: false readOnly: true href: type: string description: URL endpoint for the employee expense summary. readOnly: true example: /objects/expenses/employee-expense-summary/13 status: $ref: '#/components/schemas/status' entity: $ref: '#/components/schemas/entity-ref' expenses-employee-expense-typeRequiredProperties: type: object required: - id - description - glAccount expenses-unit-rate: type: object description: unit rate for a specific employee expense type properties: key: type: string description: System-assigned unique key for the unit rate. readOnly: true example: '23' id: type: string description: >- Unique identifier for the unit rate. This value is the same as the key for this object. readOnly: true example: '23' href: type: string description: URL endpoint for the unit rate. readOnly: true example: /objects/expenses/unit-rate/23 rate: type: string description: >- The unit rate to use for an expense reimbursement to produce the reimbursement amount (`unitrate` multiplied by `expenses.employee-expense-line.quantity`). format: decimal-precision-4 example: '10' nullable: false startDate: type: string description: >- The employee start date, (`company-config.employee.startDate`) that determines when the unit rate takes effect. nullable: false example: '2021-01-23' format: date audit: $ref: '#/components/schemas/audit' employeeExpenseType: type: object description: >- A user-defined type that associates a certain type of expense with a GL account. readOnly: true properties: key: type: string description: Unique key for the employee expense type. readOnly: true example: '47' id: type: string description: Unique identifier of the employee expense type. readOnly: true example: '47' href: type: string description: URL endpoint for the employee expense type. example: /objects/employee-expense-type/47 readOnly: true expenses-employee-expense-type: type: object description: Details for an employee expense type. properties: key: type: string description: System-assigned key for the employee expense type. readOnly: true example: '47' id: type: string description: Unique identifier for the employee expense type. example: Travel status: $ref: '#/components/schemas/status' description: type: string description: Description of the employee expense type. example: Non-reimbursable expense for travel href: type: string description: URL endpoint for the expense type. readOnly: true example: /objects/expenses/employee-expense-type/47 glAccount: type: object description: GL account assigned to the employee expense type. properties: key: type: string description: Unique key for the GL account. example: '5500' id: type: string description: Unique identifier for the GL account. example: Travel expenses name: type: string description: Name of the GL account. readOnly: true example: Automobile expenses href: type: string description: URL endpoint for the GL account. readOnly: true example: /objects/general-ledger/account/5500 offsetGLAccount: type: object description: >- Offset account assigned to the employee expense type or the default GL account for employee liabilities. properties: key: type: string description: Unique key for the offset GL account. nullable: true example: '6000' id: type: string description: Unique identifier for the offset GL account. nullable: true example: Offset travel expenses name: type: string description: Name of the offset GL account. readOnly: true nullable: true example: Offset automobile expenses href: type: string description: URL endpoint for the offset GL account. readOnly: true example: /objects/general-ledger/account/6000 item: type: object description: >- Defined category of expense, such as software, meals or training. (Projects subscription) properties: key: type: string description: Unique key for the item. nullable: true example: '311' id: type: string description: Unique identifier for the item. nullable: true example: '10' name: type: string description: Name of the item. readOnly: true nullable: true example: Laptop href: type: string description: URL endpoint for the item. readOnly: true example: /objects/inventory-control/item/311 unitCurrency: type: string description: >- Currency of the transaction amount for multi-currency companies and rate-based expenses. nullable: true example: USD form1099: type: object description: Form 1099 information for the employee expense type. readOnly: true properties: type: type: string description: Type of form 1099. readOnly: true nullable: true example: MISC box: type: string description: Box value of form 1099. readOnly: true nullable: true example: '3' audit: $ref: '#/components/schemas/audit' entity: $ref: '#/components/schemas/entity-ref' unitRates: type: array description: Line items of the employee expense type. items: $ref: '#/components/schemas/expenses-unit-rate' expenses-employee-expenseRequiredProperties: type: object required: - createdDate - employee - lines expenses-employee-expense: type: object description: >- Expense report for an employee. This is the header object for employee expense lines. properties: key: type: string description: System-assigned key for the employee expense. readOnly: true example: '124' id: type: string description: >- Unique identifier for the employee expense. This value is the same as the key for this object. readOnly: true example: '124' createdDate: type: string format: date example: '2024-11-11' description: Date the employee expense was created. nullable: false employee: type: object description: Employee that incurred the expense. properties: key: type: string description: Unique key for the employee. example: '12345' id: type: string description: Unique identifier for the employee. example: EMP-025 href: type: string readOnly: true description: URL endpoint for the employee. example: /objects/company-config/employee/12345 employeeContact: type: object description: The contact for the employee. properties: key: type: string description: Unique key for the employee contact. readOnly: true example: '977' id: type: string description: Unique identifier for the employee contact. readOnly: true example: Thomas, Glenn firstName: type: string description: First name of the employee. readOnly: true example: Glenn lastName: type: string description: Last name of the employee. readOnly: true example: Thomas href: type: string description: URL endpoint for the employee contact. example: /objects/company-config/contact/977 readOnly: true readOnly: true state: type: string description: >- Status of the employee expense in its life cycle. Expenses are posted to the general ledger when approved. enum: - draft - submitted - partiallyApproved - partiallyDeclined - approved - posted - declined - reversalPending - reversed - reversal - paid - confirmed - voided - partiallyPaid - selected default: submitted example: draft basePayment: type: object description: Base payment details for the employee expense report. properties: baseCurrency: type: string description: >- Base currency used for the expense report and determined by company currency used for reporting. example: USD paidDate: type: string format: date example: '2024-11-12' description: Date the employee expense was fully paid. readOnly: true totalEntered: type: string description: Total transaction amount entered for the expense. format: decimal-precision-2 readOnly: true example: '123.45' totalPaid: type: string description: Total amount paid for the expense. format: decimal-precision-2 readOnly: true example: '123.45' totalDue: type: string description: Total amount due for the expense. format: decimal-precision-2 readOnly: true example: '123.45' totalSelected: type: string description: Amount selected for reimbursement. format: decimal-precision-2 readOnly: true example: '110.00' reimbursement: type: object description: Reimbursement details. properties: reimbursementCurrency: type: string description: >- The currency used to pay for the expense. For multi-currency companies. example: EUR totalEntered: type: string description: Total reimbursable amount. readOnly: true format: decimal-precision-2 example: '123.16' totalPaid: type: string description: Total amount paid to the employee for the expense. readOnly: true format: decimal-precision-2 example: '123.16' totalDue: type: string description: Total amount due to the employee for the expense. readOnly: true format: decimal-precision-2 example: '123.16' totalSelected: type: string description: Amount selected for reimbursement. readOnly: true format: decimal-precision-2 example: '123.16' expenseReportNumber: type: string description: Report number associated with the employee expense. example: EXP-00001 expenseSummary: type: object description: Expense summary that this expense is reported on. properties: key: type: string description: Unique key for the employee expense summary. example: '334' id: type: string description: Unique identifier for the expense summary. example: '334' title: type: string description: Title of the expense summary. readOnly: true example: Expenses 2024/01/31 batch postingDate: type: string format: date example: '2024-01-23' description: GL posting date. state: type: string description: Indicates whether the expense summary is open or closed. enum: - open - closed example: open readOnly: true default: open preventGLPosting: type: boolean default: false description: Not for GL posting. readOnly: true example: false href: type: string readOnly: true description: URL endpoint for the employee expense summary. example: /objects/expenses/employee-expense-summary/334 nonReimbursable: type: object description: >- Non-reimbursable portion of the expense. An expense report line is considered non-reimbursable when `employee-expense-line.isBillable` is `false` and `employee-expense-line.paymentType.isNonReimbursable` is `true`. readOnly: true properties: baseTotalEntered: type: string description: Non-reimbursable amount in base currency. readOnly: true format: decimal-precision-2 example: '123.45' reimbursementTotalEntered: type: string description: Total non-reimbursable amount in the reimbursement currency. readOnly: true format: decimal-precision-2 example: '123.45' memo: type: string description: Memo. example: Paid to employee description: type: string description: Reason for the expense. example: Supplies for customer training reclassificationNotes: type: string description: If an expense is reclassified, reason for the reclassification. example: Classified as supplies, not travel expense attachment: type: object description: >- An attachment for employee expenses.(Company subscription with permissions to Add and Edit Attachments.) properties: key: type: string description: Unique key for the attachment. example: '25' id: type: string description: Unique identifier for the attachment. example: '1' href: type: string description: URL endpoint for the attachment. example: /objects/company-config/attachment/25 readOnly: true audit: type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdDateTime: type: string description: Time of the submission. format: date-time example: '2014-01-08T11:28:12Z' readOnly: true lines: type: array description: Line items of the employee expense. items: $ref: '#/components/schemas/expenses-employee-expense-line' entity: $ref: '#/components/schemas/entity-ref' expenses-expense-to-approve-line: type: object description: >- An individual expense line sent for approval on an employee expense report. properties: key: type: string description: >- System assigned unique key for the employee expense line item to approve. readOnly: true example: '312' id: type: string description: >- Unique identifier for the expense to approve line. This value is the same as the key for this object. readOnly: true example: '312' entryDate: type: string format: date description: Date the expense line is filed. example: '2025-01-23' baseCurrency: type: string description: Base currency of the expense. readOnly: true example: USD baseAmount: type: string description: Amount of the expense in base currency. readOnly: true format: decimal-precision-2 example: '123.45' reimbursementCurrency: type: string description: Reimbursement currency. readOnly: true example: CAD reimbursementAmount: type: string description: Reimbursement amount. readOnly: true format: decimal-precision-2 example: '123.45' txnCurrency: type: string description: Transaction currency. For multi-currency companies. example: INR txnAmount: type: string description: Transaction amount. format: decimal-precision-2 example: '123.45' nullable: true totalSelected: type: string description: Amount selected to pay in transaction currency. readOnly: true format: decimal-precision-2 example: '123.45' totalPaid: type: string description: Amount paid in transaction currency. readOnly: true format: decimal-precision-2 example: '123.45' quantity: type: string description: Quantity for a rate-based expense, for example mileage. format: decimal-precision-2 example: '5.75' unitRate: type: string description: Monetary amount for a rate-based expense, such as mileage. format: decimal-precision-2 example: '20.00' paidTo: type: string description: Notes regarding to whom you paid the amount. example: Hotel Westin paidFor: type: string description: Notes regarding what the expense was for. example: Attending conference glAccount: type: object description: >- General ledger account associated with the line item. Used when no expense type is assigned. properties: key: type: string description: Unique key for the GL account. example: '158' id: type: string description: Unique identifier for the GL account. example: '6775.30' name: type: string description: Name of the GL account. readOnly: true example: Travel href: type: string description: Endpoint for the GL account object. readOnly: true example: /objects/general-ledger/account/23 expenseType: type: object description: An expense type defined in the company. properties: key: type: string description: Unique key for the expense type. example: '6000' id: type: string description: Unique identifier for the expense type. example: Meals href: type: string description: Endpoint for the expense type object. readOnly: true example: /objects/expense-type/34 lineNumber: type: number description: Line number of the employee expense. readOnly: true example: 1 reimburseToBaseConversion: type: object description: Details of reimbursement currency to base currency conversion. properties: exchangeRateDate: type: string format: date description: Date the exchange rate conversion was applied. example: '2021-01-23' readOnly: true exchangeRateTypeId: type: string description: Type of the expense line exchange rate. example: '-1' readOnly: true exchangeRate: type: string description: Value of the expense line exchange rate. readOnly: true format: decimal-precision-5 example: '1.18999' transactionToReimburseConversion: type: object description: Details of the conversion to base currency. properties: exchangeRate: type: string description: Exchange rate for the transaction. format: decimal-precision-5 example: '65' exchangeRateDate: type: string format: date example: '2025-01-23' description: Date for the exchange rate. exchangeRateTypeId: type: string description: Exchange rate type. example: '-1' state: type: string description: Status of the employee expense report line. enum: - draft - submitted - partiallyApproved - partiallyDeclined - approved - posted - declined - reversalPending - reversed - reversal - paid - confirmed - voided - partiallyPaid - saved - notApplicable - pending - readyForApproval - null default: submitted nullable: true readOnly: true example: draft isBillable: type: boolean default: false description: Indicates whether a line item is billable. example: false isBilled: type: boolean default: false description: Indicates whether a line item was billed. readOnly: true example: false form1099: type: object description: Form 1099 information for the line item. properties: isForm1099: type: string description: If set to true, the line item amount is added to the form 1099. example: 'true' type: type: string description: Type of form 1099. example: MISC box: type: string description: Box value of form 1099. example: '3' paymentType: type: object properties: key: type: string description: Unique key for the expense payment type. example: '1' id: type: string description: Unique identifier for the payment type. example: '1' name: type: string description: Name of the expense payment type. example: Non-reimburse isNonReimbursable: type: boolean default: false description: Non-reimbursable expense. example: false href: type: string readOnly: true example: /objects/projects/employee-expense-payment-type/1 audit: $ref: '#/components/schemas/audit' dimensions: type: object allOf: - $ref: '#/components/schemas/dimension-ref' - type: object properties: location: type: object properties: key: type: string description: Unique key for the location. example: '1' nullable: true id: type: string description: Unique identifier for the location. example: '1' nullable: true name: readOnly: true type: string description: Location name example: USA nullable: true href: type: string readOnly: true example: /objects/company-config/location/1 department: type: object properties: key: type: string description: Unique key for the department. example: '1' nullable: true id: type: string description: Unique identifier for the department. example: '1' nullable: true name: type: string description: Department name readOnly: true example: IT nullable: true href: type: string readOnly: true example: /objects/company-config/department/1 expenseToApprove: type: object properties: id: type: string description: Unique identifier for the expense to approve. readOnly: true example: '1' key: type: string description: Unique key for the expense to approve. readOnly: true example: '1' readOnly: true expenses-expense-to-approve: type: object description: Details of the employee expense report sent for approval. properties: key: type: string description: >- System-assigned unique key for the employee expense submitted for approval. readOnly: true example: '124' id: type: string description: >- Unique identifier for the expense to approve. This value is the same as the key for this object. readOnly: true example: '124' createdDate: type: string format: date example: '2025-01-23' description: Date the employee expense is created. nullable: false employee: type: object description: Employee who incurred the expense. nullable: false properties: key: type: string description: Unique key for the employee. example: '47' id: type: string description: Unique ID for the employee. example: EMP-025 href: type: string readOnly: true description: URL endpoint for the employee. example: /objects/company-config/employee/47 employeeContact: type: object properties: key: type: string description: Unique key for the employee contact. example: '973' id: type: string description: Unique ID of the employee contact. readOnly: true example: Thomas, Glenn firstName: type: string description: First name of the employee. readOnly: true example: Glenn lastName: type: string description: Last name of the employee. readOnly: true example: Thomas href: type: string description: Endpoint for the contact. readOnly: true example: /objects/company-config/contact/973 state: type: string description: >- Status of the employee expense. Expenses are posted to the general ledger when approved. enum: - draft - submitted - partiallyApproved - partiallyDeclined - approved - posted - declined - reversalPending - reversed - reversal - paid - confirmed - voided - partiallyPaid default: submitted example: draft basePayment: type: object description: Base payment for the employee expense report. properties: baseCurrency: type: string description: Base currency for the employee expense report. example: USD paidDate: type: string format: date example: '2021-01-23' description: Date the employee expense was fully paid. readOnly: true totalEntered: type: string description: Total transaction amount. readOnly: true example: '123.45' totalPaid: type: string description: Total amount paid. readOnly: true example: '123.45' totalDue: type: string description: Total amount due. readOnly: true example: '123.45' totalSelected: type: string description: Amount selected for reimbursement. readOnly: true example: '110.00' reimbursement: type: object description: Reimbursement properties: reimbursementCurrency: type: string description: Reimbursement currency. example: EUR totalEntered: type: string description: Total reimbursable amount. readOnly: true format: decimal-precision-2 example: '123.16' totalPaid: type: string description: Total amount paid. readOnly: true format: decimal-precision-2 example: '123.16' totalDue: type: string description: Total amount due. readOnly: true format: decimal-precision-2 example: '123.16' totalSelected: type: string description: Amount selected for reimbursement. readOnly: true format: decimal-precision-2 example: '123.16' expenseReportNumber: type: string description: Report number associated with the employee expense. example: EXP-00001 expenseSummary: type: object description: Expense summary that this expense is reported on. properties: key: type: string description: Unique key for the employee expense summary. readOnly: true example: '334' id: type: string description: Unique ID for the employee expense summary. readOnly: true example: '334' title: type: string description: Title of the expense summary. readOnly: true example: Expenses 2025/01/31 batch state: type: string description: Indicates whether the expense summary is open or closed. enum: - open - closed example: open readOnly: true default: open preventGLPosting: type: boolean default: false description: Not for GL posting. readOnly: true example: false postingDate: type: string format: date example: '2025-01-23' description: GL posting date. href: type: string readOnly: true description: Endpoint for the employee expense summary. example: /objects/projects/employee-expense-summary/334 readOnly: true nonReimbursable: type: object description: Non-reimbursable portion of the expense. properties: baseTotalEntered: type: string description: Non-reimbursable amount in base currency. readOnly: true format: decimal-precision-2 example: '123.45' reimbursementTotalEntered: type: string description: Total non-reimbursable amount. readOnly: true format: decimal-precision-2 example: '123.45' memo: type: string description: Memo. example: Paid to employee description: type: string description: Reason for the expense. example: Supplies for customer training reclassificationNotes: type: string description: Reason for the reclassification. example: Classified as supplies, not travel expense attachment: type: object description: >- An attachment for employee expenses. Can be scanned or digital receipts. properties: key: type: string description: Unique key for the attachment. example: '12' id: type: string description: Unique ID for the attachment. example: '12' href: type: string description: Endpoint for the attachment. example: /objects/company-config/attachment/12 readOnly: true entity: $ref: '#/components/schemas/entity-ref' audit: type: object allOf: - $ref: '#/components/schemas/audit' - type: object properties: createdDateTime: type: string description: Time of the submission. format: date-time example: '2014-01-08T11:28:12Z' readOnly: true lines: type: array description: Line items of the employee expense. items: $ref: '#/components/schemas/expenses-expense-to-approve-line' expenses-expense-to-approve-actions-approve-request: type: object properties: key: type: string description: System-assigned key for the expense. example: '518' expenseLineKeys: type: array description: Array of expense entry keys. example: - '1' - '2' items: type: string notes: type: string description: Notes or comments from the approver. example: Approved by John Smith. glPostingDate: type: string description: GL posting date for approved expense. example: '2025-08-02' required: - key expenses-expense-to-approve-actions-approve-response: type: object properties: key: type: string readOnly: true example: '518' id: type: string readOnly: true example: '518' href: type: string readOnly: true example: /objects/expenses/expense-to-approve/518 state: type: string description: Status of the employee expense. readOnly: true enum: - submitted - approved - partiallyApproved - partiallyDeclined example: approved expenses-expense-to-approve-actions-decline-request: type: object properties: key: type: string description: System-assigned key for the expense. example: '518' notes: type: string description: Notes or comments about the expense. example: Declined, missing information. expenseLineKeys: type: array description: Array of expense entry keys. example: - '1' - '2' items: type: string required: - key expenses-expense-to-approve-actions-decline-response: type: object properties: key: type: string readOnly: true example: '518' id: type: string readOnly: true example: '518' href: type: string readOnly: true example: /objects/expenses/expense-to-approve/518 state: type: string description: Status of the employee expense. readOnly: true enum: - submitted - declined - partiallyApproved - partiallyDeclined example: declined responses: 400error: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/error-response' securitySchemes: OAuth2: description: Sage Intacct OAuth 2.0 authorization code flow type: oauth2 flows: authorizationCode: authorizationUrl: https://api.intacct.com/ia/api/v1/oauth2/authorize tokenUrl: https://api.intacct.com/ia/api/v1/oauth2/token refreshUrl: https://api.intacct.com/ia/api/v1/oauth2/token scopes: {}