POST BankTransaction/Save

Saves the specified Bank Transaction.

Request Information

URI Parameters

None.

Body Parameters

The Bank Transaction.

Bank Transaction
NameTypeAdditional informationDescription
ID integer

None.

Date date

None.

BankAccountId integer

None.

Type Bank Transaction Type

None.

SelectionId nullable integer

None.

SelectionName string

None.

SelectionIsObfuscated bool

None.

DocumentNumber string

None.

Payee string

None.

Reference string

None.

Description string

None.

TaxTypeId integer

None.

Exclusive decimal

None.

Tax decimal

None.

Total decimal

None.

Discount nullable decimal

None.

Reconciled bool

None.

BankUniqueIdentifier string

None.

AnalysisCategoryId1 nullable integer

None.

Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId.

AnalysisCategoryId2 nullable integer

None.

Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId.

AnalysisCategoryId3 nullable integer

None.

Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId.

Memo string

None.

BankImportMappingId nullable integer

None.

TaxPeriodId nullable integer

None.

Editable bool

Read Only / System Generated

SplitTransactions Collection of Bank Transaction

None.

Accepted bool

None.

Duplicate bool

Read Only / System Generated

Matched bool

Read Only / System Generated

MatchReference string

Read Only / System Generated

Locked bool

Read Only / System Generated

HasAttachments bool

Read Only / System Generated

HasAllocations bool

Read Only / System Generated

PaymentMethodId nullable integer

None.

ImportTypeId nullable integer

None.

$TrackingCode string

None.

$dirty bool

None.

BankAccount_CurrencyId nullable integer

None.

BankAccount_ExchangeRate nullable decimal

None.

Selection_CurrencyId nullable integer

None.

Selection_ExchangeRate nullable decimal

None.

TimeTrackingProjectId nullable integer

None.

TimeTrackingExpenseId nullable integer

None.

BillingMethodId nullable integer

None.

Recharge nullable decimal

None.

MarkupPercentage nullable decimal

None.

ImportActionDate nullable date

None.

HasManualDiscountAllocations bool

None.

StatusId nullable integer

Read Only / System Generated

This is set by the System and Cannot be set via the API. StatusId is used by Customer Bank Transactions [BankTransactionType 2] (Receipts) when locked for Bad Debt Recoveries. Null or Zero is not set. See for other statuses for Customer Bank Transactions.

Request Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "Date": "2021-10-19",
  "BankAccountId": 3,
  "Type": 1,
  "SelectionId": 1,
  "SelectionName": "sample string 4",
  "SelectionIsObfuscated": true,
  "DocumentNumber": "sample string 6",
  "Payee": "sample string 7",
  "Reference": "sample string 8",
  "Description": "sample string 9",
  "TaxTypeId": 10,
  "Exclusive": 11.0,
  "Tax": 12.0,
  "Total": 13.0,
  "Discount": 1.0,
  "Reconciled": true,
  "BankUniqueIdentifier": "sample string 15",
  "AnalysisCategoryId1": 1,
  "AnalysisCategoryId2": 1,
  "AnalysisCategoryId3": 1,
  "Memo": "sample string 16",
  "BankImportMappingId": 1,
  "TaxPeriodId": 1,
  "Editable": true,
  "SplitTransactions": [],
  "Accepted": true,
  "Duplicate": true,
  "Matched": true,
  "MatchReference": "sample string 21",
  "Locked": true,
  "HasAttachments": true,
  "HasAllocations": true,
  "PaymentMethodId": 1,
  "ImportTypeId": 1,
  "$TrackingCode": "sample string 25",
  "$dirty": true,
  "BankAccount_CurrencyId": 1,
  "BankAccount_ExchangeRate": 1.0,
  "Selection_CurrencyId": 1,
  "Selection_ExchangeRate": 1.0,
  "TimeTrackingProjectId": 1,
  "TimeTrackingExpenseId": 1,
  "BillingMethodId": 1,
  "Recharge": 1.0,
  "MarkupPercentage": 1.1,
  "ImportActionDate": "2021-10-19",
  "HasManualDiscountAllocations": true,
  "StatusId": 1
}

Response Information

Resource Description

Bank Transaction
NameTypeAdditional informationDescription
ID integer

None.

Date date

None.

BankAccountId integer

None.

Type Bank Transaction Type

None.

SelectionId nullable integer

None.

SelectionName string

None.

SelectionIsObfuscated bool

None.

DocumentNumber string

None.

Payee string

None.

Reference string

None.

Description string

None.

TaxTypeId integer

None.

Exclusive decimal

None.

Tax decimal

None.

Total decimal

None.

Discount nullable decimal

None.

Reconciled bool

None.

BankUniqueIdentifier string

None.

AnalysisCategoryId1 nullable integer

None.

Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId.

AnalysisCategoryId2 nullable integer

None.

Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId.

AnalysisCategoryId3 nullable integer

None.

Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId.

Memo string

None.

BankImportMappingId nullable integer

None.

TaxPeriodId nullable integer

None.

Editable bool

Read Only / System Generated

SplitTransactions Collection of Bank Transaction

None.

Accepted bool

None.

Duplicate bool

Read Only / System Generated

Matched bool

Read Only / System Generated

MatchReference string

Read Only / System Generated

Locked bool

Read Only / System Generated

HasAttachments bool

Read Only / System Generated

HasAllocations bool

Read Only / System Generated

PaymentMethodId nullable integer

None.

ImportTypeId nullable integer

None.

$TrackingCode string

None.

$dirty bool

None.

BankAccount_CurrencyId nullable integer

None.

BankAccount_ExchangeRate nullable decimal

None.

Selection_CurrencyId nullable integer

None.

Selection_ExchangeRate nullable decimal

None.

TimeTrackingProjectId nullable integer

None.

TimeTrackingExpenseId nullable integer

None.

BillingMethodId nullable integer

None.

Recharge nullable decimal

None.

MarkupPercentage nullable decimal

None.

ImportActionDate nullable date

None.

HasManualDiscountAllocations bool

None.

StatusId nullable integer

Read Only / System Generated

This is set by the System and Cannot be set via the API. StatusId is used by Customer Bank Transactions [BankTransactionType 2] (Receipts) when locked for Bad Debt Recoveries. Null or Zero is not set. See for other statuses for Customer Bank Transactions.

Response Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "Date": "2021-10-19",
  "BankAccountId": 3,
  "Type": 1,
  "SelectionId": 1,
  "SelectionName": "sample string 4",
  "SelectionIsObfuscated": true,
  "DocumentNumber": "sample string 6",
  "Payee": "sample string 7",
  "Reference": "sample string 8",
  "Description": "sample string 9",
  "TaxTypeId": 10,
  "Exclusive": 11.0,
  "Tax": 12.0,
  "Total": 13.0,
  "Discount": 1.0,
  "Reconciled": true,
  "BankUniqueIdentifier": "sample string 15",
  "AnalysisCategoryId1": 1,
  "AnalysisCategoryId2": 1,
  "AnalysisCategoryId3": 1,
  "Memo": "sample string 16",
  "BankImportMappingId": 1,
  "TaxPeriodId": 1,
  "Editable": true,
  "SplitTransactions": [],
  "Accepted": true,
  "Duplicate": true,
  "Matched": true,
  "MatchReference": "sample string 21",
  "Locked": true,
  "HasAttachments": true,
  "HasAllocations": true,
  "PaymentMethodId": 1,
  "ImportTypeId": 1,
  "$TrackingCode": "sample string 25",
  "$dirty": true,
  "BankAccount_CurrencyId": 1,
  "BankAccount_ExchangeRate": 1.0,
  "Selection_CurrencyId": 1,
  "Selection_ExchangeRate": 1.0,
  "TimeTrackingProjectId": 1,
  "TimeTrackingExpenseId": 1,
  "BillingMethodId": 1,
  "Recharge": 1.0,
  "MarkupPercentage": 1.1,
  "ImportActionDate": "2021-10-19",
  "HasManualDiscountAllocations": true,
  "StatusId": 1
}