Setup posting rules

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

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 setup posting rules

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

Returns up to 100 object references from the collection with a key, ID, and link for each setup posting rule. 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

Subscription	Fixed Assets Management
User type	Business, Employee, Project Manager, and Warehouse
Permissions	List, View Setup Posting Rules

SecurityOAuth2

Responses

200

400

Bad Request

Request samples

curl
JavaScript
Node.js
PHP
C#

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.

Permissions and other requirements

Subscription	Fixed Assets Management
User type	Business
Permissions	Add Setup Posting Rule

SecurityOAuth2

Request

Request Body schema: application/json

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"
},
"faSetup": {"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.

Permissions and other requirements

Subscription	Fixed Assets Management
User type	Business, Employee, Project Manager, and Warehouse
Permissions	List, View Setup Posting Rules

SecurityOAuth2

Request

path Parameters

key

required

string

System-assigned key for the setup posting rule.

Responses

200

400

Bad Request

Request samples

curl
JavaScript
Node.js
PHP
C#

Response samples

application/json

{"ia::result": {"faSetup": {"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"
},
"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.

Permissions and other requirements

Subscription	Fixed Assets Management
User type	Business
Permissions	Edit Setup Posting Rule

SecurityOAuth2

Request

path Parameters

key

required

string

System-assigned key for the setup posting rule.

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

400

Bad Request

Request samples

application/json

{"key": "42",
"id": "ID42",
"journal": {"key": "1"
},
"faSetup": {"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.

Permissions and other requirements

Subscription	Fixed Assets Management
User type	Business
Permissions	null

SecurityOAuth2

Request

path Parameters

key

required

string

System-assigned key for the setup posting rule.

Responses

204

No Content

400

Bad Request

Request samples

curl
JavaScript
Node.js
PHP
C#

Response samples

application/json

{"ia::result": {"ia::error": {"code": "invalidRequest",
"message": "A POST request requires a payload",
"errorId": "REST-1028",
"additionalInfo": {"messageId": "IA.REQUEST_REQUIRES_A_PAYLOAD",
"placeholders": {"OPERATION": "POST"
},
"propertySet": { }
},
"supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
}
},
"ia::meta": {"totalCount": 1,
"totalSuccess": 0,
"totalError": 1
}
}

Query setup posting rules

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-posting-rule"

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

400

Bad Request

Request samples

application/json

{"object": "accounts-payable/vendor",
"fields": ["id",
"name",
"status",
"href"
],
"filters": [{"$eq": {"status": "active"
}
},
{"$eq": {"billingType": "openItem"
}
}
],
"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
}
}