Skip to content
ERPNext Data Model
Esc
navigateopen⌘Jpreview
On this page

Transactions

Accounts transactions — 26 entities with their key fields and relationships.

Submittable documents with a docstatus lifecycle. Once submitted they are immutable and post ledger entries; corrections are amendments or returns.

26 entities in Accounts.

Bank Guarantee

Records a guarantee issued or received through a bank, including the beneficiary, amount, validity, and linked transaction.

Transaction Submittable

Naming: Expression · 30 fields · 1 inbound ref

Key fields

Field Type Req Label
bg_type Select yes Bank Guarantee Type
amount Currency yes Amount
start_date Date yes Start Date

Relationships

Field Type References Req
account Link Account
amended_from Link Bank Guarantee
bank Link Bank
bank_account Link Bank Account
customer Link Customer
project Link Project
reference_doctype Link DocType (fw)
supplier Link Supplier
reference_docname Dynamic Link resolved via reference_doctype

Bank Transaction

Represents a bank-statement transaction imported or entered for matching and reconciliation against ERPNext payments.

Transaction Submittable

Naming: Naming Series · 37 fields · 1 inbound ref

Key fields

Field Type Req Label
naming_series Select yes Series
status Select Status
description Small Text Description
deposit Currency Deposit
withdrawal Currency Withdrawal

Relationships

Field Type References Req
amended_from Link Bank Transaction
bank_account Link Bank Account
company Link Company
currency Link Currency (fw)
matched_transaction_rule Link Bank Transaction Rule
party_type Link DocType (fw)
payment_entries Table Bank Transaction Payments
party Dynamic Link resolved via party_type

Budget

Sets spending or income limits for accounts and cost centers over a fiscal year.

Transaction Submittable

Naming: Naming Series · 40 fields · 1 inbound ref

Key fields

Field Type Req Label
budget_against Select yes Budget Against
naming_series Select yes Series
budget_amount Currency yes Budget Amount
distribution_frequency Select yes Distribution Frequency

Relationships

Field Type References Req
account Link Account yes
amended_from Link Budget
company Link Company yes
cost_center Link Cost Center
from_fiscal_year Link Fiscal Year yes
project Link Project
to_fiscal_year Link Fiscal Year yes
budget_distribution Table Budget Distribution

Cashier Closing

Summarizes a cashier’s payments, expenses, returns, custody, and outstanding amount for a selected time window.

Transaction Submittable

Naming: Naming Series · 12 fields · 1 inbound ref

Key fields

Field Type Req Label
naming_series Select Series
from_time Time yes From Time
time Time yes To Time
net_amount Float Net Amount

Relationships

Field Type References Req
amended_from Link Cashier Closing
user Link User (fw) yes
payments Table Cashier Closing Payments

Cost Center Allocation

Defines how amounts posted to one cost center are distributed among other cost centers by percentage.

Transaction Submittable

Naming: Expression (old style) · 7 fields · 1 inbound ref

Key fields

Field Type Req Label
valid_from Date yes Valid From

Relationships

Field Type References Req
amended_from Link Cost Center Allocation
company Link Company yes
main_cost_center Link Cost Center yes
allocation_percentages Table Cost Center Allocation Percentage yes

Dunning

Creates a formal payment demand for overdue Sales Invoices, including interest, fees, and letter text.

Transaction Submittable

Naming: Naming Series · 54 fields · 1 inbound ref

Key fields

Field Type Req Label
naming_series Select Series
customer_name Data Customer Name
posting_date Date yes Date
status Select Status

Relationships

Field Type References Req
amended_from Link Dunning
company Link Company yes
company_address Link Address (fw)
contact_person Link Contact (fw)
cost_center Link Cost Center
currency Link Currency (fw)
customer Link Customer yes
customer_address Link Address (fw)
dunning_type Link Dunning Type
income_account Link Account
language Link Language (fw)
letter_head Link Letter Head (fw)
overdue_payments Table Overdue Payment

Exchange Rate Revaluation

Revalues foreign-currency account balances at a selected exchange rate and creates the resulting accounting adjustment.

Transaction Submittable

Naming: Expression (old style) · 13 fields · 1 inbound ref

Key fields

Field Type Req Label
posting_date Date yes Posting Date

Relationships

Field Type References Req
amended_from Link Exchange Rate Revaluation
company Link Company yes
accounts Table Exchange Rate Revaluation Account yes

Invoice Discounting

Tracks short-term financing obtained against unpaid Sales Invoices and the associated bank charges and repayments.

Transaction Submittable

Naming: ACC-INV-DISC-.YYYY.-.##### · 22 fields · 1 inbound ref

Key fields

Field Type Req Label
posting_date Date yes Posting Date
status Select Status

Relationships

Field Type References Req
accounts_receivable_credit Link Account yes
accounts_receivable_discounted Link Account yes
accounts_receivable_unpaid Link Account yes
amended_from Link Invoice Discounting
bank_account Link Account yes
bank_charges_account Link Account yes
company Link Company yes
short_term_loan Link Account yes
invoices Table Discounted Invoice yes

Journal Entry

Posts a balanced set of debit and credit lines directly to the general ledger.

Transaction Submittable

Naming: Naming Series · 74 fields · 7 inbound refs

Key fields

Field Type Req Label
title Data Title
voucher_type Select yes Entry Type
naming_series Select yes Series
posting_date Date yes Posting Date
total_debit Currency Total Debit
total_amount Currency Total Amount

Relationships

Field Type References Req
amended_from Link Journal Entry
auto_repeat Link Auto Repeat (fw)
company Link Company yes
finance_book Link Finance Book
from_template Link Journal Entry Template
inter_company_journal_entry_reference Link Journal Entry
letter_head Link Letter Head (fw)
mode_of_payment Link Mode of Payment
payment_order Link Payment Order
periodic_entry_difference_account Link Account
process_deferred_accounting Link Process Deferred Accounting
reversal_of Link Journal Entry
select_print_heading Link Print Heading (fw)
stock_asset_account Link Account
stock_entry Link Stock Entry
tax_withholding_category Link Tax Withholding Category
tax_withholding_group Link Tax Withholding Group
total_amount_currency Link Currency (fw)
accounts Table Journal Entry Account yes
tax_withholding_entries Table Tax Withholding Entry

POS Closing Entry

Closes a cashier’s POS Opening Entry by consolidating its invoices, payments, taxes, and totals for the session.

Transaction Submittable

Naming: Expression (old style) · 31 fields · 2 inbound refs

Key fields

Field Type Req Label
period_start_date Datetime yes Period Start Date
period_end_date Datetime yes Period End Date
posting_date Date yes Posting Date
status Select Status
posting_time Time yes Posting Time

Relationships

Field Type References Req
amended_from Link POS Closing Entry
company Link Company yes
pos_opening_entry Link POS Opening Entry yes
pos_profile Link POS Profile yes
user Link User (fw) yes
payment_reconciliation Table POS Closing Entry Detail
pos_invoices Table POS Invoice Reference
sales_invoices Table Sales Invoice Reference
taxes Table POS Closing Entry Taxes

POS Invoice

Records an immediate point-of-sale sale or return, including items, stock impact, taxes, and payments.

Transaction Submittable

Naming: Naming Series · 185 fields · 5 inbound refs

Key fields

Field Type Req Label
naming_series Select yes Series
customer_name Data Customer Name
is_pos Check yes Include Payment (POS)
posting_date Date yes Date
conversion_rate Float yes Exchange Rate
plc_conversion_rate Float yes Price List Exchange Rate
base_net_total Currency yes Net Total (Company Currency)
base_grand_total Currency yes Grand Total (Company Currency)
grand_total Currency yes Grand Total
rounded_total Currency Rounded Total
status Select Status
title Data Title

Relationships

Field Type References Req
account_for_change_amount Link Account
amended_from Link POS Invoice
auto_repeat Link Auto Repeat (fw)
cash_bank_account Link Account
company Link Company yes
company_address Link Address (fw)
company_contact_person Link Contact (fw)
consolidated_invoice Link Sales Invoice
contact_person Link Contact (fw)
cost_center Link Cost Center
coupon_code Link Coupon Code
currency Link Currency (fw) yes
customer Link Customer
customer_address Link Address (fw)
customer_group Link Customer Group
debit_to Link Account yes
inter_company_invoice_reference Link Purchase Invoice
letter_head Link Letter Head (fw)
loyalty_program Link Loyalty Program
loyalty_redemption_account Link Account
loyalty_redemption_cost_center Link Cost Center
party_account_currency Link Currency (fw)
payment_terms_template Link Payment Terms Template
pos_profile Link POS Profile
price_list_currency Link Currency (fw) yes
project Link Project
return_against Link POS Invoice
sales_partner Link Sales Partner
select_print_heading Link Print Heading (fw)
selling_price_list Link Price List yes
set_warehouse Link Warehouse
shipping_address_name Link Address (fw)
shipping_rule Link Shipping Rule
tax_category Link Tax Category
taxes_and_charges Link Sales Taxes and Charges Template
tc_name Link Terms and Conditions
territory Link Territory
utm_campaign Link UTM Campaign (fw)
utm_medium Link UTM Medium (fw)
utm_source Link UTM Source (fw)
write_off_account Link Account
write_off_cost_center Link Cost Center
advances Table Sales Invoice Advance
item_wise_tax_details Table Item Wise Tax Detail
items Table POS Invoice Item yes
packed_items Table Packed Item
payment_schedule Table Payment Schedule
payments Table Sales Invoice Payment
pricing_rules Table Pricing Rule Detail
sales_team Table Sales Team
taxes Table Sales Taxes and Charges
timesheets Table Sales Invoice Timesheet

POS Opening Entry

Opens a cashier’s POS session for a selected profile and records the starting balances by payment method.

Transaction Submittable

Naming: POS-OPE-.YYYY.-.##### · 16 fields · 2 inbound refs

Key fields

Field Type Req Label
period_start_date Datetime yes Period Start Date
period_end_date Date Period End Date
posting_date Date yes Posting Date
status Select Status

Relationships

Field Type References Req
amended_from Link POS Opening Entry
company Link Company yes
pos_profile Link POS Profile yes
user Link User (fw) yes
balance_details Table POS Opening Entry Detail yes

Payment Entry

Records money received, paid, or transferred and allocates it to invoices, orders, or other references.

Transaction Submittable

Naming: Naming Series · 93 fields · 1 inbound ref

Key fields

Field Type Req Label
naming_series Select yes Series
payment_type Select yes Payment Type
posting_date Date yes Posting Date
paid_amount Currency yes Paid Amount
source_exchange_rate Float yes Source Exchange Rate
base_paid_amount Currency yes Paid Amount (Company Currency)
received_amount Currency yes Received Amount
target_exchange_rate Float yes Target Exchange Rate
base_received_amount Currency yes Received Amount (Company Currency)
total_allocated_amount Currency Total Allocated Amount
difference_amount Currency Difference Amount (Company Currency)
reference_no Data Cheque/Reference No
reference_date Date Cheque/Reference Date
title Data Title
status Select Status

Relationships

Field Type References Req
amended_from Link Payment Entry
auto_repeat Link Auto Repeat (fw)
bank_account Link Bank Account
company Link Company yes
contact_person Link Contact (fw)
cost_center Link Cost Center
letter_head Link Letter Head (fw)
mode_of_payment Link Mode of Payment
paid_from Link Account yes
paid_from_account_currency Link Currency (fw) yes
paid_to Link Account yes
paid_to_account_currency Link Currency (fw) yes
party_bank_account Link Bank Account
party_type Link DocType (fw)
payment_order Link Payment Order
print_heading Link Print Heading (fw)
project Link Project
purchase_taxes_and_charges_template Link Purchase Taxes and Charges Template
sales_taxes_and_charges_template Link Sales Taxes and Charges Template
tax_withholding_category Link Tax Withholding Category
tax_withholding_group Link Tax Withholding Group
deductions Table Payment Entry Deduction
references Table Payment Entry Reference
tax_withholding_entries Table Tax Withholding Entry
taxes Table Advance Taxes and Charges
party Dynamic Link resolved via party_type

Payment Order

Collects approved Supplier payments into a bulk payment instruction.

Transaction Submittable

Naming: Naming Series · 12 fields · 4 inbound refs

Key fields

Field Type Req Label
naming_series Select yes Series
posting_date Date Posting Date
payment_order_type Select yes Payment Order Type

Relationships

Field Type References Req
amended_from Link Payment Order
company Link Company yes
company_bank Link Bank
company_bank_account Link Bank Account yes
party Link Supplier
references Table Payment Order Reference yes

Payment Request

Requests payment for a transaction through a configured payment gateway or other payment channel.

Transaction Submittable

Naming: Naming Series · 60 fields · 3 inbound refs

Key fields

Field Type Req Label
payment_request_type Select yes Payment Request Type
transaction_date Date Transaction Date
naming_series Select yes Series
grand_total Currency yes Amount
status Select Status

Relationships

Field Type References Req
amended_from Link Payment Request
bank Link Bank
bank_account Link Bank Account
company Link Company
cost_center Link Cost Center
currency Link Currency (fw)
mode_of_payment Link Mode of Payment
party_account_currency Link Currency (fw)
party_type Link DocType (fw)
payment_gateway_account Link Payment Gateway Account
payment_order Link Payment Order
project Link Project
reference_doctype Link DocType (fw)
payment_reference Table Payment Reference
subscription_plans Table Subscription Plan Detail
party Dynamic Link resolved via party_type
reference_name Dynamic Link resolved via reference_doctype

Period Closing Voucher

Closes profit-and-loss balances for an accounting period by transferring the result to a closing Account.

Transaction Submittable

Naming: Expression (old style) · 11 fields · 3 inbound refs

Key fields

Field Type Req Label
transaction_date Date Transaction Date
remarks Small Text yes Remarks
period_end_date Date yes Period End Date
period_start_date Date yes Period Start Date

Relationships

Field Type References Req
amended_from Link Period Closing Voucher
closing_account_head Link Account yes
company Link Company yes
fiscal_year Link Fiscal Year yes

Process Deferred Accounting

Runs deferred revenue or expense recognition for a selected company and posting period.

Transaction Submittable

Naming: ACC-PDA-.##### · 8 fields · 2 inbound refs

Key fields

Field Type Req Label
type Select yes Type
start_date Date yes Service Start Date
end_date Date yes Service End Date
posting_date Date yes Posting Date

Relationships

Field Type References Req
account Link Account
amended_from Link Process Deferred Accounting
company Link Company yes

Process Payment Reconciliation

Runs payment reconciliation in the background for a selected party, account, and invoice/payment date range.

Transaction Submittable

Naming: format ACC-PPR-{#####} · 20 fields · 1 inbound ref

Key fields

Field Type Req Label
status Select Status

Relationships

Field Type References Req
amended_from Link Process Payment Reconciliation
bank_cash_account Link Account
company Link Company yes
cost_center Link Cost Center
default_advance_account Link Account
party_type Link DocType (fw) yes
receivable_payable_account Link Account yes
party Dynamic Link resolved via party_type

Process Period Closing Voucher

Tracks the staged processing of a Period Closing Voucher across normal, opening, profit-and-loss, and balance-sheet balances.

Transaction Submittable

Naming: format Process-PCV-{###} · 9 fields · 1 inbound ref

Key fields

Field Type Req Label
status Select Status

Relationships

Field Type References Req
amended_from Link Process Period Closing Voucher
parent_pcv Link Period Closing Voucher yes
normal_balances Table Process Period Closing Voucher Detail
z_opening_balances Table Process Period Closing Voucher Detail

Process Subscription

Runs subscription processing for a selected posting date and optional Subscription.

Transaction Submittable

Naming: hash · 3 fields · 1 inbound ref

Key fields

Field Type Req Label
posting_date Date yes Posting Date

Relationships

Field Type References Req
amended_from Link Process Subscription
subscription Link Subscription

Purchase Invoice

Records a Supplier bill, its taxes and charges, and the payable amount owed by the company.

Transaction Submittable

Naming: Naming Series · 200 fields · 8 inbound refs

Key fields

Field Type Req Label
naming_series Select yes Series
supplier_name Data Supplier Name
due_date Date Due Date
posting_date Date yes Posting Date
bill_no Data Supplier Invoice No
grand_total Currency Grand Total
status Select Status
title Data Title

Relationships

Field Type References Req
amended_from Link Purchase Invoice
auto_repeat Link Auto Repeat (fw)
billing_address Link Address (fw)
buying_price_list Link Price List
cash_bank_account Link Account
company Link Company
contact_person Link Contact (fw)
cost_center Link Cost Center
credit_to Link Account yes
currency Link Currency (fw)
dispatch_address Link Address (fw)
incoterm Link Incoterm
inter_company_invoice_reference Link Sales Invoice
letter_head Link Letter Head (fw)
mode_of_payment Link Mode of Payment
party_account_currency Link Currency (fw)
payment_terms_template Link Payment Terms Template
price_list_currency Link Currency (fw)
project Link Project
rejected_warehouse Link Warehouse
represents_company Link Company
return_against Link Purchase Invoice
select_print_heading Link Print Heading (fw)
set_from_warehouse Link Warehouse
set_warehouse Link Warehouse
shipping_address Link Address (fw)
shipping_rule Link Shipping Rule
subscription Link Subscription
supplier Link Supplier yes
supplier_address Link Address (fw)
supplier_group Link Supplier Group
supplier_warehouse Link Warehouse
tax_category Link Tax Category
tax_withholding_group Link Tax Withholding Group
taxes_and_charges Link Purchase Taxes and Charges Template
tc_name Link Terms and Conditions
unrealized_profit_loss_account Link Account
write_off_account Link Account
write_off_cost_center Link Cost Center
advances Table Purchase Invoice Advance
item_wise_tax_details Table Item Wise Tax Detail
items Table Purchase Invoice Item yes
payment_schedule Table Payment Schedule
pricing_rules Table Pricing Rule Detail
supplied_items Table Purchase Receipt Item Supplied
tax_withholding_entries Table Tax Withholding Entry
taxes Table Purchase Taxes and Charges

Repost Accounting Ledger

Rebuilds accounting ledger entries for selected vouchers after validating that they are eligible for reposting.

Transaction Submittable

Naming: hash · 6 fields · 1 inbound ref

Relationships

Field Type References Req
amended_from Link Repost Accounting Ledger
company Link Company
vouchers Table Repost Accounting Ledger Items

Repost Payment Ledger

Rebuilds Payment Ledger Entries for selected vouchers and records the queued job’s result or errors.

Transaction Submittable

Naming: hash · 12 fields · 1 inbound ref

Key fields

Field Type Req Label
posting_date Date yes Posting Date

Relationships

Field Type References Req
amended_from Link Repost Payment Ledger
company Link Company yes
voucher_type Link DocType (fw)
repost_vouchers Table Repost Payment Ledger Items

Sales Invoice

Records a Customer bill, its taxes and charges, and the receivable amount owed to the company.

Transaction Submittable

Naming: Naming Series · 233 fields · 12 inbound refs

Key fields

Field Type Req Label
naming_series Select yes Series
customer_name Small Text Customer Name
posting_date Date yes Posting Date
due_date Date Payment Due Date
conversion_rate Float yes Exchange Rate
plc_conversion_rate Float yes Price List Exchange Rate
base_net_total Currency yes Net Total (Company Currency)
base_grand_total Currency yes Grand Total (Company Currency
grand_total Currency yes Grand Total
rounded_total Currency Rounded Total
status Select Status
title Data Title

Relationships

Field Type References Req
account_for_change_amount Link Account
additional_discount_account Link Account
amended_from Link Sales Invoice
auto_repeat Link Auto Repeat (fw)
cash_bank_account Link Account
company Link Company yes
company_address Link Address (fw)
company_contact_person Link Contact (fw)
contact_person Link Contact (fw)
cost_center Link Cost Center
coupon_code Link Coupon Code
currency Link Currency (fw) yes
customer Link Customer yes
customer_address Link Address (fw)
customer_group Link Customer Group
debit_to Link Account yes
dispatch_address_name Link Address (fw)
incoterm Link Incoterm
inter_company_invoice_reference Link Purchase Invoice
language Link Language (fw)
letter_head Link Letter Head (fw)
loyalty_program Link Loyalty Program
loyalty_redemption_account Link Account
loyalty_redemption_cost_center Link Cost Center
party_account_currency Link Currency (fw)
payment_terms_template Link Payment Terms Template
pos_closing_entry Link POS Closing Entry
pos_profile Link POS Profile
price_list_currency Link Currency (fw) yes
project Link Project
represents_company Link Company
return_against Link Sales Invoice
sales_partner Link Sales Partner
select_print_heading Link Print Heading (fw)
selling_price_list Link Price List yes
set_target_warehouse Link Warehouse
set_warehouse Link Warehouse
shipping_address_name Link Address (fw)
shipping_rule Link Shipping Rule
subscription Link Subscription
tax_category Link Tax Category
tax_withholding_group Link Tax Withholding Group
taxes_and_charges Link Sales Taxes and Charges Template
tc_name Link Terms and Conditions
territory Link Territory
unrealized_profit_loss_account Link Account
utm_campaign Link UTM Campaign (fw)
utm_medium Link UTM Medium (fw)
utm_source Link UTM Source (fw)
write_off_account Link Account
write_off_cost_center Link Cost Center
advances Table Sales Invoice Advance
item_wise_tax_details Table Item Wise Tax Detail
items Table Sales Invoice Item yes
packed_items Table Packed Item
payment_schedule Table Payment Schedule
payments Table Sales Invoice Payment
pricing_rules Table Pricing Rule Detail
sales_team Table Sales Team
tax_withholding_entries Table Tax Withholding Entry
taxes Table Sales Taxes and Charges
timesheets Table Sales Invoice Timesheet

Share Transfer

Records the issue, transfer, or company purchase of shares between the company and its Shareholders.

Transaction Submittable

Naming: ACC-SHT-.YYYY.-.##### · 26 fields · 1 inbound ref

Key fields

Field Type Req Label
transfer_type Select yes Transfer Type
date Date yes Date
from_no Int yes From No
rate Currency yes Rate
no_of_shares Int yes No of Shares
to_no Int yes To No

Relationships

Field Type References Req
amended_from Link Share Transfer
asset_account Link Account
company Link Company yes
equity_or_liability_account Link Account yes
from_shareholder Link Shareholder
share_type Link Share Type yes
to_shareholder Link Shareholder

Unreconcile Payment

Removes selected allocations between a payment or invoice and its linked vouchers without cancelling the original document.

Transaction Submittable

Naming: hash · 6 fields · 1 inbound ref

Relationships

Field Type References Req
amended_from Link Unreconcile Payment
company Link Company
voucher_type Link DocType (fw)
allocations Table Unreconcile Payment Entries
voucher_no Dynamic Link resolved via voucher_type

Was this page helpful?