Cmdlets for Sage Business Cloud Accounting

Build 24.0.9060

SalesEstimates

Query SalesEstimates in Sage Business Cloud Accounting.

Table Specific Information

Query the available SalesEstimates

Select

The driver uses the Sage Accounting API to process search criteria that refer to ContactId,StatusId,Search,FromDate,ToDate,UpdatedOrCreatedSince,HasAttachments columns. The driver processes other filters client-side within the driver.

  • ContactId supports the '=' operator.
  • StatusId supports the '=' operator.
  • Search supports the '=' operator.
  • FromDate supports the '=' operator.
  • ToDate supports the '=' operator.
  • UpdatedOrCreatedSince supports the '=' operator.
  • HasAttachments supports the '=' operator.

For example, the following queries are processed server side: 

SELECT * FROM SalesEstimates WHERE ContactId = 'abc'
SELECT * FROM SalesEstimates WHERE StatusId = 'abc'
SELECT * FROM SalesEstimates WHERE Search = 'abc'
SELECT * FROM SalesEstimates WHERE FromDate = '2018-12-15'
SELECT * FROM SalesEstimates WHERE ToDate = '2018-12-15'
SELECT * FROM SalesEstimates WHERE UpdatedOrCreatedSince = '2018-12-15'
SELECT * FROM SalesEstimates WHERE HasAttachments = 'abc'

Insert

Create a simple sales estimate. 

INSERT INTO [SalesEstimates] (ContactName, MainAddressId, Editable) VALUES ('test', '1', 'true')

Update

Updates are performed based on Id. 

UPDATE SalesEstimates SET Reference = 'abc' WHERE Id = '123'

Delete

You must specify the Id of the SalesEstimates to delete it. 

DELETE FROM SalesEstimates WHERE id = '123'

Columns

Name Type ReadOnly References Description
Id [KEY] String False

The unique identifier for the item

DisplayedAs String False

The name of the resource

Reference String False

The reference for the estimate

BaseCurrencyTotalAmount String False

The total amount of the estimate in base currency

MainAddressId String False

Addresses.Id

The unique identifier for the item

BaseCurrencyNetAmount String False

The net amount of the estimate in base currency

BaseCurrencyShippingTaxBreakdownAggregate String False

The shipping tax breakdown for the estimate in base currency

ProfitAnalysisTotalProfit String False

The profit amount

ProfitAnalysisTotalDescription String False

The description

ProfitAnalysisTotalTotalSale String False

The total sale

ProfitAnalysisTotalTotalCost String False

The total cost

ProfitAnalysisTotalProfitPercentage String False

The profit percentage

LineBreakdownAggregate String False

The breakdown of profit per line

ContactName String False

The name of the contact when the estimate was created

SentByEmail Bool False

Indicates whether the estimate has been emailed

ShippingTaxBreakdownAggregate String False

The shipping tax breakdown for the estimate

TotalDiscountAmount String False

The discount amount on the estimate

TaxAmount String False

The tax amount of the estimate

PaymentsAllocationsTotalDiscount String False

The total discount of all payments and allocations

WithholdingTaxRate String False

IRPF withheld Tax Rate (Spain only)

TotalAmount String False

The total amount of the estimate

ExchangeRate String False

The exchange rate for the estimate

EstimateNumberPrefix String False

The estimate number prefix

ContactId String False

Contacts.Id

The unique identifier for the item

TaxAddressRegionDisplayedAs String False

The name of the resource

TaxAddressRegionLegacyId Int False

The legacy ID for the item

TaxAddressRegionId String False

The unique identifier for the item

TaxCalculationMethod String False

The tax calculation method, if applicable, for this sales invoice, returns invoice, cash or retailer.

TermsAndConditions String False

Estimate terms and conditions

ShippingTaxRateDisplayedAs String False

The name of the resource

ShippingTaxRateLegacyId Int False

The legacy ID for the item

ShippingTaxRateId String False

The unique identifier for the item

Sent Bool False

Indicates whether the estimate has been sent

DeliveryAddressFreeForm String False

The free-form delivery address of the estimate

BaseCurrencyWithholdingTaxAmount String False

IRPF withheld Tax Amount (Spain only) in the base currency

DeliveryAddressId String False

Addresses.Id

The unique identifier for the item

WithholdingTaxAmount String False

IRPF withheld Tax Amount (Spain only)

UpdatedAt Datetime True

The datetime when the item was last updated

LegacyId Int False

The legacy ID for the item

TaxAnalysisAggregate String False

The estimate tax analysis

BaseCurrencyShippingTotalAmount String False

The total shipping amount in base currency

InverseExchangeRate String False

The inverse exchange rate for the estimate

TotalQuantity String False

The total quantity of the estimate

StatusDisplayedAs String False

The quote status name

StatusId String False

The quote status id

SalesQuoteLineItemAggregate String False

The estimate lines of the estimate

DetailedTaxAnalysisBaseCurrencyTotalGoodsAmount String False

The total base currency amount relating to goods for all tax rates

DetailedTaxAnalysisBaseCurrencyTotalTax String False

The base currency total tax amount for all tax rates

DetailedTaxAnalysisTotalRetailerTax String False

The total retailer tax amount for all tax rates

DetailedTaxAnalysisBaseCurrencyTotal String False

The total base currency amount for all tax rates

DetailedTaxAnalysisTotalGoodsAmount String False

The total amount relating to goods for all tax rates

DetailedTaxAnalysisTotalNet String False

The total net amount for all tax rates

DetailedTaxAnalysisBaseCurrencyTotalServicesAmount String False

The total base currency amount relating to services for all tax rates

DetailedTaxAnalysisBaseCurrencyTotalNet String False

The base currency total net amount for all tax rates

DetailedTaxAnalysisTotalServicesAmount String False

The total amount relating to services for all tax rates

DetailedTaxAnalysisTotal String False

The total amount for all tax rates

DetailedTaxAnalysisTotalTax String False

The total tax amount for all tax rates

ExpiryDate String False

The expiry date of the estimate

BaseCurrencyShippingTaxAmount String False

The tax shipping amount in base currency

ShippingTaxAmount String False

The tax shipping amount. NOTE: This is not required for POST/PUT requests as the shipping tax is calculated based on the shipping_net_amount and the shipping_tax_rate.

CreatedAt Datetime True

The datetime when the item was created

PaymentsAllocationsTotalAmount String False

The total amount of all payments and allocations

TaxReconciled Bool False

Indicates if the quote/estimate is tax reconciled or not.

Editable Bool False

Indicates whether artefact can be edited

ShippingTotalAmount String False

The total shipping amount

InvoiceDisplayedAs String False

The name of the resource

InvoiceLegacyId Int False

The legacy ID for the item

InvoiceId String False

The unique identifier for the item

BaseCurrencyShippingNetAmount String False

The net shipping amount in base currency

ShippingNetAmount String False

The net shipping amount

CurrencyDisplayedAs String False

The name of the resource

CurrencyLegacyId Int False

The legacy ID for the item

CurrencyId String False

The unique identifier for the item

EstimateNumber String False

The generated estimate number

Notes String False

Estimate notes

MainAddressFreeForm String False

The free-form main address of the estimate

TotalPaid String False

The total paid amount of the estimate including any payments, allocations and discounts

Date Datetime True

The date of the estimate

BaseCurrencyTaxAmount String False

The tax amount of the estimate in base currency

BaseCurrencyTotalDiscountAmount String False

The discount amount on the estimate in base currency

Search String False

FromDate Datetime True

ToDate Datetime True

HasAttachments String True

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