openapi: 3.0.3
info:
title: Fixed Assets
description: |
Fixed assets are assets that used to be broken but have been repaired.
version: '1.0'
servers:
- url: https://api.intacct.com/ia/api/v1
description: Early Adopter
tags:
- name: Asset classifications
description: >-
Asset classifications contain information about General Ledger (GL)
accounts and depreciation rules.
Use asset classifications to ensure consistent treatment of similar
assets.
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.
x-displayName: Asset classifications
- name: Asset depreciation rules
description: >-
Depreciation rules contain information about the depreciation method,
convention, and useful life for an asset, which are used to calculate
depreciation for an asset.
When you assign a classification to an asset, the classification's
depreciation rules are copied over to the asset. You can then create,
update, or delete the depreciation rules on the asset to customize them as
needed.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.
x-displayName: Asset depreciation rules
- name: Assets
description: >-
Assets are resources used in the operations of a business, such as
buildings, manufacturing equipment, office equipment, furniture, fixtures,
and vehicles.
The asset object holds information about the asset, including the
in-service date, asset cost, and dimensions required to post to the GL.
These properties are used to automatically generate depreciation
schedules. From period to period, post your depreciation schedule entries
until the asset is fully depreciated or disposed.
The Fixed Assets Management application supports both depreciable and
non-depreciable assets. Assets that are not depreciable do not have
depreciation schedules.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.
x-displayName: Assets
- name: Classification depreciation rules
description: >-
Depreciation rules contain information about the depreciation method,
convention, and useful life for an asset.
Depreciation rules in a classification serve as a standard default for how
assets in that
classification are treated. However, you can override the depreciation
rules at the asset level.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.
x-displayName: Classification depreciation rules
- name: Depreciation methods
description: >-
Depreciation methods determine how an asset's depreciation expense is
computed into periods over its useful life.
The following depreciation methods are supported: Straight line, Daily,
150% declining balance, 200% declining balance,
Custom declining balance with true-up, and Custom declining balance
without true-up.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.
x-displayName: Depreciation methods
- name: Depreciation schedule entries
description: >-
Line items in a [depreciation
schedule](/openapi/fa/fixed-assets.depreciation-schedule/tag/Depreciation-schedules),
which denote the amount and posting date of depreciation entries for an
asset.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.
x-displayName: Depreciation schedule entries
- name: Depreciation schedules
description: >-
Depreciation schedule tracks the loss in value of an asset over the period
of its useful life using a specified [depreciation
rule](/openapi/fa/fixed-assets.asset-depreciation-rule/tag/Asset-depreciation-rules).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.
x-displayName: Depreciation schedules
- name: Setup posting rules
description: >-
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.
x-displayName: Setup posting rules
- name: Setups
description: >-
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.
x-displayName: Setups
paths:
/objects/fixed-assets/asset-classification:
get:
summary: List asset classifications
description: >+
Returns up to 100 object references from the collection with a key, ID,
and link for each asset classification. 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 Asset
Classification |
tags:
- Asset classifications
operationId: list-fixed-assets-classification
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of asset-classification objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List asset classifications:
value:
ia::result:
- key: '101'
id: Classification Id 101
href: /objects/fixed-assets/asset-classification/101
- key: '102'
id: Classification Id 102
href: /objects/fixed-assets/asset-classification/102
- key: '103'
id: Classification Id 103
href: /objects/fixed-assets/asset-classification/103
ia::meta:
totalCount: 3
totalSuccess: 3
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create an asset classification
description: >+
Creates a new asset classification.
Permissions and other requirements
Subscription | Fixed Assets Management |
User type | Business |
Permissions | Create Asset
Classifications |
tags:
- Asset classifications
operationId: post-fixed-assets-classification
requestBody:
description: Creates an asset classification
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/fixed-assets-asset-classification'
- $ref: '#/components/schemas/classificationRequiredProperties'
examples:
Create an asset classification:
value:
name: Furniture & Fixtures
id: Classification Id 100
status: active
assetGLAccount:
key: '29'
id: '1014'
title: Shared Banks
accumulatedDepreciationGLAccount:
key: '9'
id: '1000'
title: Bank of America A/c.
depreciationExpenseGLAccount:
key: '194'
id: '4000'
title: Sales
disposalGLAccount:
key: '101'
id: '1904'
title: Computer Equipment
depreciationRules:
- postingRule:
key: '1'
depreciationMethod:
key: '-1'
usefulLife: 60
- postingRule:
key: '2'
depreciationMethod:
key: '-2'
usefulLife: 12
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New asset-classification object
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New asset classification:
value:
ia::result:
key: '981'
id: Classification Id 100
href: /objects/fixed-assets/asset-classification/981
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/fixed-assets/asset-classification/{key}:
parameters:
- name: key
description: System-assigned key for the asset classification.
in: path
required: true
schema:
type: string
get:
summary: Get an asset classification
description: >+
Returns detailed information for a specified asset classification.
Permissions and other requirements
Subscription | Fixed Assets Management |
User type | Business, Employee, Project Manager,
and Warehouse |
Permissions | List, View Asset
Classification |
tags:
- Asset classifications
operationId: get-fixed-assets-classification-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the asset-classification object
properties:
ia::result:
$ref: '#/components/schemas/fixed-assets-asset-classification'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Details of the asset classification:
value:
ia::result:
name: Furniture & Fixtures
id: Classification Id 100
key: '100'
status: active
assetGLAccount:
key: '29'
id: '1014'
title: Shared Banks
accumulatedDepreciationGLAccount:
key: '9'
id: '1000'
title: Bank of America A/c.
depreciationExpenseGLAccount:
key: '194'
id: '4000'
title: Sales
disposalGLAccount:
key: '101'
id: '1904'
title: Computer Equipment
depreciationRules:
- depreciationMethod:
name: Straight line
id: SL
key: '-1'
journal:
id: GAAP
title: GAAP Accrual Book
key: '45'
classification:
id: Classification Id 100
key: '100'
id: '818'
key: '818'
usefulLife: 60
- depreciationMethod:
name: 200% declining balance
id: 200DB
key: '-2'
journal:
id: TAX
title: TAX Accrual Book
key: '46'
classification:
id: Classification Id 100
key: '100'
id: '824'
key: '824'
usefulLife: 12
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update an asset classification
description: >+
Updates an existing asset classification by setting field values. Any
fields not provided remain unchanged.
Permissions and other requirements
Subscription | Fixed Assets Management |
User type | Business |
Permissions | Edit Asset
Classifications |
tags:
- Asset classifications
operationId: patch-fixed-assets-classification-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/fixed-assets-asset-classification'
- type: object
examples:
Update an asset classification:
value:
name: Updated Furniture
id: Classification Id 100
accumulatedDepreciationGLAccount:
key: '10'
depreciationExpenseGLAccount:
key: '11'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated asset-classification object
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated asset classification:
value:
ia::result:
key: '981'
id: Classification Id 100
href: /objects/fixed-assets/asset-classification/981
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete an asset classification
description: |+
Deletes an asset classification.
Permissions and other requirements
Subscription | Fixed Assets Management |
User type | Business |
Permissions | null |
tags:
- Asset classifications
operationId: delete-fixed-assets-classification-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/fixed-assets/asset-depreciation-rule:
get:
summary: List asset depreciation rules
description: >+
Returns up to 100 object references from the collection with a key, ID,
and link for each asset depreciation 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 Asset Depreciation
Rules |
tags:
- Asset depreciation rules
operationId: list-fixed-assets-asset-depreciation-rule
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List asset-depreciation-rule objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List asset depreciation rules:
value:
ia::result:
- id: '80'
key: '80'
href: /objects/fixed-assets/asset-depreciation-rule/80
- id: '81'
key: '81'
href: /objects/fixed-assets/asset-depreciation-rule/81
- id: '82'
key: '82'
href: /objects/fixed-assets/asset-depreciation-rule/82
ia::meta:
totalCount: 3
totalSuccess: 3
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create an asset depreciation rule
description: >+
Creates a new asset depreciation rule.
Permissions and other requirements
Subscription | Fixed Assets Management |
User type | Business |
Permissions | Add Asset Depreciation
Rules |
operationId: post-fixed-assets-asset-depreciation-rule
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/fixed-assets-asset-depreciation-rule'
- $ref: '#/components/schemas/asset-depreciation-ruleRequiredProperties'
examples:
Create an asset depreciation rule:
value:
key: '2'
id: '2'
depreciationMethod:
name: Straight line
id: SL
key: '-1'
postingRule:
key: '1'
id: '1'
asset:
key: '2'
id: CE_ASSET-1
usefulLife: 5
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New asset-depreciation-rule
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New asset-depreciation-rule:
value:
ia::result:
key: '871'
id: '871'
href: /objects/fixed-assets/asset-depreciation-rule/871
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
tags:
- Asset depreciation rules
security:
- OAuth2: []
/objects/fixed-assets/asset-depreciation-rule/{key}:
parameters:
- name: key
description: System-assigned key for the asset depreciation rule.
in: path
required: true
schema:
type: string
get:
summary: Get an asset depreciation rule
description: >+
Returns detailed information for a specified asset depreciation rule.
Permissions and other requirements
Subscription | Fixed Assets Management |
User type | Business, Employee, Project Manager,
and Warehouse |
Permissions | List, View Asset Depreciation
Rules |
operationId: get-fixed-assets-asset-depreciation-rule-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the asset-depreciation-rule
properties:
ia::result:
$ref: '#/components/schemas/fixed-assets-asset-depreciation-rule'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
List details of the asset depreciation rule:
value:
ia::result:
depreciationMethod:
name: Straight line
id: SL
key: '-1'
asset:
name: Asset Name _~!@#$%^*()_+=-`1682315965
id: Asset Id 1682315965
key: '860'
depreciationSchedule:
key: '387'
postingRule:
name: NAME 1
id: ID1
key: '1'
audit:
createdBy: '1'
createdDateTime: '2023-04-24T05:59:27Z'
modifiedBy: '1'
modifiedDateTime: '2023-04-24T05:59:27Z'
id: '1009'
key: '1009'
usefulLife: 5
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
tags:
- Asset depreciation rules
security:
- OAuth2: []
patch:
summary: Update an asset depreciation rule
description: >+
Updates an existing asset depreciation rule by setting field values. Any
fields not provided remain unchanged.
Permissions and other requirements
Subscription | Fixed Assets Management |
User type | Business |
Permissions | Edit Asset Depreciation
Rules |
operationId: patch-fixed-assets-asset-depreciation-rule-key
requestBody:
content:
application/json:
schema:
type: object
properties:
key:
readOnly: true
id:
readOnly: true
examples:
Update an asset depreciation rule:
value:
depreciationMethod:
id: DB
key: '-2'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated asset-depreciation-rule
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated asset depreciation rule:
value:
ia::result:
key: '1021'
id: '1021'
href: /objects/fixed-assets/asset-depreciation-rule/1021
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
tags:
- Asset depreciation rules
security:
- OAuth2: []
delete:
summary: Delete an asset depreciation rule
description: >+
Deletes an asset depreciation rule.
Permissions and other requirements
Subscription | Fixed Assets Management |
User type | Business |
Permissions | Delete Asset Depreciation
Rules |
operationId: delete-fixed-assets-asset-depreciation-rule-key
responses:
'204':
description: No Content
headers: {}
'400':
$ref: '#/components/responses/400error'
tags:
- Asset depreciation rules
security:
- OAuth2: []
/objects/fixed-assets/asset:
get:
summary: List assets
description: >+
Returns up to 100 object references from the collection with a key, ID,
and link for each asset. 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 Assets |
tags:
- Assets
operationId: list-fixed-assets-asset
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of asset objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List assets:
value:
ia::result:
- key: '2'
id: CE_ASSET-2
href: /objects/fixed-assets/asset/2
- key: '3'
id: CE_ASSET-3
href: /objects/fixed-assets/asset/3
- key: '4'
id: VEH_ASSET-1
href: /objects/fixed-assets/asset/4
ia::meta:
totalCount: 3
totalSuccess: 3
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create an asset
description: |+
Creates a new asset.
Permissions and other requirements
Subscription | Fixed Assets Management |
User type | Business |
Permissions | Add Asset |
tags:
- Assets
operationId: post-fixed-assets-asset
requestBody:
description: Creates an asset
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/fixed-assets-asset'
- $ref: '#/components/schemas/assetRequiredProperties'
examples:
Create an asset:
value:
id: CE_ASSET-1
name: Laptop
serialNumber: CE_ASSET-1
assetTag: ASSET_TAG-0001
state: inService
inServiceDate: '2021-03-15'
status: active
assetCost: '5000'
salvageValue: '200'
acquisitionDate: '2020-04-22'
isDepreciable: true
description: Lenovo ThinkPad
dimensions:
location:
key: '1'
classification:
key: '3'
allocation:
key: '1'
depreciationRules:
- postingRule:
key: '1'
depreciationMethod:
key: '-1'
usefulLife: 5
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New asset
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New asset:
value:
ia::result:
key: '11'
id: CE_ASSET-2
href: /objects/fixed-assets/asset/11
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/fixed-assets/asset/{key}:
parameters:
- name: key
description: System-assigned key for the asset.
in: path
required: true
schema:
type: string
get:
summary: Get an asset
description: >+
Returns detailed information for a specified asset.
Permissions and other requirements
Subscription | Fixed Assets Management |
User type | Business, Employee, Project Manager,
and Warehouse |
Permissions | List, View Assets |
tags:
- Assets
operationId: get-fixed-assets-asset-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the asset
properties:
ia::result:
$ref: '#/components/schemas/fixed-assets-asset'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Details of the asset:
value:
ia::result:
accumulatedDepreciationGLAccount:
name: Accumulated Depreciation
id: '1901'
title: Accumulated Depreciation
key: '98'
depreciationExpenseGLAccount:
name: Depreciation Expense
id: '6350'
key: '270'
assetGLAccount:
name: Computer Equipment
id: '1500'
key: '93'
classification:
name: Computer Equipment
id: CE-1
key: '3'
depreciationRules:
- depreciationMethod:
name: Straight line
id: SL
key: '-1'
asset:
name: Laptop
id: CE_ASSET-1
key: '2'
depreciationSchedule:
key: '1'
postingRule:
name: NAME 3
id: ID3
key: '3'
audit:
createdBy: '1'
createdDateTime: '2022-11-02T05:12:15Z'
modifiedBy: '1'
modifiedDateTime: '2022-11-02T05:12:19Z'
id: '9'
key: '9'
usefulLife: 36
- depreciationMethod:
name: Straight line
id: SL
key: '-1'
asset:
name: Laptop
id: CE_ASSET-1
key: '2'
depreciationSchedule:
key: '2'
postingRule:
name: NAME 2
id: ID2
key: '2'
audit:
createdBy: '1'
createdDateTime: '2022-11-02T05:12:15Z'
modifiedBy: '1'
modifiedDateTime: '2022-11-02T05:12:19Z'
id: '10'
key: '10'
usefulLife: 3
audit:
createdBy: '1'
createdDateTime: '2022-11-02T05:12:15Z'
modifiedBy: '1'
modifiedDateTime: '2022-11-02T05:12:19Z'
dimensions:
item:
name: PC Computer
id: '1'
key: '1'
task:
name: Project coordination
id: 01-041
key: '8'
vendor:
name: 1099 Int
id: 1099 Int
key: '43'
project:
name: Client Services - Power Aerospace Materials
id: '8'
key: '8'
location:
name: United States of America
id: '1'
key: '1'
department:
name: Engineering
id: '3'
key: '3'
employee:
id: '1'
key: '1'
warehouse:
name: WH01 Name
id: WH01
key: '1'
class:
name: Heath Care
id: '3'
key: '1'
customer:
name: Power Aerospace Materials
id: '1'
key: '1'
acquisitionDate: '2020-01-01'
assetCost: '3000'
quantity: 1
serialNumber: CE_ASSET-1
assetTag: ASSET_TAG-0001
depreciableCost: '2700'
description: Lenovo thinkpad
type: tangible
name: Laptop
salvageValue: '300'
inServiceDate: '2020-01-01'
id: CE_ASSET-1
state: inService
isDepreciable: true
key: '2'
status: active
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update an asset
description: >+
Updates an existing asset by setting field values. Any fields not
provided remain unchanged.
The asset `state` determines which fields of the asset may be edited. If
the `state` is set to `disposed`, you may not edit any fields.
See [Editing
assets](https://www.intacct.com/ia/docs/en_US/help_action/Fixed_Assets-ns/Assets/fa-asset-about.htm)
for more details.
Permissions and other requirements
Subscription | Fixed Assets Management |
User type | Business |
Permissions | Edit Assets |
tags:
- Assets
operationId: patch-fixed-assets-asset-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/fixed-assets-asset'
- type: object
properties:
id:
readOnly: true
source.headerType:
readOnly: true
source.headerKey:
readOnly: true
source.headerId:
readOnly: true
examples:
Update an asset:
value:
state: inService
inServiceDate: '2021-12-28'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated asset
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated asset:
value:
ia::result:
key: '3'
id: CE_ASSET-2
href: /objects/fixed-assets/asset/3
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete an asset
description: >+
Deletes an asset.
You can delete assets that are in the `readyForReview` state. Assets
that are `inService` or `disposed` cannot be deleted. Instead, consider
changing their status to `inactive`.
If the asset you want to delete is assigned as a parent asset, edit the
children assets to remove the parent association.
Permissions and other requirements
Subscription | Fixed Assets Management |
User type | Business |
Permissions | Delete Assets |
tags:
- Assets
operationId: delete-fixed-assets-asset-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/fixed-assets/classification-depreciation-rule:
get:
summary: List classification depreciation rules
description: >+
Returns up to 100 object references from the collection with a key, ID,
and link for each classification depreciation 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 Classification
Depreciation Rules |
tags:
- Classification depreciation rules
operationId: list-fixed-assets-classification-depreciation-rule
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of classification-depreciation-rule objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List classification depreciation rules:
value:
ia::result:
- key: '81'
id: '81'
href: 'objects/fixed-assets/classification-depreciation-rule/81'
- key: '82'
id: '82'
href: 'objects/fixed-assets/classification-depreciation-rule/82'
- key: '83'
id: '83'
href: 'objects/fixed-assets/classification-depreciation-rule/83'
ia::meta:
totalCount: 3
totalSuccess: 3
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create a classification depreciation rule
description: >+
Creates a new classification depreciation rule.
Permissions and other requirements
Subscription | Fixed Assets Management |
User type | Business |
Permissions | Add Classification Depreciation
Rules |
tags:
- Classification depreciation rules
operationId: post-fixed-assets-classification-depreciation-rule
requestBody:
description: Creates a classification depreciation rule
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/fixed-assets-classification-depreciation-rule'
- $ref: '#/components/schemas/classification-depreciation-ruleRequiredProperties'
examples:
Create a classification depreciation rule:
value:
id: '818'
journal:
key: '45'
deprMethod:
key: '-1'
usefulLife: 60
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New classification-depreciation-rule
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New classification depreciation rule:
value:
ia::result:
key: '818'
id: '818'
href: '/objects/fixed-assets/classification-depreciation-rule/818'
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/fixed-assets/classification-depreciation-rule/{key}:
parameters:
- name: key
description: System-assigned key for the classification depreciation rule.
in: path
required: true
schema:
type: string
get:
summary: Get a classification depreciation rule
description: >+
Returns detailed information for a specified classification depreciation
rule.
Permissions and other requirements
Subscription | Fixed Assets Management |
User type | Business, Employee, Project Manager,
and Warehouse |
Permissions | List, View Classification
Depreciation Rules |
tags:
- Classification depreciation rules
operationId: get-fixed-assets-classification-depreciation-rule-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the classification-depreciation-rule
properties:
ia::result:
$ref: '#/components/schemas/fixed-assets-classification-depreciation-rule'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
List details of the classification depreciation rule:
value:
ia::result:
deprMethod:
name: Straight line
id: SL
key: '-1'
journal:
id: GAAP
title: GAAP Accrual Book
key: '45'
classification:
id: Classification Id 100
key: '100'
id: '818'
key: '818'
usefulLife: 60
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update a classification depreciation rule
description: >+
Updates an existing classification depreciation rule by setting field
values. Any fields not provided remain unchanged.
Permissions and other requirements
Subscription | Fixed Assets Management |
User type | Business |
Permissions | Edit Classification Depreciation
Rules |
tags:
- Classification depreciation rules
operationId: patch-fixed-assets-classification-depreciation-rule-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/fixed-assets-classification-depreciation-rule'
- type: object
properties:
key:
readOnly: true
id:
readOnly: true
examples:
Update a classification depreciation rule:
value:
depreciationMethod:
id: DB
key: '-2'
classification:
key: '1023'
usefulLife: 20
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated classification-depreciation-rule
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated classification depreciation rule:
value:
ia::result:
key: '818'
id: '818'
href: '/objects/fixed-assets/classification-depreciation-rule/818'
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete a classification depreciation rule
description: >+
Deletes a classification depreciation rule.
Permissions and other requirements
Subscription | Fixed Assets Management |
User type | Business |
Permissions | Delete Classification Depreciation
Rules |
tags:
- Classification depreciation rules
operationId: delete-fixed-assets-classification-depreciation-rule-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/fixed-assets/depreciation-method:
get:
summary: List depreciation methods
description: >+
Returns up to 100 object references from the collection with a key, ID,
and link for each depreciation method. 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 Depreciation
Methods |
tags:
- Depreciation methods
operationId: list-fixed-assets-depreciation-method
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of depreciation-method objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List depreciation methods:
value:
ia::result:
- id: CDB
key: '-6'
href: /objects/fixed-assets/depreciation-method/-6
- id: CDBT
key: '-5'
href: /objects/fixed-assets/depreciation-method/-5
- id: DR
key: '-4'
href: /objects/fixed-assets/depreciation-method/-4
- id: 150DB
key: '-3'
href: /objects/fixed-assets/depreciation-method/-3
- id: 200DB
key: '-2'
href: /objects/fixed-assets/depreciation-method/-2
- id: SL
key: '-1'
href: /objects/fixed-assets/depreciation-method/-1
ia::meta:
totalCount: 6
totalSuccess: 6
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
parameters: []
/objects/fixed-assets/depreciation-method/{key}:
parameters:
- name: key
description: System-assigned key for the depreciation method.
in: path
required: true
schema:
type: string
get:
summary: Get a depreciation method
description: >+
Returns detailed information for a specified depreciation method.
Permissions and other requirements
Subscription | Fixed Assets Management |
User type | Business, Employee, Project Manager,
and Warehouse |
Permissions | List, View Depreciation
Methods |
tags:
- Depreciation methods
operationId: list-fixed-assets-depreciation-method-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the depreciation-method
properties:
ia::result:
$ref: '#/components/schemas/fixed-assets-depreciation-method'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Details of the depreciation method:
value:
ia::result:
name: Straight line
id: SL
key: '-1'
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/fixed-assets/depreciation-schedule-entry:
get:
summary: List depreciation schedule entries
description: >+
Returns up to 100 object references from the collection with a key, ID,
and link for each depreciation schedule entry. 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 Depreciation Schedule
Entries |
tags:
- Depreciation schedule entries
operationId: list-fixed-assets-depreciation-schedule-entry
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of depreciation-schedule-entry objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List Depreciation Schedule Entries:
value:
ia::result:
- id: '11'
key: '11'
href: /objects/fixed-assets/depreciation-schedule-entry/11
- id: '12'
key: '12'
href: /objects/fixed-assets/depreciation-schedule-entry/12
ia::meta:
totalCount: 2
totalSuccess: 2
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/fixed-assets/depreciation-schedule-entry/{key}:
parameters:
- name: key
description: System-assigned key for the depreciation schedule entry.
in: path
required: true
schema:
type: string
get:
summary: Get a depreciation schedule entry
description: >+
Returns detailed information for a specified depreciation schedule
entry.
Permissions and other requirements
Subscription | Fixed Assets Management |
User type | Business, Employee, Project Manager,
and Warehouse |
Permissions | List, View Depreciation Schedule
Entry |
operationId: get-fixed-assets-depreciation-schedule-entry-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the depreciation-schedule-entry
properties:
ia::result:
$ref: '#/components/schemas/fixed-assets-depreciation-schedule-entry'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Details of the depreciation schedule entry:
value:
ia::result:
depreciationSchedule:
id: '389'
key: '389'
audit:
createdBy: '1'
createdDateTime: '2023-04-24T07:58:45Z'
modifiedBy: '1'
modifiedDateTime: '2023-04-24T07:58:45Z'
depreciationAmount: '960'
period: 1
id: '5564'
scheduledPostingDate: '2021-12-31'
actualPostingDate: '2022-01-05'
state: notPosted
key: '5564'
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
tags:
- Depreciation schedule entries
security:
- OAuth2: []
/objects/fixed-assets/depreciation-schedule:
get:
summary: List depreciation schedules
description: >+
Returns up to 100 object references from the collection with a key, ID,
and link for each depreciation schedule. 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 Depreciation
Schedule |
tags:
- Depreciation schedules
operationId: list-fixed-assets-depreciation-schedule
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of depreciation-schedule objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List depreciation schedules:
value:
ia::result:
- state: inProgress
key: '26'
href: /objects/fixed-assets/depreciation-schedule/26
- state: inProgress
key: '27'
href: /objects/fixed-assets/depreciation-schedule/27
ia::meta:
totalCount: 2
totalSuccess: 2
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/fixed-assets/depreciation-schedule/{key}:
parameters:
- name: key
description: System-assigned key for the depreciation schedule.
in: path
required: true
schema:
type: string
get:
summary: Get a depreciation schedule
description: >+
Returns detailed information for a specified depreciation schedule.
Permissions and other requirements
Subscription | Fixed Assets Management |
User type | Business, Employee, Project Manager,
and Warehouse |
Permissions | List, View Depreciation
Schedule |
tags:
- Depreciation schedules
operationId: get-fixed-assets-depreciation-schedule-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the depreciation-schedule
properties:
ia::result:
$ref: '#/components/schemas/fixed-assets-depreciation-schedule'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Details of the depreciation schedule:
value:
ia::result:
asset:
name: Asset Name _~!@#$%^*()_+=-`1682323123
id: Asset Id 1682323123
key: '862'
assetDepreciationRule:
id: '1011'
key: '1011'
depreciationScheduleEntries:
- depreciationSchedule:
id: '389'
key: '389'
audit:
createdBy: '1'
createdDateTime: '2023-04-24T07:58:45Z'
modifiedBy: '1'
modifiedDateTime: '2023-04-24T07:58:45Z'
depreciationAmount: '960'
period: 1
id: '5564'
postingDate: '2021-12-31'
state: notPosted
key: '5564'
- depreciationSchedule:
id: '389'
key: '389'
audit:
createdBy: '1'
createdDateTime: '2023-04-24T07:58:45Z'
modifiedBy: '1'
modifiedDateTime: '2023-04-24T07:58:45Z'
depreciationAmount: '960'
period: 2
id: '5565'
postingDate: '2022-12-31'
state: notPosted
key: '5565'
- depreciationSchedule:
id: '389'
key: '389'
audit:
createdBy: '1'
createdDateTime: '2023-04-24T07:58:46Z'
modifiedBy: '1'
modifiedDateTime: '2023-04-24T07:58:46Z'
amount: 960
period: 3
id: '5566'
postingDate: '2023-12-31'
state: notPosted
key: '5566'
- depreciationSchedule:
id: '389'
key: '389'
audit:
createdBy: '1'
createdDateTime: '2023-04-24T07:58:46Z'
modifiedBy: '1'
modifiedDateTime: '2023-04-24T07:58:46Z'
amount: 960
period: 4
id: '5567'
postingDate: '2024-12-31'
state: notPosted
key: '5567'
- depreciationSchedule:
id: '389'
key: '389'
audit:
createdBy: '1'
createdDateTime: '2023-04-24T07:58:46Z'
modifiedBy: '1'
modifiedDateTime: '2023-04-24T07:58:46Z'
depreciationAmount: '960'
period: 5
id: '5568'
postingDate: '2025-12-31'
state: notPosted
key: '5568'
audit:
createdBy: '1'
createdDateTime: '2023-04-24T07:58:45Z'
modifiedBy: '1'
modifiedDateTime: '2023-04-24T07:58:45Z'
depreciableCost: '4800'
state: inProgress
key: '389'
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/fixed-assets/setup-posting-rule:
get:
summary: List setup posting rules
description: >+
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 |
tags:
- Setup posting rules
operationId: list-fixed-assets-setup-posting-rule
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of setup-posting-rule objects
properties:
ia::result:
type: array
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List of setup posting rules:
value:
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
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create a setup posting rule
description: |+
Creates a new setup posting rule.
Permissions and other requirements
Subscription | Fixed Assets Management |
User type | Business |
Permissions | Add Setup Posting Rule |
tags:
- Setup posting rules
operationId: post-fixed-assets-setup-posting-rule
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/fixed-assets-setup-posting-rule'
- $ref: '#/components/schemas/setup-posting-ruleRequiredProperties'
examples:
Create a setup posting rule:
value:
journal:
key: '47'
faSetup:
key: '1'
id: ID5
usefulLifeUnits: months
convention: fullMonth
isTax: false
useSalvageValue: false
name: Tax Accrual Book
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New setup-posting-rule
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New setup posting rule:
value:
ia::result:
key: '5'
id: ID5
href: /objects/fixed-assets/setup-posting-rule/5
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/fixed-assets/setup-posting-rule/{key}:
parameters:
- name: key
description: System-assigned key for the setup posting rule.
in: path
required: true
schema:
type: string
get:
summary: Get a setup posting rule
description: >+
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 |
tags:
- Setup posting rules
operationId: get-fixed-assets-posting-rule-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the setup-posting-rule
properties:
ia::result:
$ref: '#/components/schemas/fixed-assets-setup-posting-rule'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Details of the setup posting rule:
value:
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
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
patch:
summary: Update a setup posting rule
description: >+
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](/openapi/fa/fixed-assets.classification-depreciation-rule/tag/Classification-depreciation-rules)
or [asset depreciation
rule](/openapi/fa/fixed-assets.asset-depreciation-rule/tag/Asset-depreciation-rules).
Permissions and other requirements
Subscription | Fixed Assets Management |
User type | Business |
Permissions | Edit Setup Posting Rule |
tags:
- Setup posting rules
operationId: patch-fixed-assets-setup-posting-rule-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/fixed-assets-setup-posting-rule'
- type: object
properties:
key:
readOnly: true
id:
readOnly: true
faSetup.key:
readOnly: true
examples:
Update a setup posting rule:
value:
key: '42'
id: ID42
journal:
key: '1'
faSetup:
key: '1'
usefulLifeUnits: months
convention: fullMonth
isTax: false
useSalvageValue: false
name: Tax Accrual Book
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated setup-posting-rule
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated setup posting rule:
value:
ia::result:
key: '42'
id: ID42
href: /objects/fixed-assets/setup-posting-rule/42
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete a setup posting rule
description: >+
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](/openapi/fa/fixed-assets.classification-depreciation-rule/tag/Classification-depreciation-rules)
or [asset depreciation
rule](/openapi/fa/fixed-assets.asset-depreciation-rule/tag/Asset-depreciation-rules).
Permissions and other requirements
Subscription | Fixed Assets Management |
User type | Business |
Permissions | null |
tags:
- Setup posting rules
operationId: delete-fixed-assets-setup-posting-rule-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/fixed-assets/setup:
get:
summary: List setups
description: >+
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
Subscription | Fixed Assets Management |
User type | Business, Employee, Project Manager,
and Warehouse |
Permissions | List, View Setups |
tags:
- Setups
operationId: list-fixed-assets-setup
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: List of Fixed Assets setup objects
properties:
ia::result:
type: object
items:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata-pages'
examples:
List setups:
value:
ia::result:
id: '1'
key: '1'
href: /objects/fixed-assets/setup/1
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
post:
summary: Create a setup
description: |+
Creates a new setup.
Permissions and other requirements
Subscription | Fixed Assets Management |
User type | Business |
Permissions | Add Setup |
tags:
- Setups
operationId: post-fixed-assets-setup
requestBody:
description: ''
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/fixed-assets-setup'
examples:
Create a setup:
value:
enableAutoPosting: false
journal:
key: '46'
setupPostingRules:
- journal:
key: '46'
usefulLifeUnits: months
convention: fullMonth
isTax: true
useSalvageValue: false
name: Tax Accrual Book
- journal:
key: '43'
usefulLifeUnits: years
convention: halfYear
isTax: false
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
title: New setup
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
New setup:
value:
ia::result:
key: '1'
id: ID1
href: /objects/fixed-assets/setup/1
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
/objects/fixed-assets/setup/{key}:
parameters:
- name: key
description: System-assigned key for the setup.
in: path
required: true
schema:
type: string
get:
summary: Get a setup
description: >+
Returns detailed information for a specified setup.
Permissions and other requirements
Subscription | Fixed Assets Management |
User type | Business, Employee, Project Manager,
and Warehouse |
Permissions | List, View Setups |
operationId: get-fixed-assets-setup-key
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Details of the setup
properties:
ia::result:
$ref: '#/components/schemas/fixed-assets-setup'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Details of the setup:
value:
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:
- faSetup:
id: '117'
key: '117'
journal:
name: TAX Accrual Book
id: TAX
key: '46'
bookId: TAXADJACCRUAL
audit:
createdBy: '1'
createdDateTime: '2022-09-25T01:21:35Z'
modifiedBy: '1'
modifiedDateTime: '2023-04-06T06:15:48Z'
convention: fullMonth
usefulLifeUnits: months
name: NAME 1
useSalvageValue: false
isTax: true
id: ID1
key: '1'
- faSetup:
id: '117'
key: '117'
journal:
name: IFRS-Australia
id: IFRS-AUS
key: '43'
bookId: IFRSACCRUAL
audit:
createdBy: '1'
createdDateTime: '2022-09-25T01:22:00Z'
modifiedBy: '1'
modifiedDateTime: '2023-04-06T06:15:48Z'
convention: fullMonth
usefulLifeUnits: months
name: NAME 2
useSalvageValue: true
isTax: true
id: ID2
key: '2'
- faSetup:
id: '117'
key: '117'
journal:
name: Accommodation Expenses
id: Others
key: '39'
bookId: CEACCRUAL
audit:
createdBy: '1'
createdDateTime: '2022-09-25T01:22:22Z'
modifiedBy: '1'
modifiedDateTime: '2023-04-06T06:15:48Z'
convention: halfYear
usefulLifeUnits: years
name: NAME 3
useSalvageValue: true
isTax: true
id: ID3
key: '3'
- faSetup:
id: '117'
key: '117'
journal:
name: GAAP Accrual Book
id: GAAP
key: '45'
bookId: GAAPADJACCRUAL
audit:
createdBy: '1'
createdDateTime: '2023-01-06T23:29:55Z'
modifiedBy: '1'
modifiedDateTime: '2023-04-06T06:15:48Z'
convention: fullYear
usefulLifeUnits: years
name: NAME 41
useSalvageValue: true
isTax: true
id: ID41
key: '41'
- faSetup:
id: '117'
key: '117'
journal:
name: Fixed Asset Journal
id: FAJ
key: '47'
bookId: ACCRUAL
audit:
createdBy: '1'
createdDateTime: '2023-04-06T06:15:48Z'
modifiedBy: '1'
modifiedDateTime: '2023-04-06T06:15:48Z'
convention: fullYear
usefulLifeUnits: years
name: Tax Accrual Book
useSalvageValue: true
isTax: false
key: '42'
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
'400':
$ref: '#/components/responses/400error'
tags:
- Setups
security:
- OAuth2: []
patch:
summary: Update a setup
description: >+
Updates an existing setup by setting field values. Any fields not
provided remain unchanged.
Permissions and other requirements
Subscription | Fixed Assets Management |
User type | Business |
Permissions | Edit Setup |
tags:
- Setups
operationId: patch-fixed-assets-setup-key
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/fixed-assets-setup'
- type: object
properties:
id:
readOnly: true
examples:
Update a setup:
value:
setupPostingRules:
- journal:
key: '39'
key: '1'
convention: fullMonth
usefulLifeUnits: months
isTax: false
useSalvageValue: true
name: new name
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: Updated setup
properties:
ia::result:
$ref: '#/components/schemas/object-reference'
ia::meta:
$ref: '#/components/schemas/metadata'
examples:
Updated setup:
value:
ia::result:
key: '1'
id: '1'
href: /objects/fixed-assets/setup/1
ia::meta:
totalCount: 1
totalSuccess: 1
totalError: 0
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
delete:
summary: Delete a setup
description: |+
This operation is not supported.
Permissions and other requirements
Subscription | Fixed Assets Management |
User type | Business |
Permissions | null |
tags:
- Setups
operationId: delete-fixed-assets-setup-key
responses:
'204':
description: No Content
'400':
$ref: '#/components/responses/400error'
security:
- OAuth2: []
components:
schemas:
classification:
$ref: '#/components/schemas/fixed-assets-asset-classification'
classificationRequiredProperties:
type: object
required:
- id
- name
object-reference:
type: object
description: Reference to created or updated object
properties:
key:
type: string
example: '12345'
id:
type: string
example: ID123
href:
type: string
readOnly: true
example: /objects///12345
metadata-pages:
description: Metadata for collection response
type: object
properties:
totalCount:
type: integer
description: Total count
readOnly: true
example: 3
start:
type: integer
description: Start element number
readOnly: true
example: 1
pageSize:
type: integer
description: Page size
readOnly: true
example: 100
next:
type: integer
description: Next element number
readOnly: true
nullable: true
example: 101
previous:
type: integer
description: Previous element number
readOnly: true
nullable: true
example: null
metadata:
description: Metadata for response
type: object
properties:
totalCount:
type: integer
description: Total count
readOnly: true
example: 3
totalSuccess:
type: integer
description: Total success
readOnly: true
example: 2
totalError:
type: integer
description: Total errors
readOnly: true
example: 1
error-response:
type: object
description: Error response
properties:
ia::result:
type: object
properties:
ia::error:
type: object
properties:
code:
type: string
example: invalidRequest
message:
type: string
example: Payload contains errors
supportId:
type: string
example: sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ
errorId:
type: string
example: REST-1064
additionalInfo:
type: object
properties:
messageId:
type: string
example: IA.PAYLOAD_CONTAINS_ERRORS
placeholders:
type: string
example: {}
propertySet:
type: string
example: {}
details:
type: array
items:
type: object
properties:
code:
type: string
example: invalidRequest
message:
type: string
example: /newDate is not a valid field
errorId:
type: string
example: REST-1043
target:
type: string
example: /newDate
additionalInfo:
type: object
properties:
messageId:
type: string
example: IA.NOT_A_VALID_FIELD
placeholders:
type: string
example:
FIELD: /newDate
propertySet:
type: string
example: {}
ia::meta:
$ref: '#/components/schemas/metadata'
example:
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
audit:
type: object
readOnly: true
properties:
createdDateTime:
description: Date-time when this record was created.
type: string
format: date-time
readOnly: true
example: '2023-05-16T15:34:35Z'
modifiedDateTime:
description: Date-time when this record was modified.
type: string
format: date-time
readOnly: true
example: '2024-09-14T21:23:42Z'
createdBy:
description: Key for the user who created this object.
type: string
readOnly: true
nullable: true
example: '436'
modifiedBy:
description: Key for the user who last modified this object.
type: string
readOnly: true
nullable: true
example: '3086'
fixed-assets-classification-depreciation-rule:
type: object
description: List of classification depreciation rules.
properties:
key:
type: string
description: System-assigned unique key for the classification depreciation rule.
example: '6'
id:
type: string
readOnly: true
description: Unique ID for the classification depreciation rule.
example: DR006
href:
type: string
readOnly: true
description: Endpoint for the classification depreciation rule.
example: objects/fixed-assets/classification-depreciation-rule/6
usefulLife:
type: integer
description: >-
Specify a value for the useful life, which is either in months or
years as established by the `usefulLifeUnits` field in the posting
rule. The value must not exceed 500 if `usefulLifeUnits` is set to
`months`, and must not exceed 100 if `usefulLifeUnits` is set to
`years`.
example: 3
postingRule:
type: object
description: >-
Posting rule determines which journals the Fixed Assets Management
application can post to and how.
properties:
key:
type: string
description: System-assigned key for the posting rule.
example: '2'
id:
type: string
description: Unique ID for the posting rule.
example: ID2
name:
type: string
readOnly: true
description: Name for the posting rule.
example: NAME 2
usefulLifeUnits:
enum:
- months
- years
type: string
readOnly: true
description: Indicates whether useful life is specified in months or years.
example: months
convention:
enum:
- fullMonth
- halfYear
- fullYear
type: string
readOnly: true
description: >-
Determines when and how depreciation is calculated for the
periods an asset is placed in service or disposed of.
example: fullMonth
isTax:
type: boolean
default: false
readOnly: true
description: >-
Indicates whether this classification depreciation rule applies
for tax purposes.
example: true
useSalvageValue:
type: boolean
default: true
readOnly: true
description: >-
Indicates whether salvage value should be used in calculating
depreciation.
example: false
href:
type: string
readOnly: true
description: Endpoint for the posting rule.
example: /objects/fixed-assets/setup-posting-rule/2
journal:
type: object
readOnly: true
description: >-
General Ledger (GL) journal associated with this depreciation
schedule.
properties:
key:
type: string
description: System-assigned unique key for the GL journal.
example: '46'
id:
type: string
description: ID for the GL journal.
example: TAX
name:
type: string
readOnly: true
description: Name for the GL journal.
example: TAX Accrual Book
bookId:
type: string
readOnly: true
description: The book to which this journal belongs.
example: TAXADJACCRUAL
href:
type: string
readOnly: true
description: Endpoint for the GL journal.
example: /objects/general-ledger/journal/46
classification:
type: object
description: Asset classification associated with this depreciation rule.
properties:
key:
type: string
description: Classification key
example: '3'
id:
type: string
description: Unique ID for the classification.
example: CE-1
name:
type: string
readOnly: true
description: Name for the classification.
example: Computer Equipment
href:
type: string
readOnly: true
description: Endpoint for the classification.
example: /objects/fixed-assets/asset-classification/3
depreciationMethod:
type: object
description: Depreciation method.
properties:
key:
type: string
description: System-assigned key for the depreciation method.
example: '-1'
id:
type: string
description: Unique ID for the depreciation method.
example: SL01
name:
type: string
description: Depreciation method name
example: Straight line
href:
type: string
readOnly: true
description: Endpoint for the depreciation method.
example: /objects/fixed-assets/depreciation-method/-1
depreciationRate:
type: string
description: >-
Rate used to calculate depreciation amount. For example, a value of
30.00 applies a rate of 30.00%. The value must be between 1.00 and
100.00.
example: '30.00'
audit:
$ref: '#/components/schemas/audit'
status:
type: string
description: >-
Object status. Active objects are fully functional. Inactive objects are
essentially hidden and cannot be used or referenced.
enum:
- active
- inactive
default: active
example: active
fixed-assets-asset-classification:
type: object
description: Classification of an asset
properties:
key:
type: string
readOnly: true
description: System-assigned unique key for the asset classification.
example: '3'
id:
type: string
nullable: false
description: Unique ID for the asset classification.
example: CE-1
href:
type: string
readOnly: true
description: Endpoint for the asset classification.
example: /objects/fixed-assets/asset-classification/3
name:
type: string
nullable: false
description: Name for the asset classification.
example: Computer Equipment
multiEntityLocation:
type: object
description: Multi-entity location.
properties:
key:
type: string
readOnly: true
description: System-assigned unique key for the multi-entity location.
example: '1'
id:
type: string
readOnly: true
description: Unique ID for the multi-entity location.
example: '1'
name:
type: string
readOnly: true
description: Name for the multi-entity location.
example: United States of America
href:
type: string
description: Endpoint for the multi-entity location.
readOnly: true
example: /objects/company-config/location/1
assetGLAccount:
type: object
description: >-
The General Ledger (GL) account for transactions involving asset
cost and disposal.
properties:
key:
type: string
description: System-assigned unique key for the asset GL account.
example: '93'
id:
type: string
description: Unique ID for the asset GL account.
example: '1500'
name:
type: string
readOnly: true
description: Name for the asset GL account.
example: Computer Equipment
href:
type: string
readOnly: true
description: Endpoint for the asset GL account.
example: /objects/general-ledger/account/93
accumulatedDepreciationGLAccount:
type: object
description: >-
The General Ledger (GL) account where depreciation transactions are
recorded as credits.
properties:
key:
type: string
description: System-assigned key for the accumulated depreciation GL account.
example: '98'
id:
type: string
description: Unique ID for the accumulated depreciation GL account.
example: '1901'
name:
type: string
readOnly: true
description: Name for the accumulated depreciation GL account.
example: Accumulated Depreciation
href:
type: string
readOnly: true
description: Endpoint for the accumulated depreciation GL account.
example: /objects/general-ledger/account/98
depreciationExpenseGLAccount:
type: object
description: >-
The General Ledger (GL) account where depreciation transactions are
recorded as debits.
properties:
key:
type: string
description: >-
System-assigned unique key for the depreciation expense GL
account.
example: '270'
id:
type: string
description: Unique ID for the depreciation expense GL account.
example: '6350'
name:
type: string
readOnly: true
description: Name for the depreciation expense GL account.
example: Depreciation Expense
href:
type: string
readOnly: true
description: Endpoint for the depreciation expense GL account.
example: /objects/general-ledger/account/270
disposalGLAccount:
type: object
description: >-
The General Ledger account where the sale price is recorded as a
debit. Typically, it is a depreciation expense account or a gain and
loss account.
Required before disposing any asset.
The account must be active and non-statistical.
properties:
key:
type: string
description: System-assigned key for the disposal GL account.
example: '101'
id:
type: string
description: ID for the disposal GL account.
example: '1904'
name:
type: string
readOnly: true
description: Name for the disposal GL account.
example: Computer Equipment
href:
type: string
readOnly: true
description: Endpoint URL for the disposal GL account.
example: /objects/general-ledger/account/101
depreciationRules:
type: array
description: >-
Depreciation rules used to calculate depreciation for the asset
classification.
items:
$ref: '#/components/schemas/fixed-assets-classification-depreciation-rule'
status:
$ref: '#/components/schemas/status'
audit:
$ref: '#/components/schemas/audit'
asset-depreciation-rule:
$ref: '#/components/schemas/fixed-assets-asset-depreciation-rule'
asset-depreciation-ruleRequiredProperties:
type: object
fixed-assets-asset-depreciation-rule:
type: object
description: List of asset depreciation rules.
properties:
key:
type: string
description: System-assigned unique key for the asset depreciation rule.
example: '9'
id:
type: string
readOnly: true
description: ID for the asset depreciation rule.
example: '9'
href:
type: string
readOnly: true
description: Endpoint for the asset depreciation rule.
example: /objects/fixed-assets/asset-depreciation-rule/9
usefulLife:
type: integer
description: >-
An estimate of the expected service life of an asset. Specify a
useful life in months or years as determined by the posting rule
configuration. The value must not exceed 500 if `usefulLifeUnits` is
set to `months`, and must not exceed 100 if `usefulLifeUnits` is set
to `years`.
example: 60
depreciationSchedule:
readOnly: true
type: object
description: >-
Tracks the loss in value of an asset over the period of its useful
life using a specified [depreciation
rule](/openapi/fa/fixed-assets.setup-posting-rule/tag/Setup-posting-rules).
The depreciation schedule also tracks the gain and loss when an
asset is disposed.
properties:
key:
type: string
readOnly: true
description: System-assigned unique key for the depreciation schedule.
example: '1'
id:
type: string
readOnly: true
description: Unique ID for the depreciation schedule.
example: '1'
href:
type: string
readOnly: true
description: Endpoint for the depreciation schedule.
example: objects/fixed-assets/depreciation-schedule/1
postingRule:
type: object
description: >-
Posting rules determines which journals the Fixed Assets Management
application can post to and how.
properties:
key:
type: string
description: System-assigned unique key for the posting rule.
example: '2'
id:
type: string
description: Unique ID for the posting rule.
example: ID2
name:
type: string
readOnly: true
description: Name for the posting rule.
example: NAME 2
usefulLifeUnits:
enum:
- months
- years
type: string
readOnly: true
description: Denotes if useful life is specified in months or years.
example: months
convention:
enum:
- fullMonth
- halfYear
- fullYear
type: string
readOnly: true
description: >-
Determines when and how depreciation is calculated for the
periods an asset is placed in service or disposed of.
example: fullMonth
isTax:
type: boolean
default: false
readOnly: true
description: >-
Indicates whether this classification depreciation rule applies
for tax purposes.
example: true
useSalvageValue:
type: boolean
default: true
readOnly: true
description: >-
Indicates whether salvage value should be used in calculating
depreciation.
example: false
href:
type: string
readOnly: true
description: Endpoint for the posting rule.
example: /objects/fixed-assets/setup-posting-rule/2
journal:
type: object
readOnly: true
description: >-
General Ledger (GL) journal associated with this depreciation
schedule.
properties:
key:
type: string
description: System-assigned unique key for the GL journal.
example: '46'
id:
type: string
description: ID for the GL journal.
example: TAX
name:
type: string
readOnly: true
description: Name for the GL journal.
example: TAX Accrual Book
bookId:
type: string
readOnly: true
description: The book to which this journal belongs.
example: TAXADJACCRUAL
href:
type: string
readOnly: true
description: Endpoint for the GL journal.
example: /objects/general-ledger/journal/46
asset:
type: object
description: Asset corresponding to this depreciation rule.
properties:
key:
type: string
description: System-assigned unique key for the asset.
example: '2'
id:
type: string
description: Unique ID for the asset.
example: CE_ASSET-1
name:
type: string
readOnly: true
description: Name for the asset.
example: Laptop
href:
type: string
readOnly: true
description: Endpoint for the asset.
example: /objects/fixed-assets/asset/2
depreciationMethod:
type: object
description: Depreciation method for the asset depreciation rule.
properties:
key:
type: string
description: System-assigned unique key for the depreciation method.
example: '-1'
id:
type: string
description: Unique ID for the depreciation method.
example: SL
name:
type: string
readOnly: true
description: Name for the depreciation method.
example: Straight line
href:
type: string
readOnly: true
description: Endpoint for the depreciation method.
example: /objects/fixed-assets/depreciation-method/-1
depreciationRate:
type: string
description: >-
Rate used to calculate depreciation amount. For example, a value of
30.00 applies a rate of 30.00%. The value must be between 1.00 and
100.00.
example: '30.00'
audit:
$ref: '#/components/schemas/audit'
asset:
$ref: '#/components/schemas/fixed-assets-asset'
assetRequiredProperties:
type: object
required:
- id
- name
fixed-assets-asset:
type: object
description: A resource used in the operations of a business.
properties:
key:
type: string
readOnly: true
description: System-assigned unique key for the asset.
example: '2'
id:
type: string
description: ID for the asset.
example: CE_ASSET-1
href:
type: string
readOnly: true
description: URL endpoint for the asset.
example: /objects/fixed-assets/asset/2
name:
type: string
description: Name for the asset.
example: Laptop
state:
enum:
- inService
- readyForReview
- disposed
type: string
default: readyForReview
description: >-
Represents stages in the asset life cycle:
- `readyForReview` - new asset exists in Sage Intacct but it is not
yet depreciating.
- `inService` - the asset is currently in use by a business and its
value can depreciate on a schedule.
- `disposed` - the asset was removed from service, typically due to
a sale.
Assets are moved from `readyForReview` to `inService` and ultimately
to `disposed` state.
example: inService
assetCost:
type: string
description: >-
The amount that the asset was purchased for. It must be a positive
number.
This property is required for assets in service. It is also required
if there is a salvage value.
example: '3000'
salvageValue:
type: string
description: >-
The estimated value of the asset at the end of its useful life. It
must be less than the asset cost.
example: '300'
inServiceDate:
type: string
format: date
description: >-
The date when the asset is available for use. This date, along with
the convention, determines when the asset starts to depreciate. The
in-service date must be on or after the acquisition date.
example: '2020-01-01'
serialNumber:
type: string
description: Product serial number of the asset.
example: CE_ASSET-1
assetTag:
type: string
description: Product asset tag for the asset.
example: ASSET_TAG-0001
multiEntityLocation:
type: object
description: The location of the entity associated with the asset.
properties:
key:
type: string
readOnly: true
description: System-assigned key for the location.
example: '1'
id:
type: string
readOnly: true
description: ID for the location.
example: '1'
name:
type: string
readOnly: true
description: Name for the location.
example: United States of America
href:
type: string
readOnly: true
description: URL endpoint for the location.
example: /objects/company-config/location/1
attachment:
type: object
description: Supporting document associated with the asset.
properties:
key:
type: string
description: System-assigned key for the attachment.
example: '1'
id:
type: string
description: ID for the attachment.
example: Jan23Xls
name:
type: string
readOnly: true
description: Name for the attachment.
example: January spreadsheet
href:
type: string
readOnly: true
description: URL endpoint for the attachment.
example: /objects/company-config/attachment/1
quantity:
type: integer
default: 1
description: Number of units of the asset.
example: 1
acquisitionDate:
type: string
format: date
description: The date the asset was purchased or obtained by your business.
example: '2020-01-01'
description:
type: string
description: Description of the asset.
example: Lenovo ThinkPad
notes:
type: string
description: Notes or comments about the asset.
example: Next major service due at 3,000 hours
isDepreciable:
type: boolean
default: true
description: >-
Set to `true` if the cost of the asset will be allocated over time.
Depreciation schedules are generated when the asset is placed in
service.
Set to `false` for tracking non-depreciable assets such as land,
art, coins, or collectibles. No depreciation schedules will be
generated.
If the asset is not depreciable, do not specify the following
properties:
- `salvageValue`
- `accumulatedDepreciationGLAccount`
- `depreciationExpenseGLAccount`
- `depreciationRules`
example: true
disposalDate:
type: string
format: date
description: >-
The date the asset was removed from business operations.
This date also serves as the General Ledger posting date for the
disposal journal entry. The disposal date must be after the last
posted period date and before the next un-posted period date. If no
periods are posted yet, it must be after the in-service date and
before the first period's posting date.
example: '2022-01-01'
disposalType:
enum:
- sale
- casualtyLoss
- theft
- other
- null
type: string
default: null
description: >-
The reason for disposal of the asset.
- `sale` - you receive a payment in exchange for the asset.
- `casualtyLoss` - the asset is destroyed or damaged due to an
unforeseen event or accident. No payment is received.
- `theft` - the asset is stolen. No payment is received.
- `other` - the asset is removed from service for any other reason.
The asset might still be in your possession, but it reached the end
of its useful life or has no resale value. No payment is received.
If the reason for disposal is `sale`, then the `salePrice` and
`disposalGLAccount` properties must be specified.
example: sale
salePrice:
type: string
description: >-
The amount the asset was sold for. Specify for assets with
`disposalType` set to `sale`.
example: '1000'
disposalComments:
type: string
description: Notes about the disposal of the asset.
example: Sold to Lincoln Avenue Veterinary Clinic
type:
enum:
- tangible
- intangible
type: string
default: tangible
description: >-
The type of the asset.
Tangible assets have physical substance, such as equipment or land.
Intangible assets do not have physical substance, such as patents or
copyrights.
At this time, the Fixed Assets Management application only supports
tangible assets.
example: tangible
source:
type: object
description: The bill the asset was created from.
properties:
headerType:
type: string
description: Type for the source header.
example: IA.BILL
headerKey:
type: string
description: Key for the source header.
example: '3874'
headerId:
type: string
description: ID for the source header.
example: Bill-00302
headerLabel:
type: string
readOnly: true
description: Label for the source header.
example: Bill Bill-00302
lineKey:
type: string
description: Key for the source line.
example: '89483'
lineNumber:
type: string
description: Source line number.
example: '3'
depreciableCost:
type: string
readOnly: true
description: The depreciable cost of the asset.
example: '2700'
gainLossAmount:
type: string
description: >-
Amount of gain or loss when the asset is disposed for
non-depreciable assets.
example: '300'
disposedJournalEntry:
type: object
description: Disposed journal entry for a non-depreciable asset.
properties:
key:
type: string
description: System-assigned unique key for the disposed journal entry.
example: '6725'
id:
type: string
description: ID for the disposed journal entry.
example: '6725'
href:
type: string
readOnly: true
description: Endpoint for the journal entry.
example: /objects/general-ledger/journal-entry/6725
journal:
type: object
description: >-
The journal where transactions related to non-depreciable assets are
recorded. Use an active and non-statistical journal.
properties:
key:
type: string
description: Unique key for the journal.
example: '46'
id:
type: string
description: ID for the journal.
example: TAX
href:
type: string
readOnly: true
description: Enpoint URL for the journal.
example: /objects/general-ledger/journal/46
name:
type: string
readOnly: true
description: Name for the journal.
example: TAX Accrual
bookId:
type: string
readOnly: true
description: ID for the book this journal belongs to.
example: TAXADJACCRUAL
allocation:
type: object
description: Allocation entry associated with the asset.
properties:
key:
type: string
description: System-assigned unique key for the allocation entry.
example: '1'
id:
type: string
description: ID for the allocation entry.
example: '1'
href:
type: string
readOnly: true
description: Endpoint for the allocation entry.
example: /objects/general-ledger/txn-allocation-template/1
dimensions:
type: object
description: >-
Use dimensions to assign the asset to a project, department, or any
other dimension value.
The `location` dimension is always required. Other dimensions might
be required depending on the configuration of your accumulated
depreciation and depreciation expense GL accounts.
properties:
class:
type: object
nullable: true
description: The class associated with this asset.
properties:
key:
type: string
nullable: true
description: System-assigned key for the class.
example: '1'
id:
type: string
nullable: true
description: ID for the class.
example: '1'
name:
type: string
nullable: true
readOnly: true
description: Name for the class.
example: '1'
href:
type: string
nullable: true
readOnly: true
description: URL endpoint for the class.
example: /objects/company-config/class/1
contract:
type: object
nullable: true
description: The contract associated with the asset.
properties:
key:
type: string
nullable: true
description: System-assigned key for the contract.
example: '1'
id:
type: string
nullable: true
description: ID for the contract.
example: '1'
name:
type: string
nullable: true
readOnly: true
description: Name for the contract.
example: '1'
href:
type: string
nullable: true
readOnly: true
description: URL endpoint for the contract.
example: /objects/contracts/contract/1
costType:
type: object
nullable: true
description: The cost type for the asset.
properties:
key:
type: string
nullable: true
description: System-assigned key for the cost type.
example: '7'
id:
type: string
nullable: true
description: ID for the cost type.
example: LABOR
name:
type: string
nullable: true
readOnly: true
description: Name for the cost type.
example: LABOR
href:
type: string
nullable: true
readOnly: true
description: URL endpoint for the cost type.
example: /objects/construction/standard-cost-type/7
customer:
type: object
nullable: true
description: The customer associated with the asset.
properties:
key:
type: string
nullable: true
description: System-assigned key for the customer.
example: '1'
id:
type: string
nullable: true
description: ID for the customer.
example: '1'
name:
type: string
nullable: true
readOnly: true
description: Name for the customer.
example: Power Aerospace Materials
href:
type: string
nullable: true
readOnly: true
description: URL endpoint for the customer.
example: /objects/accounts-receivable/customer/1
department:
type: object
nullable: true
description: The department associated with the asset.
properties:
key:
type: string
nullable: true
description: System-assigned key for the department.
example: '3'
id:
type: string
nullable: true
description: ID for the department.
example: '3'
name:
type: string
nullable: true
readOnly: true
description: Name for the department.
example: Engineering
href:
type: string
nullable: true
readOnly: true
description: URL endpoint for the department.
example: /objects/company-config/department/3
employee:
type: object
nullable: true
description: The employee associated with the asset.
properties:
key:
type: string
nullable: true
description: System-assigned key for the employee.
example: '1'
id:
type: string
nullable: true
description: ID for the employee.
example: '1'
name:
type: string
nullable: true
readOnly: true
description: Name for the employee.
example: Amy Nguyen
href:
type: string
nullable: true
readOnly: true
description: URL endpoint for the employee.
example: /objects/company-config/employee/1
item:
type: object
nullable: true
description: The item associated with the asset.
properties:
key:
type: string
nullable: true
description: System-assigned key for the item.
example: '1'
id:
type: string
nullable: true
description: ID for the item.
example: '1'
name:
type: string
nullable: true
readOnly: true
description: Name for the item.
example: PC Computer
href:
type: string
nullable: true
readOnly: true
description: URL endpoint for the item.
example: /objects/inventory-control/item/1
location:
type: object
description: The location associated with the asset.
properties:
key:
type: string
nullable: true
description: System-assigned key for the location.
example: '1'
id:
type: string
nullable: true
description: ID for the location.
example: '1'
name:
type: string
nullable: true
readOnly: true
description: Name for the location.
example: United States of America
href:
type: string
nullable: true
readOnly: true
description: URL endpoint for the location.
example: /objects/company-config/location/1
project:
type: object
nullable: true
description: The project associated with the asset.
properties:
key:
type: string
nullable: true
description: System-assigned key for the project.
example: '8'
id:
type: string
nullable: true
description: ID for the project.
example: '8'
name:
type: string
nullable: true
readOnly: true
description: Name for the project.
example: Client Services - Power Aerospace Materials
href:
type: string
nullable: true
readOnly: true
description: URL endpoint for the project.
example: /objects/projects/project/8
task:
type: object
nullable: true
description: The task associated with the asset.
properties:
key:
type: string
nullable: true
description: System-assigned key for the task.
example: '8'
id:
type: string
nullable: true
description: ID for the task.
example: 01-041
name:
type: string
nullable: true
readOnly: true
description: Name for the task.
example: Project coordination
href:
type: string
nullable: true
readOnly: true
description: URL endpoint for the task.
example: /objects/projects/task/8
vendor:
type: object
nullable: true
description: The vendor associated with the asset.
properties:
key:
type: string
nullable: true
description: System-assigned key for the vendor.
example: '43'
id:
type: string
nullable: true
description: ID for the vendor.
example: 1099 Int
name:
type: string
nullable: true
readOnly: true
description: Name for the vendor.
example: 1099 Int
href:
type: string
nullable: true
readOnly: true
description: URL endpoint for the vendor.
example: /objects/accounts-payable/vendor/43
warehouse:
type: object
nullable: true
description: The warehouse associated with the asset.
properties:
key:
type: string
nullable: true
description: System-assigned key for the warehouse.
example: '1'
id:
type: string
nullable: true
description: ID for the warehouse.
example: WH01
name:
type: string
nullable: true
readOnly: true
description: Name for the warehouse.
example: WH01 Lakefront
href:
type: string
nullable: true
readOnly: true
description: URL endpoint for the warehouse.
example: /objects/inventory-control/warehouse/1
assetGLAccount:
type: object
description: >-
Required if `state` is set to `inService`. The General Ledger
account where transactions involving asset cost and disposal are
recorded as debits and credits.
properties:
key:
type: string
description: System-assigned key for the asset GL account.
example: '93'
id:
type: string
description: ID for the asset GL account.
example: '1500'
name:
type: string
readOnly: true
description: Name for the asset GL account.
example: Computer Equipment
href:
type: string
readOnly: true
description: URL endpoint for the asset GL account.
example: /objects/general-ledger/account/93
accumulatedDepreciationGLAccount:
type: object
description: >-
Use only if `isDepreciable` is set to `true`. Required if `state` is
set to `inService`. The General Ledger account where depreciation
transactions are recorded as credits. It offsets the depreciation
expense account.
properties:
key:
type: string
description: System-assigned key for the accumulated depreciation GL account.
example: '98'
id:
type: string
description: ID for the accumulated depreciation GL account.
example: '1901'
name:
type: string
readOnly: true
description: Name for the accumulated depreciation GL account.
example: Accumulated Depreciation
href:
type: string
readOnly: true
description: URL endpoint for the accumulated depreciation GL account.
example: /objects/general-ledger/account/98
depreciationExpenseGLAccount:
type: object
description: >-
Use only if `isDepreciable` is set to `true`. Required if `state` is
set to `inService`. The General Ledger account where depreciation
transactions are recorded as debits.
properties:
key:
type: string
description: System-assigned key for the depreciation expense GL account.
example: '270'
id:
type: string
description: ID for the depreciation expense GL account.
example: '6350'
name:
type: string
readOnly: true
description: Name for the depreciation expense GL account.
example: Depreciation Expense
href:
type: string
readOnly: true
description: URL endpoint for the depreciation expense GL account.
example: /objects/general-ledger/account/270
disposalGLAccount:
type: object
description: >-
The General Ledger account where the sales price is recorded as a
debit. Typically, it is a depreciation expense account or a gain and
loss account.
Specify this property when the `disposalType` is set to `sale`.
Required when the `salesPrice` is greater than zero.
The account must be active and non-statistical. Specify a different
account than the `gainLossGLAccount`.
properties:
key:
type: string
description: System-assigned key for the disposal GL account.
example: '101'
id:
type: string
description: ID for the disposal GL account.
example: '1904'
name:
type: string
readOnly: true
description: Name for the disposal GL account.
example: Computer Equipment
href:
type: string
readOnly: true
description: URL endpoint for the disposal GL account.
example: /objects/general-ledger/account/101
gainLossGLAccount:
type: object
description: >-
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. Specify a different
account than the `disposalGLAccount`.
properties:
key:
type: string
description: System-assigned key for the gain loss GL account.
example: '94'
id:
type: string
description: ID for the gain loss GL account.
example: '1501'
name:
type: string
readOnly: true
description: Name for the gain loss GL account.
example: Gain account
href:
type: string
readOnly: true
description: URL endpoint for the gain loss GL account.
example: /objects/general-ledger/account/94
classification:
type: object
description: >-
Required if `state` is set to `inService`. Provides the GL accounts
and depreciation rules properties with default values for assets of
that category.
You can customize the GL accounts and depreciation rules per asset,
after the asset has been created.
properties:
key:
type: string
description: System-assigned key for the classification.
example: '3'
id:
type: string
description: ID for the classification.
example: Computer Equipment
name:
type: string
readOnly: true
description: Name for the classification.
example: CE-1
href:
type: string
readOnly: true
description: URL endpoint for the classification.
example: /objects/fixed-assets/classification/3
parent:
type: object
description: >-
By linking parent assets, you can create a hierarchy of assets. An
asset can only have one parent. An asset cannot reference itself as
the parent.
properties:
key:
type: string
description: System-assigned key for the parent asset.
example: '1'
id:
type: string
description: ID for the parent asset.
example: CE_ASSET-0
name:
type: string
readOnly: true
description: Name for the parent asset.
example: Lenovo
href:
type: string
readOnly: true
description: URL endpoint for the parent asset.
example: /objects/fixed-assets/asset/1
depreciationRules:
type: array
description: >-
Depreciation rules contain information about the depreciation
method, convention, and useful life for the asset.
If the asset `state` is set to `inService` and `isDepreciable` is
set to `true`, it must have at least one depreciation rule.
Assets that are not depreciable cannot have any depreciation rules.
items:
$ref: '#/components/schemas/fixed-assets-asset-depreciation-rule'
status:
$ref: '#/components/schemas/status'
audit:
$ref: '#/components/schemas/audit'
classification-depreciation-rule:
$ref: '#/components/schemas/fixed-assets-classification-depreciation-rule'
classification-depreciation-ruleRequiredProperties:
type: object
required:
- id
depreciation-method:
$ref: '#/components/schemas/fixed-assets-depreciation-method'
fixed-assets-depreciation-method:
type: object
description: >-
Depreciation methods determine how an asset's depreciation expense is
computed into periods over its useful life.
properties:
key:
type: string
readOnly: true
description: System-assigned unique key for the depreciation method.
example: '-1'
id:
type: string
description: Unique ID for the depreciation method.
example: SL
href:
type: string
readOnly: true
description: Endpoint URL for the depreciation method.
example: /objects/fixed-assets/depreciation-method/-1
name:
type: string
description: Name for the depreciation method.
example: Straight line
audit:
$ref: '#/components/schemas/audit'
depreciation-schedule-entry:
$ref: '#/components/schemas/fixed-assets-depreciation-schedule-entry'
fixed-assets-depreciation-schedule-entry:
type: object
description: List of depreciation schedule entries.
properties:
key:
type: string
readOnly: true
description: System-assigned unique key for the depreciation schedule entry.
example: '1'
id:
type: string
readOnly: true
description: ID for the depreciation schedule entry. Same as key.
example: '1'
href:
type: string
readOnly: true
description: Endpoint for the depreciation schedule entry.
example: /objects/fixed-assets/depreciation-schedule-entry/1
scheduledPostingDate:
type: string
format: date
description: >-
Date on which the depreciation schedule entry is originally
scheduled to post to the GL.
example: '2020-01-31'
actualPostingDate:
type: string
format: date
description: >-
Date on which the depreciation schedule entry is actually posted to
the GL. Users have an option to override GL posting date when this
would differ from scheduled posting date.
example: '2020-02-02'
period:
type: integer
description: Period to which the depreciation schedule entry refers.
example: 1
state:
enum:
- notPosted
- posted
- canceled
- historicallyPosted
type: string
description: State of the depreciation schedule entry.
example: notPosted
depreciationAmount:
type: string
description: >-
Amount being depreciated in this period by this depreciation
schedule entry.
example: '75'
journalEntry:
type: object
description: GL journal entry for this depreciation schedule entry.
properties:
key:
type: string
description: System-assigned unique key for the GL journal entry.
example: '1'
id:
type: string
description: ID for the GL journal entry.
example: '1'
href:
type: string
readOnly: true
description: Endpoint for the GL journal entry.
example: /objects/general-ledger/journal-entry/1
depreciationSchedule:
type: object
description: Depreciation schedule corresponding to this entry.
properties:
key:
type: string
description: System-assigned unique key for the depreciation schedule.
example: '1'
id:
type: string
description: ID for the depreciation schedule.
example: '1'
href:
type: string
readOnly: true
description: Endpoint for the depreciation schedule.
example: /objects/fixed-assets/depreciation-schedule/1
audit:
$ref: '#/components/schemas/audit'
depreciation-schedule:
$ref: '#/components/schemas/fixed-assets-depreciation-schedule'
fixed-assets-depreciation-schedule:
type: object
description: >-
A depreciation schedule tracks the loss in value of an asset over the
period of its useful life.
properties:
key:
type: string
readOnly: true
description: System-assigned unique key for the depreciation schedule.
example: '1'
id:
type: string
description: ID for the depreciation schedule.
example: '1'
href:
type: string
readOnly: true
description: Endpoint for the depreciation schedule.
example: /objects/fixed-assets/depreciation-schedule/1
state:
enum:
- inProgress
- completed
- canceled
type: string
description: State for the depreciation schedule.
example: inProgress
gainLossAmount:
type: string
description: Amount of gain or loss when the asset is disposed.
example: '300'
historicalAccumulatedDepreciationAmount:
type: string
readOnly: true
description: >-
Accumulated depreciation amount of historically posted periods only
for a depreciation schedule for an asset.
example: '300'
historicalLastPostedDate:
type: string
format: date
readOnly: true
description: >-
Date of the last historically posted period for a depreciation
schedule for an asset.
example: '2015-01-01'
historicalPostedPeriods:
type: integer
readOnly: true
description: >-
Number of historically posted periods for a depreciation schedule
for an asset.
example: 2
depreciableCost:
type: string
readOnly: true
description: >-
Depreciable cost of an asset associated with this depreciation
schedule.
example: '2700'
accumulatedDepreciationAmount:
type: string
readOnly: true
description: Accumulated amount being depreciated by this depreciation schedule.
example: '1275'
totalAccumulatedDepreciationAmount:
type: string
readOnly: true
description: >-
Accumulated amount for both posted and historical entries being
depreciated by this depreciation schedule.
example: '1275'
remainingDepreciationAmount:
type: string
readOnly: true
description: Remaining amount of depreciation for this depreciation schedule.
example: '1425'
asset:
type: object
description: The asset being depreciated by this depreciation schedule.
properties:
key:
type: string
description: System-assigned unique key for the asset.
example: '2'
id:
type: string
description: Unique ID for the asset.
example: CE_ASSET-1
href:
type: string
readOnly: true
description: Endpoint for the asset.
example: /objects/fixed-assets/asset/2
name:
type: string
readOnly: true
description: Name for the asset.
example: Laptop
assetCost:
type: string
readOnly: true
description: Asset cost.
example: '3000'
salvageValue:
type: string
readOnly: true
description: Asset salvage value.
example: '300'
assetDepreciationRule:
type: object
description: Depreciation rule corresponding to this depreciation schedule.
properties:
key:
type: string
description: System-assigned unique key for the depreciation rule.
example: '9'
id:
type: string
description: ID for the depreciation rule.
example: '9'
href:
type: string
readOnly: true
description: Endpoint for the depreciation rule.
example: objects/fixed-assets/asset-depreciation-rule/9
useSalvageValue:
type: boolean
default: false
description: >-
Indicates whether the salvage value should be used to calculate
the depreciation expense of an asset.
example: false
disposedJournalEntry:
type: object
description: Disposed journal entry for this depreciation schedule.
properties:
key:
type: string
description: System-assigned unique key for the disposed journal entry.
example: '6725'
id:
type: string
description: ID for the disposed journal entry.
example: '6725'
href:
type: string
readOnly: true
description: Endpoint for the journal entry.
example: /objects/general-ledger/journal-entry/6725
depreciationScheduleEntries:
type: array
description: Depreciation schedule entries for this schedule.
items:
$ref: '#/components/schemas/fixed-assets-depreciation-schedule-entry'
audit:
$ref: '#/components/schemas/audit'
setup-posting-rule:
$ref: '#/components/schemas/fixed-assets-setup-posting-rule'
setup-posting-ruleRequiredProperties:
type: object
required:
- id
fixed-assets-setup-posting-rule:
type: object
description: >-
Use posting rules to identify the journal, useful life term, convention,
and so forth, for fixed asset transactions.
When creating multiple journal posting rules, each rule must use a
different journal, and each journal must belong to a different book.
properties:
key:
type: string
description: System-assigned unique key for the setup posting rule.
example: '1'
id:
type: string
description: Unique ID for the setup posting rule.
example: ID-1
href:
type: string
readOnly: true
description: Endpoint URL for the setup posting rule.
example: objects/fixed-assets/setup-posting-rule/1
name:
type: string
description: Name for the setup posting rule.
example: Accrual
usefulLifeUnits:
enum:
- months
- years
type: string
default: months
description: >-
Denotes if the useful life is specified in months or years. The
units of useful life must match the convention.
example: months
convention:
enum:
- fullMonth
- halfYear
- fullYear
type: string
default: fullMonth
description: >-
The convention determines how depreciation is calculated in the
first and last periods of an asset's life.
example: fullMonth
isTax:
type: boolean
default: false
description: Indicates whether this posting rule applies for tax purposes.
example: true
useSalvageValue:
type: boolean
default: true
description: >-
Indicates whether the salvage value should be used to calculate the
depreciation expense of an asset.
example: false
audit:
$ref: '#/components/schemas/audit'
setup:
type: object
description: >-
Provides configuration details for the Fixed Assets Management
application.
properties:
key:
type: string
description: Unique key for the setup.
example: '1'
id:
type: string
description: ID for the setup.
example: '1'
href:
type: string
readOnly: true
description: Endpoint URL for the setup.
example: /object/fixed-assets/setup/1
journal:
type: object
description: >-
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.
properties:
key:
type: string
description: Unique key for the journal.
example: '46'
id:
type: string
description: ID for the journal.
example: TAX
href:
type: string
readOnly: true
description: Enpoint URL for the journal.
example: /objects/general-ledger/journal/46
name:
type: string
readOnly: true
description: Name for the journal.
example: TAX Accrual
bookId:
type: string
readOnly: true
description: ID for the book this journal belongs to.
example: TAXADJACCRUAL
setup:
$ref: '#/components/schemas/fixed-assets-setup'
fixed-assets-setup:
type: object
description: >-
Set up configuration details for the Fixed Assets Management
application.
properties:
key:
readOnly: true
type: string
description: System-assigned unique key for the setup.
example: '1'
id:
type: string
description: System-assigned unique ID for the setup.
example: '1'
href:
type: string
readOnly: true
description: Endpoint URL for the setup.
example: objects/fixed-assets/setup/1
goLiveDate:
type: string
format: date
description: >-
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:
type: boolean
default: false
description: >-
Indicates whether automatic posting of depreciation schedule entries
is enabled.
example: true
enableAccountsPayable:
type: boolean
default: false
description: Indicates whether Accounts Payable integration is enabled.
example: true
enablePurchasingTxns:
type: boolean
default: false
description: Indicates whether Purchasing Transactions integration is enabled.
example: false
assetSequence:
type: object
description: Determines the automatic numbering and formatting of new asset IDs.
properties:
key:
type: string
description: Key for the asset sequence.
example: '107'
id:
type: string
description: ID for the asset sequence.
example: BOA_ACH_BatchNo
href:
type: string
readOnly: true
description: Endpoint URL for the asset sequence.
example: /objects/company-config/document-sequence/107
printTitle:
type: string
readOnly: true
description: Print title for the asset sequence.
example: BOA_ACH_BatchNo
gainLossGLAccount:
type: object
description: >-
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.
properties:
key:
type: string
description: System-assigned key for the gain loss GL account.
example: '94'
id:
type: string
description: ID for the gain loss GL account.
example: '1501'
name:
type: string
readOnly: true
description: Name for the gain loss GL account.
example: Gain account
href:
type: string
readOnly: true
description: Endpoint URL for the gain loss GL account.
example: /objects/general-ledger/account/94
journal:
type: object
description: >-
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.
properties:
key:
type: string
description: Unique key for the journal.
example: '46'
id:
type: string
description: ID for the journal.
example: TAX
href:
type: string
readOnly: true
description: Enpoint URL for the journal.
example: /objects/general-ledger/journal/46
name:
type: string
readOnly: true
description: Name for the journal.
example: TAX Accrual
bookId:
type: string
readOnly: true
description: ID for the book this journal belongs to.
example: TAXADJACCRUAL
audit:
$ref: '#/components/schemas/audit'
setupPostingRules:
type: array
description: >-
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](/openapi/fa/fixed-assets.classification-depreciation-rule/tag/Classification-depreciation-rules)
or [asset depreciation
rule](/openapi/fa/fixed-assets.asset-depreciation-rule/tag/Asset-depreciation-rules).
items:
$ref: '#/components/schemas/fixed-assets-setup-posting-rule'
responses:
400error:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/error-response'
securitySchemes:
OAuth2:
description: Sage Intacct OAuth 2.0 authorization code flow
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://api.intacct.com/ia/api/v1/oauth2/authorize
tokenUrl: https://api.intacct.com/ia/api/v1/oauth2/token
refreshUrl: https://api.intacct.com/ia/api/v1/oauth2/token
scopes: {}