Xero Accounting Endpoint: BalanceSheet: Difference between revisions
No edit summary |
No edit summary |
||
| (8 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
== Overview == | == Overview == | ||
The Xero '''BalanceSheet''' [[Endpoints|endpoint]] provides closing balance sheet values as at a given date. | The Xero '''BalanceSheet''' [[Xero Accounting Endpoints|endpoint]] provides closing balance sheet values as at a given date. | ||
Note an alternate endpoint named [[Xero Accounting Endpoint: BalanceSheetTable|BalanceSheetTable]] is available which provides a format that can more easily integrate with Tableau, SSIS and Azure Data Factory. | |||
You may also use the [[Xero Accounting Endpoint: BalanceSheetByMonth|BalanceSheetByMonth]] which provides a similar data set but for 12-months of a given financial year. | You may also use the [[Xero Accounting Endpoint: BalanceSheetByMonth|BalanceSheetByMonth]] which provides a similar data set but for 12-months of a given financial year. | ||
| Line 10: | Line 12: | ||
== Parameters == | == Parameters == | ||
The | The BalanceSheet endpoint is a [[Function Endpoints|function]] that accepts the following parameters. | ||
;Date | ;Date | ||
| Line 21: | Line 23: | ||
;StandardLayout | ;StandardLayout | ||
:A [[Field Type: Boolean|true/false field]] that determines if the | :A [[Field Type: Boolean|true/false field]] that determines if the values are produced only for accounts that are in the [[Xero Accounting Endpoint: Accounts|accounts]] endpoint. | ||
:If omitted, it will be set to True. | :If omitted, it will be set to True. | ||
| Line 27: | Line 29: | ||
== Fields == | == Fields == | ||
The following fields are available for the | The following fields are available for the BalanceSheet endpoint. | ||
;Date | ;Date | ||
:A [[Field Type: Date|date field]] that indicates the date used to produce the | :A [[Field Type: Date|date field]] that indicates the date used to produce the values. | ||
:This will match the Date entered as [[#Parameters|parameter]]. | :This will match the Date entered as [[#Parameters|parameter]]. | ||
| Line 38: | Line 40: | ||
;StandardLayout | ;StandardLayout | ||
:A [[Field Type: Table|table field]] that | :A [[Field Type: Table|table field]] that indicates if values are produced only for accounts that are in the [[Xero Accounting Endpoint: Accounts|accounts]] endpoint. | ||
:This will match the StandardLayout entered as [[#Parameters|parameter]]. | :This will match the StandardLayout entered as [[#Parameters|parameter]]. | ||
| Line 45: | Line 47: | ||
;Lines | ;Lines | ||
:A [[Field Type: Table|table field]] that provides list of values. | :A [[Field Type: Table|table field]] that provides the list of values. | ||
:See [[#Lines Fields|Lines Fields]] for more information. | :See [[#Lines Fields|Lines Fields]] for more information. | ||
| Line 72: | Line 74: | ||
;Amount | ;Amount | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the value for the row. | ||
| Line 89: | Line 91: | ||
:[[Xero Accounting Endpoint: Accounts|Accounts]] | :[[Xero Accounting Endpoint: Accounts|Accounts]] | ||
:[[Xero Accounting Endpoint: BalanceSheetByMonth|BalanceSheetByMonth]] | :[[Xero Accounting Endpoint: BalanceSheetByMonth|BalanceSheetByMonth]] | ||
:[[Xero Accounting Endpoint: BalanceSheetMultiPeriodTable|BalanceSheetMultiPeriodTable]] | |||
:[[Xero Accounting Endpoint: BalanceSheetTable|BalanceSheetTable]] | |||
== Related Topics == | |||
:[[Xero Accounting Models]] | |||
:[[Xero Accounting Endpoints]] | |||