Setup posting rules

Use setup posting rules to identify the journal, useful life term, convention, and so forth, for fixed asset transactions.

List setup posting rules

get/objects/fixed-assets/setup-posting-rule

Returns a collection with a key, ID, and link for each setup posting rule. 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": "ID1",
      • "key": "1",
      • "href": "/objects/fixed-assets/setup-posting-rule/1"
      },
    • {
      • "id": "ID2",
      • "key": "2",
      • "href": "/objects/fixed-assets/setup-posting-rule/2"
      },
    • {
      • "id": "ID3",
      • "key": "3",
      • "href": "/objects/fixed-assets/setup-posting-rule/3"
      },
    • {
      • "id": "ID4",
      • "key": "4",
      • "href": "/objects/fixed-assets/setup-posting-rule/4"
      }
    ],
  • "ia::meta": {
    • "totalCount": 4,
    • "totalSuccess": 4,
    • "totalError": 0
    }
}
Create a setup posting rule
post/objects/fixed-assets/setup-posting-rule
Creates a new setup posting rule.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
id
required
string
Unique ID for the setup posting rule.


 
 Example:  "ID-1"
key
string
System-assigned unique key for the setup posting rule.


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


 
key
string
Unique key for the setup.


 
 Example:  "1"
id
string
ID for the setup.


 
 Example:  "1"
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.


 
key
string
Unique key for the journal.


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


 
 Example:  "TAX"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "journal": {
    • "key": "47"
    },
  • "setup": {
    • "key": "1"
    },
  • "id": "ID5",
  • "usefulLifeUnits": "months",
  • "convention": "fullMonth",
  • "isTax": false,
  • "useSalvageValue": false,
  • "name": "Tax Accrual Book"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "5",
    • "id": "ID5",
    • "href": "/objects/fixed-assets/setup-posting-rule/5"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a setup posting rule
get/objects/fixed-assets/setup-posting-rule/{key}
Returns detailed information for a specified setup posting rule.


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


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "setup": {
      • "id": "1",
      • "key": "1"
      },
    • "journal": {
      • "name": "IFRS-Australia",
      • "id": "IFRS-AUS",
      • "key": "43",
      • "bookId": "IFRSACCRUAL"
      },
    • "audit": {
      • "createdBy": "1",
      • "createdDateTime": "2022-09-25T01:22:00Z",
      • "modifiedBy": "1",
      • "modifiedDateTime": "2023-05-12T07:09:43Z",
      • "createdByUser": {
        },
      • "modifiedByUser": {
        }
      },
    • "convention": "fullMonth",
    • "usefulLifeUnits": "months",
    • "name": "NAME 2",
    • "useSalvageValue": true,
    • "id": "ID2",
    • "isTax": false,
    • "key": "2"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a setup posting rule
patch/objects/fixed-assets/setup-posting-rule/{key}
Updates an existing setup posting rule by setting field values. Any fields not provided remain unchanged.


Before editing a setup posting rule, ensure that there are no depreciation rules using that posting rule. Edit 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.


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


 
 Example:  99
Request Body schema: application/json
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.


 
key
string
Unique key for the setup.


 
 Example:  "1"
id
string
ID for the setup.


 
 Example:  "1"
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.


 
key
string
Unique key for the journal.


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


 
 Example:  "TAX"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "key": "42",
  • "id": "ID42",
  • "journal": {
    • "key": "1"
    },
  • "setup": {
    • "key": "1"
    },
  • "usefulLifeUnits": "months",
  • "convention": "fullMonth",
  • "isTax": false,
  • "useSalvageValue": false,
  • "name": "Tax Accrual Book"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "42",
    • "id": "ID42",
    • "href": "/objects/fixed-assets/setup-posting-rule/42"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a setup posting rule
delete/objects/fixed-assets/setup-posting-rule/{key}
Deletes a setup posting rule.


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


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


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