Excel Add-In for Sage Business Cloud Accounting

Build 24.0.9060

SalesCreditNotes

Query SalesCreditNotes in Sage Business Cloud Accounting.

Table Specific Information

Query the available SalesCreditNotes

Select

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

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

For example, the following queries are processed server side: 

SELECT * FROM SalesCreditNotes WHERE ContactId = 'abc'
SELECT * FROM SalesCreditNotes WHERE StatusId = 'abc'
SELECT * FROM SalesCreditNotes WHERE ShowPaymentsAllocations = 'abc'
SELECT * FROM SalesCreditNotes WHERE MarkAsSent = 'abc'
SELECT * FROM SalesCreditNotes WHERE ShowPaymentsAllocations = 'abc'
SELECT * FROM SalesCreditNotes WHERE Search = 'abc'
SELECT * FROM SalesCreditNotes WHERE FromDate = '2018-12-15'
SELECT * FROM SalesCreditNotes WHERE ToDate = '2018-12-15'
SELECT * FROM SalesCreditNotes WHERE UpdatedOrCreatedSince = '2018-12-15'
SELECT * FROM SalesCreditNotes WHERE DeletedSince = '2018-12-15'
SELECT * FROM SalesCreditNotes WHERE HasAttachments = 'abc'

Insert

Create a simple sales credit note. 

INSERT INTO  [SalesCreditNotes] (ContactName, TotalQuantity, DisplayedAs) VALUES ('test', '1', 'test')

Update

Updates are performed based on Id. 

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

Delete

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

DELETE FROM SalesCreditNotes 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 credit note

SalesCreditNoteLineItemAggregate String False

The credit note lines of the credit note

BaseCurrencyTotalAmount String False

The total amount of the credit note in base currency

MainAddressId String False

Addresses.Id

The unique identifier for the item

BaseCurrencyNetAmount String False

The net amount of the credit note in base currency

BaseCurrencyShippingTaxBreakdownAggregate String False

The shipping tax breakdown for the credit note in base currency

ContactName String False

The name of the contact when the credit note was created

SentByEmail Bool False

Indicates whether the credit note has been emailed

ShippingTaxBreakdownAggregate String False

The shipping tax breakdown for the credit note

Migrated Bool False

Indicates if the sales credit note was migrated from another system.

TotalDiscountAmount String False

The discount amount on the credit note

TaxAmount String False

The tax amount of the credit note

LastPaid String False

The date of the last payment

CreditNoteNumber String False

The generated credit note number

PaymentsAllocationsTotalDiscount String False

The total discount of all payments and allocations

TotalAmount String False

The total amount of the credit note

ExchangeRate String False

The exchange rate for the credit note

OutstandingAmount String False

The outstanding amount of the credit note

ContactId String False

Contacts.Id

The unique identifier for the item

NetAmount String False

The net amount of the credit note

ContactReference String False

The reference of the contact when the credit note was created

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 credit note, returns invoice or cash.

TermsAndConditions String False

Credit note terms and conditions

PaymentsAllocationsAggregate String False

The associated payments and allocations

ShippingTaxRateId String False

TaxRates.Id

The unique identifier for the item

Sent Bool False

Indicates whether the credit note has been sent

DeliveryAddressId String False

Addresses.Id

The unique identifier for the item

UpdatedAt Datetime True

The datetime when the item was last updated

LegacyId Int False

The legacy ID for the item

TaxAnalysisAggregate String False

The credit note tax analysis

BaseCurrencyShippingTotalAmount String False

The total shipping amount in base currency

InverseExchangeRate String False

The inverse exchange rate for the credit note

TransactionId String False

Transactions.Id

The unique identifier for the item

TotalQuantity String False

The total quantity of the credit note

StatusDisplayedAs String False

The name of the resource

StatusLegacyId Int False

The legacy ID for the item

StatusId String False

The unique identifier for the item

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

TransactionTypeId String False

TransactionTypes.Id

The unique identifier for the item

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

CreditNoteNumberPrefix String False

The credit note number prefix

VoidReason String False

The reason the credit note was voided

TaxReconciled Bool False

Indicates if the sales credit note is tax reconciled or not.

Editable Bool False

Indicates whether artefact can be edited

ShippingTotalAmount String False

The total shipping amount

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

Notes String False

credit note notes

MainAddressFreeForm String False

The free-form main address of the credit note

TotalPaid String False

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

DeletedAt Datetime True

The datetime when the item was deleted

Date String False

The date of the credit note

BaseCurrencyTaxAmount String False

The tax amount of the credit note in base currency

BaseCurrencyOutstandingAmount String False

The outstanding amount of the credit note in base currency

BaseCurrencyTotalDiscountAmount String False

The discount amount on the credit note in base currency

ShowPaymentsAllocations String False

MarkAsSent String False

ShowPaymentsAllocations String False

Search String False

FromDate Datetime True

ToDate Datetime True

DeletedSince Datetime True

HasAttachments String True

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