POST BankTransaction/Save

Saves the specified Bank Transaction.

Request Information

URI Parameters

None.

Body Parameters

The Bank Transaction.

Base Bank Transaction
NameTypeAdditional informationDescription
ID integer

None.

ParentId integer

None.

Description string

None.

BankUniqueIdentifier string

None.

Editable bool

Read Only / System Generated

SplitTransactions Collection of Base Bank Transaction

None.

Duplicate bool

Read Only / System Generated

Matched bool

Read Only / System Generated

HasAllocations bool

Read Only / System Generated

ImportTypeId nullable integer

None.

ImportActionDate nullable date

None.

HasManualDiscountAllocations bool

None.

DiscountAllocationChanged bool

None.

SelectionId nullable integer

None.

SelectionName string

None.

Selection_CurrencyId nullable integer

None.

Selection_ExchangeRate nullable decimal

None.

SelectionIsObfuscated bool

None.

$TrackingCode string

None.

ParentTrackingCode string

None.

Type Bank Transaction Type

None.

TaxTypeId nullable integer

None.

TaxPeriodId nullable integer

None.

Payee string

None.

Reconciled bool

None.

Accepted bool

None.

AnalysisCategoryId1 nullable integer

None.

AnalysisCategoryId2 nullable integer

None.

AnalysisCategoryId3 nullable integer

None.

BankAccountId nullable integer

None.

Date date

None.

Memo string

None.

DocumentNumber string

None.

Reference string

None.

Link_CurrencyId nullable integer

None.

Link_ExchangeRate nullable decimal

None.

HasAttachments nullable bool

Read Only / System Generated

Discount nullable decimal

None.

DiscountPercentage nullable decimal

None.

Rounding nullable decimal

None.

Exclusive decimal

None.

Tax decimal

None.

Total decimal

None.

BankAccount_CurrencyId nullable integer

None.

BankAccount_ExchangeRate nullable decimal

None.

PaymentMethodId nullable integer

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.

BankImportMappingId nullable integer

None.

$dirty bool

None.

Locked bool

Read Only / System Generated

TimeTrackingProjectId nullable integer

None.

TimeTrackingExpenseId nullable integer

None.

BillingMethodId nullable integer

None.

Recharge nullable decimal

None.

MarkupPercentage nullable decimal

None.

DocumentHeaderLinkTypeId nullable integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ID": 2,
  "ParentId": 1,
  "Description": "sample string 4",
  "BankUniqueIdentifier": "sample string 5",
  "Editable": true,
  "SplitTransactions": [],
  "Duplicate": true,
  "Matched": true,
  "HasAllocations": true,
  "ImportTypeId": 1,
  "ImportActionDate": "2024-11-15",
  "HasManualDiscountAllocations": true,
  "DiscountAllocationChanged": true,
  "SelectionId": 1,
  "SelectionName": "sample string 14",
  "Selection_CurrencyId": 1,
  "Selection_ExchangeRate": 1.0,
  "SelectionIsObfuscated": true,
  "$TrackingCode": "sample string 16",
  "ParentTrackingCode": "sample string 17",
  "Type": 1,
  "TaxTypeId": 1,
  "TaxPeriodId": 1,
  "Payee": "sample string 18",
  "Reconciled": true,
  "Accepted": true,
  "AnalysisCategoryId1": 1,
  "AnalysisCategoryId2": 1,
  "AnalysisCategoryId3": 1,
  "BankAccountId": 1,
  "Date": "2024-11-15",
  "Memo": "sample string 23",
  "DocumentNumber": "sample string 24",
  "Reference": "sample string 25",
  "Link_CurrencyId": 1,
  "Link_ExchangeRate": 1.0,
  "HasAttachments": true,
  "Discount": 1.0,
  "DiscountPercentage": 1.1,
  "Rounding": 1.0,
  "Exclusive": 30.0,
  "Tax": 31.0,
  "Total": 32.0,
  "BankAccount_CurrencyId": 1,
  "BankAccount_ExchangeRate": 1.0,
  "PaymentMethodId": 1,
  "StatusId": 1,
  "BankImportMappingId": 1,
  "$dirty": true,
  "Locked": true,
  "TimeTrackingProjectId": 1,
  "TimeTrackingExpenseId": 1,
  "BillingMethodId": 1,
  "Recharge": 1.0,
  "MarkupPercentage": 1.1,
  "DocumentHeaderLinkTypeId": 1
}

Response Information

Resource Description

Base Bank Transaction
NameTypeAdditional informationDescription
ID integer

None.

ParentId integer

None.

Description string

None.

BankUniqueIdentifier string

None.

Editable bool

Read Only / System Generated

SplitTransactions Collection of Base Bank Transaction

None.

Duplicate bool

Read Only / System Generated

Matched bool

Read Only / System Generated

HasAllocations bool

Read Only / System Generated

ImportTypeId nullable integer

None.

ImportActionDate nullable date

None.

HasManualDiscountAllocations bool

None.

DiscountAllocationChanged bool

None.

SelectionId nullable integer

None.

SelectionName string

None.

Selection_CurrencyId nullable integer

None.

Selection_ExchangeRate nullable decimal

None.

SelectionIsObfuscated bool

None.

$TrackingCode string

None.

ParentTrackingCode string

None.

Type Bank Transaction Type

None.

TaxTypeId nullable integer

None.

TaxPeriodId nullable integer

None.

Payee string

None.

Reconciled bool

None.

Accepted bool

None.

AnalysisCategoryId1 nullable integer

None.

AnalysisCategoryId2 nullable integer

None.

AnalysisCategoryId3 nullable integer

None.

BankAccountId nullable integer

None.

Date date

None.

Memo string

None.

DocumentNumber string

None.

Reference string

None.

Link_CurrencyId nullable integer

None.

Link_ExchangeRate nullable decimal

None.

HasAttachments nullable bool

Read Only / System Generated

Discount nullable decimal

None.

DiscountPercentage nullable decimal

None.

Rounding nullable decimal

None.

Exclusive decimal

None.

Tax decimal

None.

Total decimal

None.

BankAccount_CurrencyId nullable integer

None.

BankAccount_ExchangeRate nullable decimal

None.

PaymentMethodId nullable integer

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.

BankImportMappingId nullable integer

None.

$dirty bool

None.

Locked bool

Read Only / System Generated

TimeTrackingProjectId nullable integer

None.

TimeTrackingExpenseId nullable integer

None.

BillingMethodId nullable integer

None.

Recharge nullable decimal

None.

MarkupPercentage nullable decimal

None.

DocumentHeaderLinkTypeId nullable integer

None.

Response Formats

application/json, text/json

Sample:
{
  "ID": 2,
  "ParentId": 1,
  "Description": "sample string 4",
  "BankUniqueIdentifier": "sample string 5",
  "Editable": true,
  "SplitTransactions": [],
  "Duplicate": true,
  "Matched": true,
  "HasAllocations": true,
  "ImportTypeId": 1,
  "ImportActionDate": "2024-11-15",
  "HasManualDiscountAllocations": true,
  "DiscountAllocationChanged": true,
  "SelectionId": 1,
  "SelectionName": "sample string 14",
  "Selection_CurrencyId": 1,
  "Selection_ExchangeRate": 1.0,
  "SelectionIsObfuscated": true,
  "$TrackingCode": "sample string 16",
  "ParentTrackingCode": "sample string 17",
  "Type": 1,
  "TaxTypeId": 1,
  "TaxPeriodId": 1,
  "Payee": "sample string 18",
  "Reconciled": true,
  "Accepted": true,
  "AnalysisCategoryId1": 1,
  "AnalysisCategoryId2": 1,
  "AnalysisCategoryId3": 1,
  "BankAccountId": 1,
  "Date": "2024-11-15",
  "Memo": "sample string 23",
  "DocumentNumber": "sample string 24",
  "Reference": "sample string 25",
  "Link_CurrencyId": 1,
  "Link_ExchangeRate": 1.0,
  "HasAttachments": true,
  "Discount": 1.0,
  "DiscountPercentage": 1.1,
  "Rounding": 1.0,
  "Exclusive": 30.0,
  "Tax": 31.0,
  "Total": 32.0,
  "BankAccount_CurrencyId": 1,
  "BankAccount_ExchangeRate": 1.0,
  "PaymentMethodId": 1,
  "StatusId": 1,
  "BankImportMappingId": 1,
  "$dirty": true,
  "Locked": true,
  "TimeTrackingProjectId": 1,
  "TimeTrackingExpenseId": 1,
  "BillingMethodId": 1,
  "Recharge": 1.0,
  "MarkupPercentage": 1.1,
  "DocumentHeaderLinkTypeId": 1
}