FE NXT - fields required in Get Period summary (List) endpoint in sky api

Rehan Khan

Hello,

For fetching Revenue, Expense (Income Statement) account types data, we refer to get transaction distribution (list) endpoint and for balance sheet account types, we refer to get period summary (list) endpoint. As, separate endpoints are required for fetching different account types data, it effects the data loading performance.
So, if all the information for all the account types is available in one endpoint, then it would improve the performance time and also would reduce the coding complexity for FE NXT to PP data load process.

When we checked the balance sheet accounts data in get period summary (list), then we found that, data for revenue and expense accounts is also available in the same endpoint, except that, there are some fields not available in this endpoint, which are present in get transaction distribution (list).

Following is the comparison for the same FE NXT account and with data present for the same FE NXT account in get transaction distribution (list) and get period summary (list) endpoints –


  GET Period summary (List)     {     "fiscal_year": "2015",     "fiscal_year_id": 19,     "fiscal_period": "1",     "fiscal_period_id": 217,     "period_start_date": "2015-01-01T00:00:00",     "period_end_date": "2015-01-31T00:00:00",       "account_number": "01-4300-00",     "ui_project_id": "1003",       "transaction_codes": [{       "name": "Jurisdiction",       "value": "None",       "id": 0,       "inactive": false     }, {       "name": "Spendable?",       "value": "Spendable",       "id": 0,       "inactive": false     }],       "beginning_balance": 0.0000,     "debit": 0.0000,     "credit": 500.0000,     "encumbered_beginning_balance": 0.0000,     "encumbered_debit": 0.0000,     "encumbered_credit": 0.0000   }                  

GET Transaction distribution (List)

{

"transaction_id": 82186,

"transaction_amount": 500.0000,

"distribution_id": 177456,

"batch_id": 1627,

"distribution_amount": 500.0000,

"account_number": "01-4300-00",

"account_class": "Unrestricted Net Assets",

"ui_project_id": "1003",

"post_date": "2015-01-07T00:00:00",

"type_code": "Credit",

"reference": "Reference",

"journal": "Journal & Entry",

"encumbrance": "Regular",

"transaction_code_values": [{

"name": "Jurisdiction",

"value": "None",

"id": 1,

"inactive": false

}, {

"name": "Spendable?",

"value": "Spendable",

"id": 2,

"inactive": false

}],

"date_added": "2015-01-05T10:39:23.65",

"added_by": "Supervisor",

"date_modified": "2015-01-05T11:02:43.443",

"modified_by": "Supervisor",

"post_status": "Posted"

}

 
The names shown in bold and red color above are the required fields that do not exist in ‘get period summary (list)’ endpoint and we would like to inquire & request the API team, if they can make these fields available in get period summary (list) endpoint.

Thanks & Regards,

Rehan / Vaibhav. 

Eddie Barker

Hi Rehan,

We wouldn't do this. These are two different endpoints, doing different things. The transaction distribution list API gives you maximum detail at the most granular (distributions) level.

The period summary (and the ledger summary endpoint), take the detail in the transaction distribution list and creates rows in a table by combination of unique period, account, project, and transaction code, summarizing the transaction distributions accordingly.


Please let me know if you have any questions. Thanks!

M D H

@Eddie Barker Hi Eddie. Please clarify: Is there one endpoint that will provide the ending balances for ALL accounts [as a “trial balance” report would]? Simply need the ending balances. No transaction details etc.

THANKS!

Michelle D Harris