SI.CREDITS

Created by Harry Lewis, Modified on Wed, 11 Sep at 5:40 PM by Harry Lewis

Applies to:

Velixo NX

Sage Intacct

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

TABLE OF CONTENTS

Syntax
Parameters
Example

Syntax

SI.CREDITS(
    Connection,
    AccountGroup,
    AccountCode,
    StartDate,
    EndDate,
    LocationId,
    Books,
    Dimensions,
    UserDefinedDimensions,
    IncludeChildDimensionBalances)

Parameters

The SI.CREDITS function uses the following parameters:

Parameter	Required/ Optional	Description
ConnectionName	Required	The name of the connection as configured in the Connection Manager
AccountGroup	Optional if AccountCode is specified	The name of the account group for which to return the aggregated credits. Note: Computational Account Groups are not supported.
AccountCode	Optional if AccountGroup is specified	The code of the general ledger account, or multiple account codes defined by a Velixo range expression
StartDate	Required	The inclusive start date in YYYY-MM-DD format (or a reference to a cell in a valid Excel date format)
EndDate	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.
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 parameter.
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) For predefined analytical dimensions like customer, project etc., use the Dimensions argument.
IncludeChildDimension Balances	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 parameter only affects balances if: the Location argument is defined and/or other dimensions are specified in the Dimensions or UserDefinedDimensions parameters. The IncludeChildDimensionBalances parameter performs similarly to the Include subdimensions checkbox in Sage Intacct's stock reports such as Account Balances:

*Books parameter:

If you leave the parameter blank, 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.

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

(this example uses cell references for the parameters)