General Ledger Entity Reference

Updated: July 06, 2016

This topic describes the entity and type representations for common items used by the General Ledger API.

For more information about working with the SKY API, see the Getting Started guide.

 

Account

The account entity has the following properties:

Property Type Description
account_id string The account identifier.
number string The account number.
description string The account description.

 

Account code

The account code entity has the following properties:

Property Type Description
account_code_id string The account code identifier.
value integer The value of this account code.
category string The category for this account code.
class string The class of this account code.
is_contra boolean Whether this account code is contra.
is_control boolean Whether this account code is controlled.
description string The description for this account code.

 

Account segment detail

The account segment detail entity has the following properties:

Property Type Description
segment_id integer The account segment identifier.
type string The type for this account segment.
values an array of account segment value entities The set of account segment values associated with the distribution.

 

Account segment value

The account segment value entity has the following properties:

Property Type Description
description string The description for this segment value.
value string The value of this segment value.

 

Account structure detail

The account structure detail entity has the following properties:

Property Type Description
segment_id integer The identifier for this segment.
separator string The separator for this segment.
type string The type of this segment.
length integer The length of this segment.
sequence integer The sequence of this segment.

 

Class

The class entity has the following properties:

Property Type Description
class_id string The class identifier.
description string The description for this account class.
value string The value for this account class.

 

Distribution

The distribution entity has the following properties:

Property Type Description
distribution_id integer The distribution identifier.
ui_project_id string The user-visible identifier of the project.
account_class string The class of this distribution.
transaction_code_values an array of transaction code value entities The set of transaction code values associated with the distribution.
amount decimal The distribution amount.
percent decimal The distribtuion journal entry amount percentage.

 

Fiscal period

The fiscal period entity has the following properties:

Property Type Description
fiscal_period_id integer The distribution identifier.
start_date dateTime The start date of this fiscal period.
end_date dateTime The end date of this fiscal period.
sequence integer The sequence of this fiscal period.
closed boolean Whether or not this fiscal period is closed.

 

Fiscal year

The fiscal year entity has the following properties:

Property Type Description
fiscal_year_id integer The distribution identifier.
year integer The fiscal year.
description string The description of this fiscal year.
start_date dateTime The start date of this fiscal year.
end_date dateTime The end date of this fiscal year.
status string The status of this fiscal year.
fiscal_periods an array of fiscal period entities The set of fiscal periods associated with the distribution.

 

Fund

The fund entity has the following properties:

Property Type Description
fund_id string The fund identifier.
description string The description for this fund.
value string The value for this fund.

 

Journal code

The journal code entity has the following properties:

Property Type Description
journal_code_id integer The journal identifier.
code string The abbreviated code of the journal.
journal string The full journal name of the journal.

 

Journal entry batch

The journal entry batch entity has the following properties:

Property Type Description
batch_id integer The journal entry batch identifier.
ui_batch_id string The user-visible identifier of the journal entry batch.
description string The description of the journal entry batch.
batch_status string The status of the journal entry batch.
create_interfund_sets boolean Indicates whether or not the journal entry batch will automatically generate interfund sets to balance journal entries.
create_bank_account_adjustments boolean Indicates whether or not the journal entry batch will automatically generate bank account adjustments to balance journal entries.
journal_entries an array of journal entry entities The set of journal entries associated with the journal entry batch.

 

Journal entry

The journal entry entity has the following properties:

Property Type Description
journal_entry_id integer The journal entry identifier.
type_code string The journal entry transaction type (debit or credit).
line_number integer The journal entry line number.
account_number string The journal entry account number.
post_date dateTime The journal entry post date, in ISO 8601 format: 2016-03-14.
encumbrance string The journal entry encumbrance type.
journal string The full name of the journal entry.
reference string The journal entry reference.
amount decimal The journal entry amount.
notes string The journal entry notes.
distributions array of distribution entities. The set of distributions associated with the journal entry.

 

Project

The project entity has the following properties:

Property Type Description
project_id integer The project database identifier.
ui_project_id string The user-visible project identifier.
description string The project description.
start_date dateTime The project start date, in ISO 8601 format: 2016-03-14.
end_date dateTime The project end date, in ISO 8601 format: 2016-03-14.
location string The project location.
division string The project division.
department string The project department.
status string The project status.

 

Project type

The project type entity has the following properties:

Property Type Description
id string The type identifier.
description string The description for this type.
value string The value for this type.

 

Project status

The project status entity has the following properties:

Property Type Description
id string The status identifier.
description string The description for this status.
value string The value for this status.

 

Project division

The project division entity has the following properties:

Property Type Description
id string The division identifier.
description string The description for this division.
value string The value for this division.

 

Project type

The project location entity has the following properties:

Property Type Description
id string The location identifier.
description string The description for this location.
value string The value for this location.

 

Project type

The project department entity has the following properties:

Property Type Description
id string The department identifier.
description string The description for this department.
value string The value for this department.

 

Transaction code

The transaction code entity has the following properties:

Property Type Description
transaction_code_id integer The transaction code identifier.
name string The transaction code name.
description string The transaction code description.

 

Transaction code value

The transaction code value entity has the following properties:

Property Type Description
name string The transaction code name.
value string The transaction code value.

 

Transaction distribution

The transaction distribution entity has the following properties:

Property Type Description
transaction_id integer The transaction identifier.
transaction_amount decimal The transaction amount.
distribution_amount decimal The total distribution amount.
distribution_id integer The distribution identifier.
account_number string The account number associated with the transaction distribution.
account_class string The account class associated with the transaction distribution.
ui_project_id string The user-visible project identifier associated with the transaction distribution.
post_date dateTime The transaction distribution post date, in ISO 8601 format: 2016-03-14.
is_credit boolean Indicates whether the transaction distribution is a credit or debit.
reference string The reference of the transaction distribution.
journal string The journal name associated with the transaction distribution.
encumbrance string The encumbrance of the transaction distribution.
transaction_codes_values an array of transaction code value entities The collection of transaction code values associated with the transaction distribution.