# Upsert General Ledger Rules

Upsert General Ledger Rules

Endpoint: PATCH /rest/2.0/FINANCIAL_CRITERIA
Version: 1.0
Security: JWT

## Header parameters:

  - `sessionId` (string, required)

## Request fields (application/json; charset=utf-8):

  - `brmObjects` (object)

  - `brmObjects.ExecOrder` (string, required)
    Order of Execution: 'Whenever more than one transaction classifier applies to a given transaction, the classifier���s execution sequence is determined by the value of this parameter (lowest first).

  - `brmObjects.FilterLogic` (string)
    Criteria Join Logic

  - `brmObjects.Status` (string)
    Status

  - `brmObjects.EntityId` (integer, required)
    Transaction Source: The entity behind the Journal entry, e.g. Invoice Detail, etc.

  - `brmObjects.CurrencyFormula` (string, required)
    Currency: The currency in which the General Ledger transaction is booked.

  - `brmObjects.PeriodEndDate` (string, required)
    Recognition Period End Date

  - `brmObjects.ObligationFormula` (string)
    Obligation Condition Formula

  - `brmObjects.RecognitionType` (string)
    Recognition Type: Specifies the revenue recognition type:Passage of Time: Revenue is recognized over a period of timePoint in Time: Entire revenue is recognized on a single date.

  - `brmObjects.Account` (string, required)
    Account: The number of the account associated to this Journal Entry. The Journal Entry will retain this account number, so that you can later customize your Journal Entry-based reports with additional data by joining the Journal Entry table with the Account table and beyond.

  - `brmObjects.IntervalAmount` (string)
    Interval Amount: Fixed:This option recognizes the same amount for each interval. For example, if you have an annual $120.00 subscription recognized using the Schedule Interval of Monthly, then the 'Fixed' option will recognize $10 per month regardless of the number of days in each month. This is the default behavior.Variable Based on Days Per Interval: This option recognizes the amount for each interval based on the relative number of days in that interval. For example, if you have an annual $120.00 subscription recognized using the Schedule Interval of Monthly, then this 'Variable' option will recognize $10.19 in January (31 days in the month) and $9.21 in February (28 days in the month), etc.

  - `brmObjects.PeriodStartDate` (string, required)
    Recognition Period Begin Date

  - `brmObjects.Amount` (string, required)
    Amount: The transaction amount booked in the General Ledger.

  - `brmObjects.DebitFinancialAccountExtkey` (integer)
    Financial Account External Key: DT_FINANCIAL_ACCOUNT_EXTKEY

  - `brmObjects.RuleFormula` (string)
    Rule Formula

  - `brmObjects.Name` (string, required)
    Rule Name

  - `brmObjects.ScheduleInterval` (string)
    Schedule Interval: SHEDULE_INTERVAL

  - `brmObjects.CreditFinancialAccountFormula` (string)
    Financial Account Formula: CR_FINANCIAL_ACCOUNT_FORMULA

  - `brmObjects.DebitDesignateFinancialAccountType` (string)
    Designate Financial Account Type: Based on the selection, the system will add an attribute to the journal entry which designates the financial account category.Ensure 'Keep Undesignated' is selected for financial accounts not considered Revenue or Deferred/Unbilled Revenue (e.g. Accounts Receivable, Cash, Tax Liability, etc.).This designation facilitates tracking of revenue recognition and deferred revenue balances on the GL for Rev Rec Contracts.Further, the system's contract modification functionality utilizes these designations to identify entries and perform calculations when booking the automated contract modification journal entries

  - `brmObjects.DebitFinancialAccountFormula` (string)
    Financial Account Formula: DT_FINANCIAL_ACCOUNT_FORMULA

  - `brmObjects.CreditFinancialAccountType` (string)
    Assign Financial Account From: Specifies how to define a financial account:From Chart of Accounts: Statically binds a journal entry to a chart of accountsAccording to the Formula: Assigns a chart of accounts based on the user-defined formula. Debit and Credit Accounts are chosen separately.

  - `brmObjects.RecognizeMinDate` (string)
    Earliest Recognition Date

  - `brmObjects.Type` (string, required)
    Rule Type

  - `brmObjects.RuleType` (string)
    Classify Based On

  - `brmObjects.CreditFinancialAccountExtkey` (integer)
    Financial Account External Key: CR_FINANCIAL_ACCOUNT_EXTKEY

  - `brmObjects.GeneralLedgerDate` (string, required)
    Booking Date: The date on which the General Ledger transaction is booked.

  - `brmObjects.DebitFinancialAccountType` (string)
    Assign Financial Account From: Specifies how to define a financial account:From Chart of Accounts: Statically binds a journal entry to a chart of accountsAccording to the Formula: Assigns a chart of accounts based on the user-defined formula. Debit and Credit Accounts are chosen separately.

  - `brmObjects.DebitFinancialAccountId` (integer)
    Financial Account: DT_FINANCIAL_ACCOUNT_ID

  - `brmObjects.Id` (string, required)
    Financial Criteria Id: FINANCIAL_CRITERIA_ID

  - `brmObjects.Created` (string)
    System controlled field: Date and time the record was created

  - `brmObjects.IntervalDay` (string)
    Interval Day

  - `brmObjects.CreditFinancialAccountId` (integer)
    Financial Account: CR_FINANCIAL_ACCOUNT_ID

  - `brmObjects.CreditDesignateFinancialAccountType` (string)
    Designate Financial Account Type: Based on the selection, the system will add an attribute to the journal entry which designates the financial account category.Ensure 'Keep Undesignated' is selected for financial accounts not considered Revenue or Deferred/Unbilled Revenue (e.g. Accounts Receivable, Cash, Tax Liability, etc.).This designation facilitates tracking of revenue recognition and deferred revenue balances on the GL for Rev Rec Contracts.Further, the system's contract modification functionality utilizes these designations to identify entries and perform calculations when booking the automated contract modification journal entries

  - `brmObjects.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `brmObjects.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `brmObjects.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `brmObjects.NonGroup` (integer)
    Splinter Like Transactions: Specifies how to represent multiple transactions of the same entity type in the same invoice. When unchecked, the system enters the same invoice billing activities matched by the same classifier as a single aggregated entry into the General Ledger. When checked, the billing activities appear as separate entries.

  - `brmObjects.RecognizeOn` (string)
    Revenue Recognition Trigger

  - `brmObjects.FinancialCriteriaSql` (string)
    FinancialCriteriaSql

  - `brmObjects.IntervalCount` (string)
    IntervalCount: INTERVAL_CNT

  - `externalIDFieldName` (string)
    Enum: "Name"

## Response 200 fields (application/json):

  - `upsertResponse` (array)

  - `upsertResponse.Id` (integer)

  - `upsertResponse.success` (boolean)

  - `upsertResponse.ErrorText` (string)

  - `upsertResponse.ErrorElementField` (string)

  - `upsertResponse.created` (boolean)