The Journal Entry object
Attributes
id string
Unique identifier for the object.
created_at string
ISO 8601 timestamp of when the object was created.
updated_at string
ISO 8601 timestamp of when the object was last updated.
status string
Default: draft
title string
voucher_type string
Default: Journal Entry
posting_date string required
company string required
finance_book string
cheque_no string
cheque_date string
user_remark string
total_debit number
total_credit number
difference number
multi_currency boolean
Default: false
total_amount_currency string
total_amount number
total_amount_in_words string
clearance_date string
remark string
inter_company_journal_entry_reference string
bill_no string
bill_date string
due_date string
write_off_based_on string
Default: Accounts Receivable
write_off_amount number
pay_to_recd_from string
letter_head string
select_print_heading string
mode_of_payment string
payment_order string
is_opening string
Default: No
stock_entry string
auto_repeat string
from_template string
tax_withholding_category string
apply_tds boolean
Default: false
reversal_of string
process_deferred_accounting string
is_system_generated boolean
Default: false
periodic_entry_difference_account string
for_all_stock_asset_accounts boolean
Default: true
stock_asset_account string
party_not_required boolean
Default: false
tax_withholding_group string
ignore_tax_withholding_threshold boolean
Default: false
override_tax_withholding_entries boolean
Default: false
The Journal Entry object
{
"id": "journal-entry_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"title": "title_example",
"voucher_type": "Journal Entry",
"posting_date": "2024-01-15",
"company": "Example Corp",
"finance_book": "finance_book_example",
"cheque_no": "cheque_no_example",
"cheque_date": "2024-01-15",
"user_remark": "user_remark_example",
"total_debit": 0,
"total_credit": 0,
"difference": 0,
"multi_currency": false,
"total_amount_currency": "USD",
"total_amount": 0,
"total_amount_in_words": "total_amount_in_words_example",
"clearance_date": "2024-01-15",
"remark": "remark_example",
"inter_company_journal_entry_reference": "Example Corp",
"bill_no": "bill_no_example",
"bill_date": "2024-01-15",
"due_date": "2024-01-15",
"write_off_based_on": "Accounts Receivable",
"write_off_amount": 0,
"pay_to_recd_from": "pay_to_recd_from_example",
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"mode_of_payment": "mode_of_payment_example",
"payment_order": "payment_order_example",
"is_opening": "No",
"stock_entry": "stock_entry_example",
"auto_repeat": "auto_repeat_example",
"from_template": "from_template_example",
"tax_withholding_category": "tax_withholding_category_example",
"apply_tds": false,
"reversal_of": "reversal_of_example",
"process_deferred_accounting": "process_deferred_accounting_example",
"is_system_generated": false,
"periodic_entry_difference_account": "periodic_entry_difference_account_example",
"for_all_stock_asset_accounts": true,
"stock_asset_account": "stock_asset_account_example",
"party_not_required": false,
"tax_withholding_group": "tax_withholding_group_example",
"ignore_tax_withholding_threshold": false,
"override_tax_withholding_entries": false
} GET
/api/accounts/journal-entry/{id} Retrieve a journal entry
Retrieves the details of an existing journal entry. Supply the unique journal entry ID that was returned from a previous request.
Path parameters
id string required
The identifier of the journal entry to retrieve.
Returns
Returns the journal entry object if a valid identifier was provided.
GET /api/accounts/journal-entry/{id}
curl https://api.overplane.dev/api/accounts/journal-entry/journal-entry_abc123 \
-H "Authorization: Bearer sk_test_..." Response
{
"id": "journal-entry_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"title": "title_example",
"voucher_type": "Journal Entry",
"posting_date": "2024-01-15",
"company": "Example Corp",
"finance_book": "finance_book_example",
"cheque_no": "cheque_no_example",
"cheque_date": "2024-01-15",
"user_remark": "user_remark_example",
"total_debit": 0,
"total_credit": 0,
"difference": 0,
"multi_currency": false,
"total_amount_currency": "USD",
"total_amount": 0,
"total_amount_in_words": "total_amount_in_words_example",
"clearance_date": "2024-01-15",
"remark": "remark_example",
"inter_company_journal_entry_reference": "Example Corp",
"bill_no": "bill_no_example",
"bill_date": "2024-01-15",
"due_date": "2024-01-15",
"write_off_based_on": "Accounts Receivable",
"write_off_amount": 0,
"pay_to_recd_from": "pay_to_recd_from_example",
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"mode_of_payment": "mode_of_payment_example",
"payment_order": "payment_order_example",
"is_opening": "No",
"stock_entry": "stock_entry_example",
"auto_repeat": "auto_repeat_example",
"from_template": "from_template_example",
"tax_withholding_category": "tax_withholding_category_example",
"apply_tds": false,
"reversal_of": "reversal_of_example",
"process_deferred_accounting": "process_deferred_accounting_example",
"is_system_generated": false,
"periodic_entry_difference_account": "periodic_entry_difference_account_example",
"for_all_stock_asset_accounts": true,
"stock_asset_account": "stock_asset_account_example",
"party_not_required": false,
"tax_withholding_group": "tax_withholding_group_example",
"ignore_tax_withholding_threshold": false,
"override_tax_withholding_entries": false
} GET
/api/accounts/journal-entry List all journal entrys
Returns a list of journal entrys. The results are sorted by creation date, with the most recently created appearing first.
Query parameters
limit integer
Maximum number of objects to return. Default: 20.
offset integer
Number of objects to skip for pagination. Default: 0.
Returns
A paginated list of journal entry objects.
GET /api/accounts/journal-entry
curl https://api.overplane.dev/api/accounts/journal-entry \
-H "Authorization: Bearer sk_test_..." Response
{
"data": [
{
"id": "journal-entry_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"title": "title_example",
"voucher_type": "Journal Entry",
"posting_date": "2024-01-15",
"company": "Example Corp",
"finance_book": "finance_book_example",
"cheque_no": "cheque_no_example",
"cheque_date": "2024-01-15",
"user_remark": "user_remark_example",
"total_debit": 0,
"total_credit": 0,
"difference": 0,
"multi_currency": false,
"total_amount_currency": "USD",
"total_amount": 0,
"total_amount_in_words": "total_amount_in_words_example",
"clearance_date": "2024-01-15",
"remark": "remark_example",
"inter_company_journal_entry_reference": "Example Corp",
"bill_no": "bill_no_example",
"bill_date": "2024-01-15",
"due_date": "2024-01-15",
"write_off_based_on": "Accounts Receivable",
"write_off_amount": 0,
"pay_to_recd_from": "pay_to_recd_from_example",
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"mode_of_payment": "mode_of_payment_example",
"payment_order": "payment_order_example",
"is_opening": "No",
"stock_entry": "stock_entry_example",
"auto_repeat": "auto_repeat_example",
"from_template": "from_template_example",
"tax_withholding_category": "tax_withholding_category_example",
"apply_tds": false,
"reversal_of": "reversal_of_example",
"process_deferred_accounting": "process_deferred_accounting_example",
"is_system_generated": false,
"periodic_entry_difference_account": "periodic_entry_difference_account_example",
"for_all_stock_asset_accounts": true,
"stock_asset_account": "stock_asset_account_example",
"party_not_required": false,
"tax_withholding_group": "tax_withholding_group_example",
"ignore_tax_withholding_threshold": false,
"override_tax_withholding_entries": false
}
],
"has_more": false,
"total": 1
} POST
/api/accounts/journal-entry Create a journal entry
Creates a new journal entry object.
Body parameters
status string
Default: draft
title string
voucher_type string
Default: Journal Entry
posting_date string required
company string required
finance_book string
cheque_no string
cheque_date string
user_remark string
total_debit number
total_credit number
difference number
multi_currency boolean
Default: false
total_amount_currency string
total_amount number
total_amount_in_words string
clearance_date string
remark string
inter_company_journal_entry_reference string
bill_no string
bill_date string
due_date string
write_off_based_on string
Default: Accounts Receivable
write_off_amount number
pay_to_recd_from string
letter_head string
select_print_heading string
mode_of_payment string
payment_order string
is_opening string
Default: No
stock_entry string
auto_repeat string
from_template string
tax_withholding_category string
apply_tds boolean
Default: false
reversal_of string
process_deferred_accounting string
is_system_generated boolean
Default: false
periodic_entry_difference_account string
for_all_stock_asset_accounts boolean
Default: true
stock_asset_account string
party_not_required boolean
Default: false
tax_withholding_group string
ignore_tax_withholding_threshold boolean
Default: false
override_tax_withholding_entries boolean
Default: false
Returns
Returns the newly created journal entry object if the call succeeded.
POST /api/accounts/journal-entry
curl https://api.overplane.dev/api/accounts/journal-entry \
-H "Authorization: Bearer sk_test_..." \
-X POST \
-H "Content-Type: application/json" \
-d '{"posting_date":"2024-01-15","company":"Example Corp"}' Response
{
"id": "journal-entry_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"title": "title_example",
"voucher_type": "Journal Entry",
"posting_date": "2024-01-15",
"company": "Example Corp",
"finance_book": "finance_book_example",
"cheque_no": "cheque_no_example",
"cheque_date": "2024-01-15",
"user_remark": "user_remark_example",
"total_debit": 0,
"total_credit": 0,
"difference": 0,
"multi_currency": false,
"total_amount_currency": "USD",
"total_amount": 0,
"total_amount_in_words": "total_amount_in_words_example",
"clearance_date": "2024-01-15",
"remark": "remark_example",
"inter_company_journal_entry_reference": "Example Corp",
"bill_no": "bill_no_example",
"bill_date": "2024-01-15",
"due_date": "2024-01-15",
"write_off_based_on": "Accounts Receivable",
"write_off_amount": 0,
"pay_to_recd_from": "pay_to_recd_from_example",
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"mode_of_payment": "mode_of_payment_example",
"payment_order": "payment_order_example",
"is_opening": "No",
"stock_entry": "stock_entry_example",
"auto_repeat": "auto_repeat_example",
"from_template": "from_template_example",
"tax_withholding_category": "tax_withholding_category_example",
"apply_tds": false,
"reversal_of": "reversal_of_example",
"process_deferred_accounting": "process_deferred_accounting_example",
"is_system_generated": false,
"periodic_entry_difference_account": "periodic_entry_difference_account_example",
"for_all_stock_asset_accounts": true,
"stock_asset_account": "stock_asset_account_example",
"party_not_required": false,
"tax_withholding_group": "tax_withholding_group_example",
"ignore_tax_withholding_threshold": false,
"override_tax_withholding_entries": false
} PATCH
/api/accounts/journal-entry/{id} Update a journal entry
Updates the specified journal entry by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Path parameters
id string required
The identifier of the journal entry to update.
Body parameters
status string
Default: draft
title string
voucher_type string
Default: Journal Entry
posting_date string
company string
finance_book string
cheque_no string
cheque_date string
user_remark string
total_debit number
total_credit number
difference number
multi_currency boolean
Default: false
total_amount_currency string
total_amount number
total_amount_in_words string
clearance_date string
remark string
inter_company_journal_entry_reference string
bill_no string
bill_date string
due_date string
write_off_based_on string
Default: Accounts Receivable
write_off_amount number
pay_to_recd_from string
letter_head string
select_print_heading string
mode_of_payment string
payment_order string
is_opening string
Default: No
stock_entry string
auto_repeat string
from_template string
tax_withholding_category string
apply_tds boolean
Default: false
reversal_of string
process_deferred_accounting string
is_system_generated boolean
Default: false
periodic_entry_difference_account string
for_all_stock_asset_accounts boolean
Default: true
stock_asset_account string
party_not_required boolean
Default: false
tax_withholding_group string
ignore_tax_withholding_threshold boolean
Default: false
override_tax_withholding_entries boolean
Default: false
Returns
Returns the updated journal entry object.
PATCH /api/accounts/journal-entry/{id}
curl https://api.overplane.dev/api/accounts/journal-entry/journal-entry_abc123 \
-H "Authorization: Bearer sk_test_..." \
-X PATCH \
-H "Content-Type: application/json" \
-d '{"status":"draft","title":"title_example"}' Response
{
"id": "journal-entry_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"title": "title_example",
"voucher_type": "Journal Entry",
"posting_date": "2024-01-15",
"company": "Example Corp",
"finance_book": "finance_book_example",
"cheque_no": "cheque_no_example",
"cheque_date": "2024-01-15",
"user_remark": "user_remark_example",
"total_debit": 0,
"total_credit": 0,
"difference": 0,
"multi_currency": false,
"total_amount_currency": "USD",
"total_amount": 0,
"total_amount_in_words": "total_amount_in_words_example",
"clearance_date": "2024-01-15",
"remark": "remark_example",
"inter_company_journal_entry_reference": "Example Corp",
"bill_no": "bill_no_example",
"bill_date": "2024-01-15",
"due_date": "2024-01-15",
"write_off_based_on": "Accounts Receivable",
"write_off_amount": 0,
"pay_to_recd_from": "pay_to_recd_from_example",
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"mode_of_payment": "mode_of_payment_example",
"payment_order": "payment_order_example",
"is_opening": "No",
"stock_entry": "stock_entry_example",
"auto_repeat": "auto_repeat_example",
"from_template": "from_template_example",
"tax_withholding_category": "tax_withholding_category_example",
"apply_tds": false,
"reversal_of": "reversal_of_example",
"process_deferred_accounting": "process_deferred_accounting_example",
"is_system_generated": false,
"periodic_entry_difference_account": "periodic_entry_difference_account_example",
"for_all_stock_asset_accounts": true,
"stock_asset_account": "stock_asset_account_example",
"party_not_required": false,
"tax_withholding_group": "tax_withholding_group_example",
"ignore_tax_withholding_threshold": false,
"override_tax_withholding_entries": false
} DELETE
/api/accounts/journal-entry/{id} Delete a journal entry
Permanently deletes a journal entry. This cannot be undone.
Path parameters
id string required
The identifier of the journal entry to delete.
Returns
Returns a confirmation that the journal entry has been deleted.
DELETE /api/accounts/journal-entry/{id}
curl https://api.overplane.dev/api/accounts/journal-entry/journal-entry_abc123 \
-H "Authorization: Bearer sk_test_..." \
-X DELETE Response
{
"id": "journal-entry_abc123",
"deleted": true
} POST
/api/accounts/journal-entry/{id}/submit Submit a journal entry
Submits a draft journal entry, transitioning its status from draft to submitted.
Path parameters
id string required
The identifier of the journal entry to act on.
Returns
Returns the journal entry object with updated status.
POST /api/accounts/journal-entry/{id}/submit
curl https://api.overplane.dev/api/accounts/journal-entry/journal-entry_abc123/submit \
-H "Authorization: Bearer sk_test_..." \
-X POST Response
{
"id": "journal-entry_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"title": "title_example",
"voucher_type": "Journal Entry",
"posting_date": "2024-01-15",
"company": "Example Corp",
"finance_book": "finance_book_example",
"cheque_no": "cheque_no_example",
"cheque_date": "2024-01-15",
"user_remark": "user_remark_example",
"total_debit": 0,
"total_credit": 0,
"difference": 0,
"multi_currency": false,
"total_amount_currency": "USD",
"total_amount": 0,
"total_amount_in_words": "total_amount_in_words_example",
"clearance_date": "2024-01-15",
"remark": "remark_example",
"inter_company_journal_entry_reference": "Example Corp",
"bill_no": "bill_no_example",
"bill_date": "2024-01-15",
"due_date": "2024-01-15",
"write_off_based_on": "Accounts Receivable",
"write_off_amount": 0,
"pay_to_recd_from": "pay_to_recd_from_example",
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"mode_of_payment": "mode_of_payment_example",
"payment_order": "payment_order_example",
"is_opening": "No",
"stock_entry": "stock_entry_example",
"auto_repeat": "auto_repeat_example",
"from_template": "from_template_example",
"tax_withholding_category": "tax_withholding_category_example",
"apply_tds": false,
"reversal_of": "reversal_of_example",
"process_deferred_accounting": "process_deferred_accounting_example",
"is_system_generated": false,
"periodic_entry_difference_account": "periodic_entry_difference_account_example",
"for_all_stock_asset_accounts": true,
"stock_asset_account": "stock_asset_account_example",
"party_not_required": false,
"tax_withholding_group": "tax_withholding_group_example",
"ignore_tax_withholding_threshold": false,
"override_tax_withholding_entries": false
} POST
/api/accounts/journal-entry/{id}/cancel Cancel a journal entry
Cancels a submitted journal entry, transitioning its status to cancelled.
Path parameters
id string required
The identifier of the journal entry to act on.
Returns
Returns the journal entry object with updated status.
POST /api/accounts/journal-entry/{id}/cancel
curl https://api.overplane.dev/api/accounts/journal-entry/journal-entry_abc123/cancel \
-H "Authorization: Bearer sk_test_..." \
-X POST Response
{
"id": "journal-entry_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"title": "title_example",
"voucher_type": "Journal Entry",
"posting_date": "2024-01-15",
"company": "Example Corp",
"finance_book": "finance_book_example",
"cheque_no": "cheque_no_example",
"cheque_date": "2024-01-15",
"user_remark": "user_remark_example",
"total_debit": 0,
"total_credit": 0,
"difference": 0,
"multi_currency": false,
"total_amount_currency": "USD",
"total_amount": 0,
"total_amount_in_words": "total_amount_in_words_example",
"clearance_date": "2024-01-15",
"remark": "remark_example",
"inter_company_journal_entry_reference": "Example Corp",
"bill_no": "bill_no_example",
"bill_date": "2024-01-15",
"due_date": "2024-01-15",
"write_off_based_on": "Accounts Receivable",
"write_off_amount": 0,
"pay_to_recd_from": "pay_to_recd_from_example",
"letter_head": "letter_head_example",
"select_print_heading": "select_print_heading_example",
"mode_of_payment": "mode_of_payment_example",
"payment_order": "payment_order_example",
"is_opening": "No",
"stock_entry": "stock_entry_example",
"auto_repeat": "auto_repeat_example",
"from_template": "from_template_example",
"tax_withholding_category": "tax_withholding_category_example",
"apply_tds": false,
"reversal_of": "reversal_of_example",
"process_deferred_accounting": "process_deferred_accounting_example",
"is_system_generated": false,
"periodic_entry_difference_account": "periodic_entry_difference_account_example",
"for_all_stock_asset_accounts": true,
"stock_asset_account": "stock_asset_account_example",
"party_not_required": false,
"tax_withholding_group": "tax_withholding_group_example",
"ignore_tax_withholding_threshold": false,
"override_tax_withholding_entries": false
}Line items
Child objects that belong to this journal entry. These are accessed via the parent's ID.
Journal Entry Account
Attributes
idx integer
journal_entry_id string required
account string required
account_type string
cost_center string
party_type string
party string
account_currency string
exchange_rate number
debit_in_account_currency number
debit number
credit_in_account_currency number
credit number
reference_type string
reference_name string
reference_due_date string
project string
is_advance string
user_remark string
against_account string
bank_account string
reference_detail_no string
advance_voucher_type string
advance_voucher_no string
is_tax_withholding_account boolean
Endpoints
GET
/api/accounts/journal-entry-account?parent_id={id} POST
/api/accounts/journal-entry-account PATCH
/api/accounts/journal-entry-account/{id} DELETE
/api/accounts/journal-entry-account/{id} POST
/api/accounts/journal-entry-account/reorder Journal Entry Account object
{
"id": "journal-entry-account_abc123",
"idx": 1,
"journal_entry_id": "journal_entry_id_example",
"account": "account_example",
"account_type": "account_type_example",
"cost_center": "cost_center_example",
"party_type": "party_type_example",
"party": "party_example",
"account_currency": "USD",
"exchange_rate": 0,
"debit_in_account_currency": 0,
"debit": 0,
"credit_in_account_currency": 0,
"credit": 0,
"reference_type": "reference_type_example",
"reference_name": "reference_name_example",
"reference_due_date": "2024-01-15",
"project": "project_example",
"is_advance": "is_advance_example",
"user_remark": "user_remark_example",
"against_account": "against_account_example",
"bank_account": "bank_account_example",
"reference_detail_no": "reference_detail_no_example",
"advance_voucher_type": "advance_voucher_type_example",
"advance_voucher_no": "advance_voucher_no_example",
"is_tax_withholding_account": false
}