Setups

Set up configuration details for the Fixed Assets Management application. Settings apply to all entities.

Please be aware that this object is currently "Uncertified", signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

List setups

get/objects/fixed-assets/setup

Returns up to 100 object references from the collection with a key, ID, and link for each setup. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

Permissions and other requirements
SubscriptionFixed Assets Management
User typeBusiness, Employee, Project Manager, and Warehouse
PermissionsList, View Setups
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "1",
    • "key": "1",
    • "href": "/objects/fixed-assets/setup/1"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Create a setup
post/objects/fixed-assets/setup
Creates a new setup.



Permissions and other requirements



SubscriptionFixed Assets Management


User typeBusiness


PermissionsAdd Setup







SecurityOAuth2 
Request 
Request Body schema: application/json
id
string
System-assigned unique ID for the setup.


 
 Example:  "1"
goLiveDate
string <date> 
The date when historical assets begin to depreciate in Sage Intacct.


Historical assets are assets that were partially depreciated in a different accounting system, outside of Sage Intacct.


The go-live must come after all periods that were historically posted outside of Sage Intacct, and on or before all periods that have not yet posted.
You can update the go-live date as long as it falls within the valid range. To avoid conflicts, set up your go-live date before adding assets to Sage Intacct.


 
 Example:  "2020-01-01"
enableAutoPosting
boolean
 Default:  false
Indicates whether automatic posting of depreciation schedule entries is enabled.


 
 Example:  true
enableAccountsPayable
boolean
 Default:  false
Indicates whether Accounts Payable integration is enabled.


 
 Example:  true
enablePurchasingTxns
boolean
 Default:  false
Indicates whether Purchasing Transactions integration is enabled.


 
 Example:  false
object
Determines the automatic numbering and formatting of new asset IDs.


 
key
string
Key for the asset sequence.


 
 Example:  "107"
id
string
ID for the asset sequence.


 
 Example:  "BOA_ACH_BatchNo"
object
The General Ledger account where the gain or loss on disposal amount is recorded as a debit or credit.


The account must be active and non-statistical.


 
key
string
System-assigned key for the gain loss GL account.


 
 Example:  "94"
id
string
ID for the gain loss GL account.


 
 Example:  "1501"
object
The journal where transactions related to Fixed Assets Management are recorded. Use an active and non-statistical journal.
The journal configured in setup is used for non-depreciable assets.


 
key
string
Unique key for the journal.


 
 Example:  "46"
id
string
ID for the journal.


 
 Example:  "TAX"
Array of objects
Setup posting rules identify journal, useful life units, convention, and so forth for fixed asset transactions.


Before updating a setup posting rule, ensure that there are no depreciation rules using that posting rule. Update the depreciation rule on the classification or asset to temporarily remove the posting rule first. 
For more information, see classification depreciation rule or asset depreciation rule.


 
 Array 
key
string
System-assigned unique key for the setup posting rule.


 
 Example:  "1"
id
string
Unique ID for the setup posting rule.


 
 Example:  "ID-1"
name
string
Name for the setup posting rule.


 
 Example:  "Accrual"
usefulLifeUnits
string
 Default:  "months"
Denotes if the useful life is specified in months or years. The units of useful life must match the convention.


 Enum: "months" "years"  
 Example:  "months"
convention
string
 Default:  "fullMonth"
The convention determines how depreciation is calculated in the first and last periods of an asset's life.


 Enum: "fullMonth" "fullYear" "halfYear"  
 Example:  "fullMonth"
isTax
boolean
 Default:  false
Indicates whether this posting rule applies for tax purposes.


 
 Example:  true
useSalvageValue
boolean
 Default:  true
Indicates whether the salvage value should be used to calculate the depreciation expense of an asset.


 
 Example:  false
object
Provides configuration details for the Fixed Assets Management application.


 
object
The journal where transactions related to Fixed Assets Management are recorded. Use an active and non-statistical journal.


When creating multiple journal posting rules, each rule must use a different journal, and each journal must belong to a different book.


 
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "enableAutoPosting": false,
  • "journal": {
    • "key": "46"
    },
  • "setupPostingRules": [
    • {
      • "journal": {
        },
      • "usefulLifeUnits": "months",
      • "convention": "fullMonth",
      • "isTax": true,
      • "useSalvageValue": false,
      • "name": "Tax Accrual Book"
      },
    • {
      • "journal": {
        },
      • "usefulLifeUnits": "years",
      • "convention": "halfYear",
      • "isTax": false
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "ID1",
    • "href": "/objects/fixed-assets/setup/1"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a setup
get/objects/fixed-assets/setup/{key}
Returns detailed information for a specified setup.



Permissions and other requirements



SubscriptionFixed Assets Management


User typeBusiness, Employee, Project Manager, and Warehouse


PermissionsList, View Setups







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the setup.


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "journal": {
      • "name": "TAX Accrual Book",
      • "id": "TAX",
      • "key": "46"
      },
    • "gainLossGLAccount": {
      • "name": "Investments in other Companies",
      • "id": "1906",
      • "key": "103"
      },
    • "assetSequence": {
      • "id": "ASSET",
      • "printTitle": "ASSET",
      • "key": "34"
      },
    • "setupPostingRules": [
      • {
        },
      • {
        },
      • {
        },
      • {
        },
      • {
        }
      ],
    • "audit": {
      • "createdDateTime": "2022-09-22T01:00:18Z",
      • "modifiedBy": "1",
      • "modifiedDateTime": "2023-04-06T06:15:48Z"
      },
    • "enableAutoPosting": false,
    • "enableAccountsPayable": false,
    • "enablePurchasingTxns": false,
    • "goLiveDate": "2021-12-16",
    • "id": "117",
    • "key": "117"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a setup
patch/objects/fixed-assets/setup/{key}
Updates an existing setup by setting field values. Any fields not provided remain unchanged.



Permissions and other requirements



SubscriptionFixed Assets Management


User typeBusiness


PermissionsEdit Setup







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the setup.


 
Request Body schema: application/json
goLiveDate
string <date> 
The date when historical assets begin to depreciate in Sage Intacct.


Historical assets are assets that were partially depreciated in a different accounting system, outside of Sage Intacct.


The go-live must come after all periods that were historically posted outside of Sage Intacct, and on or before all periods that have not yet posted.
You can update the go-live date as long as it falls within the valid range. To avoid conflicts, set up your go-live date before adding assets to Sage Intacct.


 
 Example:  "2020-01-01"
enableAutoPosting
boolean
 Default:  false
Indicates whether automatic posting of depreciation schedule entries is enabled.


 
 Example:  true
enableAccountsPayable
boolean
 Default:  false
Indicates whether Accounts Payable integration is enabled.


 
 Example:  true
enablePurchasingTxns
boolean
 Default:  false
Indicates whether Purchasing Transactions integration is enabled.


 
 Example:  false
object
Determines the automatic numbering and formatting of new asset IDs.


 
key
string
Key for the asset sequence.


 
 Example:  "107"
id
string
ID for the asset sequence.


 
 Example:  "BOA_ACH_BatchNo"
object
The General Ledger account where the gain or loss on disposal amount is recorded as a debit or credit.


The account must be active and non-statistical.


 
key
string
System-assigned key for the gain loss GL account.


 
 Example:  "94"
id
string
ID for the gain loss GL account.


 
 Example:  "1501"
object
The journal where transactions related to Fixed Assets Management are recorded. Use an active and non-statistical journal.
The journal configured in setup is used for non-depreciable assets.


 
key
string
Unique key for the journal.


 
 Example:  "46"
id
string
ID for the journal.


 
 Example:  "TAX"
Array of objects
Setup posting rules identify journal, useful life units, convention, and so forth for fixed asset transactions.


Before updating a setup posting rule, ensure that there are no depreciation rules using that posting rule. Update the depreciation rule on the classification or asset to temporarily remove the posting rule first. 
For more information, see classification depreciation rule or asset depreciation rule.


 
 Array 
key
string
System-assigned unique key for the setup posting rule.


 
 Example:  "1"
id
string
Unique ID for the setup posting rule.


 
 Example:  "ID-1"
name
string
Name for the setup posting rule.


 
 Example:  "Accrual"
usefulLifeUnits
string
 Default:  "months"
Denotes if the useful life is specified in months or years. The units of useful life must match the convention.


 Enum: "months" "years"  
 Example:  "months"
convention
string
 Default:  "fullMonth"
The convention determines how depreciation is calculated in the first and last periods of an asset's life.


 Enum: "fullMonth" "fullYear" "halfYear"  
 Example:  "fullMonth"
isTax
boolean
 Default:  false
Indicates whether this posting rule applies for tax purposes.


 
 Example:  true
useSalvageValue
boolean
 Default:  true
Indicates whether the salvage value should be used to calculate the depreciation expense of an asset.


 
 Example:  false
object
Provides configuration details for the Fixed Assets Management application.


 
object
The journal where transactions related to Fixed Assets Management are recorded. Use an active and non-statistical journal.


When creating multiple journal posting rules, each rule must use a different journal, and each journal must belong to a different book.


 
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "setupPostingRules": [
    • {
      • "journal": {
        },
      • "key": "1",
      • "convention": "fullMonth",
      • "usefulLifeUnits": "months",
      • "isTax": false,
      • "useSalvageValue": true,
      • "name": "new name"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "1",
    • "href": "/objects/fixed-assets/setup/1"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a setup
delete/objects/fixed-assets/setup/{key}
This operation is not supported.



Permissions and other requirements



SubscriptionFixed Assets Management


User typeBusiness


Permissionsnull







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the setup.


 
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
    }
}
Query setups
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "fixed-assets/setup"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 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 {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 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 asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
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 
property name*
additional property
string
 Enum: "asc" "desc"  
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
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "accounts-payable/vendor",
  • "fields": [
    • "id",
    • "name",
    • "status",
    • "href"
    ],
  • "filters": [
    • {
      • "$eq": {
        }
      },
    • {
      • "$eq": {
        }
      }
    ],
  • "filterExpression": "1 and 2",
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "id": "Vend-00002",
      • "name": "Test vendor",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/85"
      },
    • {
      • "id": "VEND-00010",
      • "name": "Design Works",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/111"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}