Setups

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

List setups

get/objects/fixed-assets/setup

Returns a collection with a key, ID, and link for each setup. 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": {
    • "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.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
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
historicalAccumulatedDepreciationType
string
 Default:  "system"
Represents the options for calculating asset's historical accumulated depreciation amount:


    

  • system: the system will calculate the amount automatically.
    • 

  • manual: the user will provide the amount.
    • 



 Enum: "manual" "system"  
 Example:  "system"
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.


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


 
 Example:  99
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": {
      • "createdBy": "1",
      • "createdDateTime": "2022-09-22T01:00:18Z",
      • "modifiedBy": "1",
      • "modifiedDateTime": "2023-04-06T06:15:48Z",
      • "createdByUser": {
        },
      • "modifiedByUser": {
        }
      },
    • "enableAutoPosting": false,
    • "enableAccountsPayable": false,
    • "enablePurchasingTxns": false,
    • "goLiveDate": "2021-12-16",
    • "historicalAccumulatedDepreciationType": "system",
    • "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.


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


 
 Example:  99
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
historicalAccumulatedDepreciationType
string
 Default:  "system"
Represents the options for calculating asset's historical accumulated depreciation amount:


    

  • system: the system will calculate the amount automatically.
    • 

  • manual: the user will provide the amount.
    • 



 Enum: "manual" "system"  
 Example:  "system"
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.


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


 
 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
    }
}