ContactPayments
Query ContactPayments in Sage Business Cloud Accounting.
Table Specific Information
Query the available ContactPayments
Select
The driver uses the Sage Accounting API to process search criteria that refer to TransactionTypeId,BankAccountId,ContactId,UpdatedOrCreatedSince,DeletedSince,FromDate,ToDate columns. The driver processes other filters client-side within the driver.
- TransactionTypeId supports the '=' operator.
- BankAccountId supports the '=' operator.
- ContactId supports the '=' operator.
- UpdatedOrCreatedSince supports the '=' operator.
- DeletedSince supports the '=' operator.
- FromDate supports the '=' operator.
- ToDate supports the '=' operator.
For example, the following queries are processed server side:
SELECT * FROM ContactPayments WHERE TransactionTypeId = 'abc' SELECT * FROM ContactPayments WHERE BankAccountId = 'abc' SELECT * FROM ContactPayments WHERE ContactId = 'abc' SELECT * FROM ContactPayments WHERE UpdatedOrCreatedSince = '2018-12-15' SELECT * FROM ContactPayments WHERE DeletedSince = '2018-12-15' SELECT * FROM ContactPayments WHERE FromDate = '2018-12-15' SELECT * FROM ContactPayments WHERE ToDate = '2018-12-15'
Update
Updates are performed based on Id.
UPDATE ContactPayments SET TaxRateId = 'abc' WHERE Id = '123'
Delete
You must specify the Id of the ContactPayments to delete it.
DELETE FROM ContactPayments 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 |
BaseCurrencyCurrencyCharge | String | False |
The currency conversion charges in base currency | |
CreatedAt | Datetime | True |
The datetime when the item was created | |
LinksAggregate | String | False |
Links for the resource | |
AllocatedArtefactsAggregate | String | False |
The allocated artefacts | |
TransactionTypeId | String | False |
The unique identifier for the item | |
NetAmount | String | False |
The net amount of the payment | |
BaseCurrencyTaxAmount | String | False |
The tax amount of the payment in base currency | |
CurrencyId | String | False |
Currencies.Id |
The unique identifier for the item |
PaymentMethodId | String | False |
The unique identifier for the item | |
BaseCurrencyTotalAmount | String | False |
The total amount of the payment in base currency | |
Reference | String | False |
A reference for the payment | |
TotalAmount | String | False |
The total amount of the payment | |
DeletedAt | Datetime | True |
The datetime when the item was deleted | |
BankAccountId | String | False |
BankAccounts.Id |
The unique identifier for the item |
BaseCurrencyNetAmount | String | False |
The net amount of the payment in base currency | |
PaymentOnAccountContactName | String | False |
The name of the contact when the payment on account was created | |
PaymentOnAccountCreatedAt | Datetime | True |
The datetime when the item was created | |
PaymentOnAccountBaseCurrencyOutstandingAmount | String | False |
The outstanding amount of the payment on account in base currency | |
PaymentOnAccountNetAmount | String | False |
The net amount of the payment on account | |
PaymentOnAccountBaseCurrencyTaxAmount | String | False |
The tax amount of the payment on account in base currency | |
PaymentOnAccountCurrencyId | String | False |
Currencies.Id |
The unique identifier for the item |
PaymentOnAccountBaseCurrencyTotalAmount | String | False |
The total amount of the payment on account in base currency | |
PaymentOnAccountReference | String | False |
The reference for the payment on account | |
PaymentOnAccountTotalAmount | String | False |
The total amount of the payment on account | |
PaymentOnAccountId | String | False |
The unique identifier for the item | |
PaymentOnAccountBaseCurrencyNetAmount | String | False |
The net amount of the payment on account in base currency | |
PaymentOnAccountStatusDisplayedAs | String | False |
The name of the resource | |
PaymentOnAccountStatusLegacyId | Int | False |
The legacy ID for the item | |
PaymentOnAccountStatusId | String | False |
The unique identifier for the item | |
PaymentOnAccountContactReference | String | False |
The reference of the contact when the payment on account was created | |
PaymentOnAccountDisplayedAs | String | False |
The name of the resource | |
PaymentOnAccountTaxAmount | String | False |
The tax amount of the payment on account | |
PaymentOnAccountContactDisplayedAs | String | False |
The name of the resource | |
PaymentOnAccountContactLegacyId | Int | False |
The legacy ID for the item | |
PaymentOnAccountContactId | String | False |
The unique identifier for the item | |
PaymentOnAccountOutstandingAmount | String | False |
The outstanding amount of the payment on account | |
PaymentOnAccountLegacyId | Int | False |
The legacy ID for the item | |
PaymentOnAccountDate | String | False |
The date of the payment on account | |
PaymentOnAccountExchangeRate | String | False |
The exchange rate for the payment on account | |
PaymentOnAccountUpdatedAt | Datetime | True |
The datetime when the item was last updated | |
Editable | Bool | False |
Indicates whether payment can be edited | |
DisplayedAs | String | False |
The name of the resource | |
TaxAmount | String | False |
The tax amount of the payment | |
TransactionId | String | False |
Transactions.Id |
The unique identifier for the item |
ContactId | String | False |
Contacts.Id |
The unique identifier for the item |
LegacyId | Int | False |
The legacy ID for the item | |
Date | String | False |
The date the payment was made | |
UpdatedAt | Datetime | True |
The datetime when the item was last updated | |
ExchangeRate | String | False |
The exchange rate of the payment | |
DeletedSince | Datetime | True | ||
FromDate | Datetime | True | ||
ToDate | Datetime | True |