A budget detail is a unique combination of account, department, location, and reporting period. (Department and location are optional.) If you want to track travel expenses for 3 locations, you would need 3 budget detail objects per reporting period:
A budget-detail
object corresponds to what is seen on the Budget amount details page for a specific reporting period in Sage Intacct.
Note: budget-detail
objects can only be created and updated through the owning budget
object.
Returns up to 100 budget details from the collection with a key, ID, and link for each budget detail object. This operation is mostly for use in testing; use the query service to find budget details that meet certain criteria and to specify the properties that you want in the response.
Subscription | General Ledger |
---|---|
User type | Business, Employee, Approver |
Permissions | List, View Budgets |
OK
Bad Request
{- "ia::result": [
- {
- "key": "284",
- "id": "284",
- "href": "/objects/general-ledger/budget-detail/284"
}, - {
- "key": "285",
- "id": "285",
- "href": "/objects/general-ledger/budget-detail/285"
}, - {
- "key": "286",
- "id": "286",
- "href": "/objects/general-ledger/budget-detail/286"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}
Returns detailed information for a specified budget detail.
Subscription | General Ledger |
---|---|
User type | Business, Employee, Approver |
Permissions | List, View Budgets |
key required | string System-assigned key for the budget detail. Example: 153 |
OK
Bad Request
{- "ia::result": {
- "id": "13",
- "key": "13",
- "budget": {
- "key": "2",
- "id": "Proj-budget",
- "href": "/objects/general-ledger/budget/2"
}, - "currency": {
- "txnCurrency": null
}, - "reportingPeriod": {
- "key": "127",
- "id": "Month ended January 2023",
- "name": "Month ended January 2023",
- "href": "/objects/general-ledger/reporting-period/127"
}, - "glAccount": {
- "key": "279",
- "id": "9501",
- "name": "Labor Costing - Billable",
- "href": "/objects/general-ledger/account/279"
}, - "dimensions": {
- "department": {
- "key": null,
- "id": null,
- "name": null
}, - "location": {
- "key": null,
- "id": null,
- "name": null
}, - "class": {
- "key": null,
- "id": null,
- "name": null
}, - "item": {
- "key": null,
- "id": null,
- "name": null
}, - "customer": {
- "key": null,
- "id": null,
- "name": null
}, - "vendor": {
- "key": null,
- "id": null,
- "name": null
}, - "project": {
- "key": null,
- "id": null,
- "name": null
}, - "employee": {
- "key": null,
- "id": null,
- "name": null
}, - "warehouse": {
- "key": null,
- "id": null,
- "name": null
}, - "task": {
- "key": null,
- "id": null,
- "name": null
}
}, - "amount": "1000.00",
- "budgetGrowth": {
- "basedOn": "budget",
- "growBy": null,
- "perPeriod": "percentage"
}, - "notes": "Notes",
- "href": "/objects/general-ledger/budget-detail/13"
}, - "ia::meta": {
- "totalCount": 1
}
}
Deletes a budget detail
Subscription | General Ledger |
---|---|
User type | Business User |
Permissions | Delete Budgets |
key required | string System-assigned key for the budget detail. Example: 153 |
No Content
Bad Request
{- "ia::result": {
- "ia::error": {
- "code": "invalidRequest",
- "message": "Payload contains errors",
- "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
- "errorId": "REST-1064",
- "additionalInfo": {
- "messageId": "IA.PAYLOAD_CONTAINS_ERRORS",
- "placeholders": { },
- "propertySet": { }
}, - "details": [
- {
- "code": "invalidRequest",
- "message": "/testDate is not a valid field",
- "errorId": "REST-1043",
- "target": "/testDate",
- "additionalInfo": {
- "messageId": "IA.NOT_A_VALID_FIELD",
- "placeholders": {
- "FIELD": "/testDate"
}, - "propertySet": { }
}
}
]
}, - "ia::meta": {
- "totalCount": 3,
- "totalSuccess": 2,
- "totalError": 1
}
}, - "ia::error": {
- "code": "invalidRequest",
- "message": "Malformed URL",
- "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
- "details": [
- {
- "code": "invalidRequest",
- "message": "The content type is not valid",
- "correction": "TODO"
}
]
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "general-ledger/budget-detail" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
Example: ["key","id","max:vendor.creditLimit"] | ||||||||
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object) Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as Example: [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}] | |||||||||
Array Any of: Field value must be equal to this specified value. For date fields, you can use these macro values that are relative to the current date or the
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
Array of objects Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order. Example: [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}] | |||||||||
Array
| |||||||||
start | integer First record of the result set to include in the response. Example: 1 | ||||||||
size | integer Number of records to include in the response. Example: 100 |
OK
Bad Request
{- "object": "general-ledger/budget-detail",
- "filters": [
- {
- "$eq": {
- "budget.key": "4"
}
}
], - "fields": [
- "key",
- "id",
- "dimensions.location.id"
], - "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "key": "37",
- "id": "37",
- "dimensions.location.id": "WEN"
}, - {
- "key": "41",
- "id": "41",
- "dimensions.location.id": "PNW"
}
], - "ia::meta": {
- "totalCount": 2,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}