Add employee expenses to the specified pay run.
POST https://api.yourpayroll.com.au/api/v2/business/{businessId}/payrun/{payRunId}/EmployeeExpenses
Parameter name | Value | Description | Additional |
---|---|---|---|
payRunId | int32 | Required | |
businessId | string | Required |
The request body takes a complete SubmitPayRunEmployeeExpenseRequest resource, containing the following writable properties:
{
"employeeExpenseCategoryIdType": "string",
"employeeIdType": "string",
"expenses": {
"<key>": "array"
},
"locationIdType": "string",
"payRunId": "int32",
"replaceExisting": "boolean",
"suppressCalculations": "boolean"
}
Name | Type | Description |
---|---|---|
employeeExpenseCategoryIdType | string |
IdType
Possible values are:
|
employeeIdType | string |
IdType
Possible values are:
|
expenses | object |
Dictionary |
expenses.<key> | map of array |
List |
expenses.<key>.amount | double | Decimal |
expenses.<key>.employeeExpenseCategoryId | string | String |
expenses.<key>.employeeExpenseCategoryName | string | String |
expenses.<key>.employeeExternalId | string | String |
expenses.<key>.employeeId | string | String |
expenses.<key>.employeeName | string | String |
expenses.<key>.externalId | string | String |
expenses.<key>.id | int32 | Int32 |
expenses.<key>.locationId | string | String |
expenses.<key>.locationName | string | String |
expenses.<key>.notes | string | String |
expenses.<key>.reportingDimensionValueIds[] | array of int32 |
Nullable Note: Only applicable to businesses where the Dimensions feature is enabled. Specify an array of dimension value ids (normally only one-per dimension) eg [1,3,7]. If you prefer to specify dimension values by name, use the ReportingDimensionValueNames field instead. If this field is used, ReportingDimensionValueNames will be ignored (the Ids take precedence) |
expenses.<key>.reportingDimensionValueNames | object |
Nullable Note: Only applicable to businesses where the Dimensions feature is enabled. Specify an object with dimension names and for each one, specify an array of associated value names (normally one-per dimension) eg { "Department": ["Accounting"], "Job Code": ["JC1"] }. If you prefer to specify dimension values directly by Id, use the ReportingDimensionValueIds field instead. If ReportingDimensionValueIds is used, ReportingDimensionValueNames will be ignored (the Ids take precedence) |
expenses.<key>.reportingDimensionValueNames.<key>[] | array of string | |
expenses.<key>.taxCode | string | String |
expenses.<key>.taxCodeDisplayName | string | String |
expenses.<key>.taxRate | double |
Nullable |
locationIdType | string |
IdType
Possible values are:
|
payRunId | int32 | Int32 |
replaceExisting | boolean | Boolean |
suppressCalculations | boolean | Boolean |
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK OK |
Powered by DapperDox