Employee expense summaries

Expense summaries are collections of the same type of transactions, grouped together for processing. Expense summaries are referenced by employee expense objects. For more information, see Add, edit, or delete expense summaries in the Sage Intacct Help Center.

List employee expense summaries

get/objects/expenses/employee-expense-summary

Returns a collection with a key, ID, and link for each expense summary. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "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
    }
}
Create an employee expense summary
post/objects/expenses/employee-expense-summary
Creates a new employee expense summary.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
Employee expense summary to create


name
required
string
Title of the summary.


 
 Example:  "Expenses - Expenses (USD) Q3 Batch"
postingDate
required
string <date> 
The GL posting date for the expense summary.


 
 Example:  "2021-01-23"
state
string
 Default:  "open"
State of the employee expense summary.


 Enum: "closed" "open"  
 Example:  "open"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "name": "Expenses (USD) Q1 Batch",
  • "title": "Expenses (USD) Q1 Batch",
  • "postingDate": "2021-01-23",
  • "totalAmount": "100",
  • "recordType": "expense",
  • "status": "active"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "10",
    • "id": "10",
    • "href": "/objects/expenses/employee-expense-summary/10"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get an employee expense summary
get/objects/expenses/employee-expense-summary/{key}
Returns detailed information for a specified employee expense summary.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the employee expense summary.


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "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
    }
}
Update an employee expense summary
patch/objects/expenses/employee-expense-summary/{key}
Updates an existing employee expense summary by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the employee expense summary.


 
 Example:  99
Request Body schema: application/json
name
string
Title of the summary.


 
 Example:  "Expenses - Expenses (USD) Q3 Batch"
postingDate
string <date> 
The GL posting date for the expense summary.


 
 Example:  "2021-01-23"
state
string
 Default:  "open"
State of the employee expense summary.


 Enum: "closed" "open"  
 Example:  "open"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "name": "Expense report for January"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "124",
    • "id": "124",
    • "href": "/objects/expenses/employee-expense-summary/124"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete an employee expense summary
delete/objects/expenses/employee-expense-summary/{key}
Deletes an employee expense summary.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the employee expense summary.


 
 Example:  99
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}