Cmdlets for Sage Business Cloud Accounting

Build 24.0.9062

LedgerAccounts

Query LedgerAccounts in Sage Business Cloud Accounting.

Table Specific Information

Query the available LedgerAccounts

Select

The driver uses the Sage Accounting API to process search criteria that refer to LedgerAccountClassificationId,LedgerAccountTypeId,UpdatedOrCreatedSince,VisibleIn,NotVisibleIn,ShowIncludedInChart,ShowControlAccounts,ShowBalanceDetails,ExcludeDeletedEntries,FromDate,ToDate,Search columns. The driver processes other filters client-side within the driver.

  • LedgerAccountClassificationId supports the '=' operator.
  • LedgerAccountTypeId supports the '=' operator.
  • UpdatedOrCreatedSince supports the '=' operator.
  • VisibleIn supports the '=' operator.
  • NotVisibleIn supports the '=' operator.
  • ShowIncludedInChart supports the '=' operator.
  • ShowControlAccounts supports the '=' operator.
  • ShowBalanceDetails supports the '=' operator.
  • ExcludeDeletedEntries supports the '=' operator.
  • FromDate supports the '=' operator.
  • ToDate supports the '=' operator.
  • Search supports the '=' operator.

For example, the following queries are processed server side: 

SELECT * FROM LedgerAccounts WHERE LedgerAccountClassificationId = 'abc'
SELECT * FROM LedgerAccounts WHERE LedgerAccountTypeId = 'SALES'
SELECT * FROM LedgerAccounts WHERE UpdatedOrCreatedSince = '2019-10-02T11:46:53Z'
SELECT * FROM LedgerAccounts WHERE VisibleIn = 'Expenses'
SELECT * FROM LedgerAccounts WHERE NotVisibleIn = 'Journals'
SELECT * FROM LedgerAccounts WHERE ShowIncludedInChart = 'true'
SELECT * FROM LedgerAccounts WHERE ShowControlAccounts = 'false'
SELECT * FROM LedgerAccounts WHERE ShowBalanceDetails = 'true'
SELECT * FROM LedgerAccounts WHERE ExcludeDeletedEntries = 'true'
SELECT * FROM LedgerAccounts WHERE FromDate = '2018-12-15'
SELECT * FROM LedgerAccounts WHERE ToDate = '2018-12-15'
SELECT * FROM LedgerAccounts WHERE Search = 'abc'

Update

Updates are performed based on Id. 

UPDATE LedgerAccounts SET TaxRateId = 'abc' WHERE Id = '123'

Columns

Name Type ReadOnly References Description
Id [KEY] String False

The unique identifier for the item

TaxRateId String False

TaxRates.Id

The unique identifier for the item

CreatedAt Datetime True

The datetime when the item was created

VisibleInJournals Bool False

Indicates whether the ledger account is displayed in this area of the application

LedgerAccountClassificationId String False

LedgerAccountClassifications.Id

The unique identifier for the item

LedgerAccountGroupDisplayedAs String False

The name of the resource

LedgerAccountGroupLegacyId Int False

The legacy ID for the item

LedgerAccountGroupId String False

The unique identifier for the item

VisibleInOtherPayments Bool False

Indicates whether the ledger account is displayed in this area of the application

BalanceDetailsToDate String False

The to date filter

BalanceDetailsCreditOrDebit String False

Is the balance a debit or credit

BalanceDetailsCredits String False

The credit balance

BalanceDetailsBalance String False

The account balance

BalanceDetailsFromDate String False

The from date filter

BalanceDetailsDebits String False

The debit balance

VisibleScopes String False

The visible scopes.

VisibleInSales Bool False

Indicates whether the ledger account is displayed in this area of the application

IncludedInChart Bool False

Indicates whether the ledger account is included in the chart of accounts

VisibleInOtherReceipts Bool False

Indicates whether the ledger account is displayed in this area of the application

DisplayFormatted String False

The display name formatted based on coa_list_order in settings

VisibleInReporting Bool False

Indicates whether the ledger account is displayed in this area of the application

DisplayedAs String False

The name of the resource

ControlName String False

The control name for the ledger account

VisibleInBanking Bool False

Indicates whether the ledger account is displayed in this area of the application

LedgerAccountTypeId String False

The unique identifier for the item

使用できる値は次のとおりです。SALES, OTHER_INCOME, DIRECT_EXPENSES, OVERHEADS, DEPRECIATION, CURRENT_ASSETS, FIXED_ASSETS, FUTURE_ASSETS, BANK, CURRENT_LIABILITY, FUTURE_LIABILITY, v, LINE_OF_CREDIT

NominalCode Int False

The nominal code of the ledger account

LegacyId Int False

The legacy ID for the item

FixedTaxRate Bool False

Indicates whether the default tax rate is fixed or may be changed

IsControlAccount Bool False

Indicates whether the ledger account is a control account

Name String False

The name for the ledger account. Changes to this field do not propagate to other resources, namely not to the name of the associated bank_account (unlike the behaviour of the UI).

UpdatedAt Datetime True

The datetime when the item was last updated

DisplayName String False

The display name for the ledger account

VisibleInExpenses Bool False

Indicates whether the ledger account is displayed in this area of the application

VisibleIn String False

NotVisibleIn String False

ShowIncludedInChart Bool False

ShowControlAccounts Bool False

ShowBalanceDetails Bool False

ExcludeDeletedEntries Bool False

FromDate Datetime True

ToDate Datetime True

Search String True

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9062