PurchaseCreditNotes
Query PurchaseCreditNotes in Sage Business Cloud Accounting.
Table Specific Information
Query the available PurchaseCreditNotes
Select
The driver uses the Sage Accounting API to process search criteria that refer to ContactId,StatusId,ShowPaymentsAllocations,Search,FromDate,ToDate,UpdatedOrCreatedSince,DeletedSince,HasAttachments,ShowPaymentsAllocations columns. The driver processes other filters client-side within the driver.
- ContactId supports the '=' operator.
- StatusId 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.
- ShowPaymentsAllocations supports the '=' operator.
For example, the following queries are processed server side:
SELECT * FROM PurchaseCreditNotes WHERE ContactId = 'abc' SELECT * FROM PurchaseCreditNotes WHERE StatusId = 'abc' SELECT * FROM PurchaseCreditNotes WHERE ShowPaymentsAllocations = 'abc' SELECT * FROM PurchaseCreditNotes WHERE Search = 'abc' SELECT * FROM PurchaseCreditNotes WHERE FromDate = '2018-12-15' SELECT * FROM PurchaseCreditNotes WHERE ToDate = '2018-12-15' SELECT * FROM PurchaseCreditNotes WHERE UpdatedOrCreatedSince = '2018-12-15' SELECT * FROM PurchaseCreditNotes WHERE DeletedSince = '2018-12-15' SELECT * FROM PurchaseCreditNotes WHERE HasAttachments = 'abc' SELECT * FROM PurchaseCreditNotes WHERE ShowPaymentsAllocations = 'abc'
Insert
Create a simple purchase credit note.
INSERT INTO [PurchaseCreditNotes] (ContactName, TotalQuantity, DisplayedAs) VALUES ('test', '1', 'test')
Update
UPDATEs are performed based on Id.
UPDATE PurchaseCreditNotes SET Reference = 'abc' WHERE Id = '123'
Delete
You must specify the Id of the PurchaseCreditNotes to delete it.
DELETE FROM PurchaseCreditNotes 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 | |
PurchaseCreditNoteLineItemAggregate | String | False |
The credit note lines of the credit note | |
BaseCurrencyTotalAmount | String | False |
The total amount of the credit note in base currency | |
BaseCurrencyNetAmount | String | False |
The net amount of the credit note in base currency | |
ContactName | String | False |
The name of the contact when the credit note was created | |
Migrated | Bool | False |
Indicates if the purchase credit note was migrated from another system. | |
TaxAmount | String | False |
The tax amount of the credit note | |
LastPaid | String | False |
The date of the last payment | |
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 purchase credit note, returns invoice or cash. | |
PaymentsAllocationsAggregate | String | False |
The associated payments and allocations | |
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 | |
InverseExchangeRate | String | False |
The inverse exchange rate for the credit note | |
TotalQuantity | String | False |
The total quantity of the credit note | |
TransactionId | String | False |
Transactions.Id |
The unique identifier for the item |
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 |
Transactions.Id |
The unique identifier for the item |
CreatedAt | Datetime | True |
The datetime when the item was created | |
PaymentsAllocationsTotalAmount | String | False |
The total amount of all payments and allocations | |
VoidReason | String | False |
The reason the credit note was voided | |
TaxReconciled | Bool | False |
Indicates if the purchase credit note is tax reconciled or not. | |
Editable | Bool | False |
Indicates whether artefact can be edited | |
VendorReference | String | False |
The vendor reference for the credit note | |
CurrencyId | String | False |
Currencies.Id |
The unique identifier for the item |
Notes | String | False |
credit note notes | |
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 | |
BaseCurrencyTaxAmount | String | False |
The tax amount of the credit note in base currency | |
Date | Datetime | True |
The date of the credit note | |
BaseCurrencyOutstandingAmount | String | False |
The outstanding amount of the credit note in base currency | |
ShowPaymentsAllocations | String | False | ||
Search | String | False | ||
FromDate | Datetime | True | ||
ToDate | Datetime | True | ||
DeletedSince | Datetime | True | ||
HasAttachments | String | False | ||
ShowPaymentsAllocations | String | True |