SI.CREDITS | Velixo

Overview

The SI.CREDITS function returns the total of the credits applied to a GL account (between two dates).

Syntax

=SI.CREDITS(
    ConnectionName, 
    AccountGroup, 
    Account, 
    FromDate, 
    ToDate, 
    LocationId, 
    Books, 
    Dimensions, 
    UserDefinedDimensions, 
    IncludeChildDimensionBalances
)

Arguments

The SI.CREDITS function uses the following arguments:

Argument	Required/ Optional	Description
`ConnectionName`	Optional	Provide one of the following values: Connection name as defined in Connection Manager. Velixo range expression defining a set of connection names. An array of settings as described in the Multiple connections per formula article. We recommend using the VX.SETTINGS function to construct the array. OR Omit the argument to return results for all compatible connections with default aggregation settings.
`AccountGroup`	Optional if `Account` is specified	The name of the account group for which to return the aggregated credits. Computational Account Groups are not supported.
`Account`	Optional if `AccountGroup` is specified	The code of the general ledger account, or multiple account codes defined by a Velixo range expression
`FromDate`	Required	The inclusive start date in YYYY-MM-DD format (or a reference to a cell in a valid Excel date format)
`ToDate`	Required	The inclusive end date in YYYY-MM-DD format (or a reference to a cell in a valid Excel data format)
`LocationID`	Optional unless the company has multiple base currencies	The ID of the entity or location
`Books`	Optional	The reporting book or global consolidation book to be used for retrieving the balance. One or more user-defined adjustment book IDs may be included. `Books` argument: If you leave the argument empty value, the default reporting book will be used (`ACCRUAL` or `CASH` depending on your company settings). If you specify just one reporting or global consolidation (`"GC"`) book, that's what will be used to retrieve balances. If you specify more than one reporting / `GC` books (e.g. `"ACCRUAL;GCBOOK"`) an error will be thrown - it is not allowed in Sage. If you specify a reporting / `GC` book and one or more predefined/user-defined adjustment books (e.g. `"ACCRUAL;TAX;GAAP"`) then you will retrieve balances from `ACCRUAL` plus any adjustments defined by each of the adjustment books.
`Dimensions`	Optional	Either: A two-column Excel range, where the first column contains the name of a predefined analytical dimension (e.g. department, customer, project etc.), and the second column contains the semicolon-separated list of values for that dimension. OR A multi-column array where the first row (or column) of the array contains the name of a predefined analytical dimension, and the remaining rows (or columns) contain the individual values for that dimension. (note: this feature is available in version 2023.8 and higher) For more in-depth information about filtering by Dimensions: see Using Dimensions For user-defined dimensions, use the `UserDefinedDimensions` argument.
`UserDefinedDimensions`	Optional	Either: A two-column Excel range, where the first column contains the name of a user-defined analytical dimension, and the second column contains the respective value (or a semicolon-separated list of values) for that dimension. Or A multi-column array where the first row (or column) of the array contains the name of a user-defined analytical dimension, and the remaining rows (or columns) contain the individual values for that dimension. (note: this feature is available in version 2023.8 and higher) You can specify dimension values using ranges, wildcards, and other techniques. For predefined analytical dimensions like customer, project etc., use the `Dimensions` argument.
`IncludeChildDimensionBalances`	Optional	`TRUE` or `FALSE` (Default) Determines if (for dimensions which have child dimensions) the balances of child dimensions are included in the calculation of the total balance. This argument only affects balances if: The `Location` argument is defined and/or Other dimensions are specified in the `Dimensions` or `UserDefinedDimensions` arguments. The `IncludeChildDimensionBalances` argument performs similarly to the `Includesubdimensions` checkbox in Sage Intacct's stock reports such as Account Balances:

Example

=SI.CREDITS(
    "Sage",  
    , 
    "10100",  
    "12/1/2024",
    "12/31/2024", 
    "100", 
    "ACCRUAL"
)

Description
Returns the total of the credits applied to account "10100" during December 2024 for entity "100" in the ACCRUAL reporting book.

Result
70,000.00

https://s3.ca-central-1.amazonaws.com/cdn.velixo.com/helpdesk/KwS6UpWk-gPUZBMyLFawCDEgz04EsFaChA.png

(This example uses cell references for the arguments)