The Payment 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

payment_type string required
posting_date string required
company string required
cost_center string
mode_of_payment string
party_type string
party string
party_name string
contact_person string
contact_email string
paid_from string required
paid_from_account_currency string required
paid_to string required
paid_to_account_currency string required
paid_amount number required
source_exchange_rate number required
base_paid_amount number required
received_amount number required
target_exchange_rate number required
base_received_amount number required
total_allocated_amount number
base_total_allocated_amount number
unallocated_amount number
difference_amount number
reference_no string
reference_date string
clearance_date string
project string
remarks string
letter_head string
print_heading string
bank string
bank_account_no string
payment_order string
auto_repeat string
title string
bank_account string
party_bank_account string
payment_order_status string
custom_remarks boolean

Default: false

tax_withholding_category string
purchase_taxes_and_charges_template string
sales_taxes_and_charges_template string
base_total_taxes_and_charges number
total_taxes_and_charges number
paid_amount_after_tax number
base_paid_amount_after_tax number
received_amount_after_tax number
base_received_amount_after_tax number
paid_from_account_type string
paid_to_account_type string
book_advance_payments_in_separate_party_account boolean

Default: false

base_in_words string
in_words string
reconcile_on_advance_payment_date boolean

Default: false

is_opening string

Default: No

apply_tds boolean

Default: false

tax_withholding_group string
ignore_tax_withholding_threshold boolean

Default: false

override_tax_withholding_entries boolean

Default: false

The Payment Entry object 
{
  "id": "payment-entry_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "payment_type": "payment_type_example",
  "posting_date": "2024-01-15",
  "company": "Example Corp",
  "cost_center": "cost_center_example",
  "mode_of_payment": "mode_of_payment_example",
  "party_type": "party_type_example",
  "party": "party_example",
  "party_name": "party_name_example",
  "contact_person": "contact_person_example",
  "contact_email": "user@example.com",
  "paid_from": "paid_from_example",
  "paid_from_account_currency": "USD",
  "paid_to": "paid_to_example",
  "paid_to_account_currency": "USD",
  "paid_amount": 0,
  "source_exchange_rate": 0,
  "base_paid_amount": 0,
  "received_amount": 0,
  "target_exchange_rate": 0,
  "base_received_amount": 0,
  "total_allocated_amount": 0,
  "base_total_allocated_amount": 0,
  "unallocated_amount": 0,
  "difference_amount": 0,
  "reference_no": "reference_no_example",
  "reference_date": "2024-01-15",
  "clearance_date": "2024-01-15",
  "project": "project_example",
  "remarks": "remarks_example",
  "letter_head": "letter_head_example",
  "print_heading": "print_heading_example",
  "bank": "bank_example",
  "bank_account_no": "bank_account_no_example",
  "payment_order": "payment_order_example",
  "auto_repeat": "auto_repeat_example",
  "title": "title_example",
  "bank_account": "bank_account_example",
  "party_bank_account": "party_bank_account_example",
  "payment_order_status": "payment_order_status_example",
  "custom_remarks": false,
  "tax_withholding_category": "tax_withholding_category_example",
  "purchase_taxes_and_charges_template": "purchase_taxes_and_charges_template_example",
  "sales_taxes_and_charges_template": "sales_taxes_and_charges_template_example",
  "base_total_taxes_and_charges": 0,
  "total_taxes_and_charges": 0,
  "paid_amount_after_tax": 0,
  "base_paid_amount_after_tax": 0,
  "received_amount_after_tax": 0,
  "base_received_amount_after_tax": 0,
  "paid_from_account_type": "paid_from_account_type_example",
  "paid_to_account_type": "paid_to_account_type_example",
  "book_advance_payments_in_separate_party_account": false,
  "base_in_words": "base_in_words_example",
  "in_words": "in_words_example",
  "reconcile_on_advance_payment_date": false,
  "is_opening": "No",
  "apply_tds": false,
  "tax_withholding_group": "tax_withholding_group_example",
  "ignore_tax_withholding_threshold": false,
  "override_tax_withholding_entries": false
}
GET /api/accounts/payment-entry/{id}

Retrieve a payment entry

Retrieves the details of an existing payment entry. Supply the unique payment entry ID that was returned from a previous request.

Path parameters

id string required

The identifier of the payment entry to retrieve.

Returns

Returns the payment entry object if a valid identifier was provided.

GET /api/accounts/payment-entry/{id} 
curl https://api.overplane.dev/api/accounts/payment-entry/payment-entry_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "payment-entry_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "payment_type": "payment_type_example",
  "posting_date": "2024-01-15",
  "company": "Example Corp",
  "cost_center": "cost_center_example",
  "mode_of_payment": "mode_of_payment_example",
  "party_type": "party_type_example",
  "party": "party_example",
  "party_name": "party_name_example",
  "contact_person": "contact_person_example",
  "contact_email": "user@example.com",
  "paid_from": "paid_from_example",
  "paid_from_account_currency": "USD",
  "paid_to": "paid_to_example",
  "paid_to_account_currency": "USD",
  "paid_amount": 0,
  "source_exchange_rate": 0,
  "base_paid_amount": 0,
  "received_amount": 0,
  "target_exchange_rate": 0,
  "base_received_amount": 0,
  "total_allocated_amount": 0,
  "base_total_allocated_amount": 0,
  "unallocated_amount": 0,
  "difference_amount": 0,
  "reference_no": "reference_no_example",
  "reference_date": "2024-01-15",
  "clearance_date": "2024-01-15",
  "project": "project_example",
  "remarks": "remarks_example",
  "letter_head": "letter_head_example",
  "print_heading": "print_heading_example",
  "bank": "bank_example",
  "bank_account_no": "bank_account_no_example",
  "payment_order": "payment_order_example",
  "auto_repeat": "auto_repeat_example",
  "title": "title_example",
  "bank_account": "bank_account_example",
  "party_bank_account": "party_bank_account_example",
  "payment_order_status": "payment_order_status_example",
  "custom_remarks": false,
  "tax_withholding_category": "tax_withholding_category_example",
  "purchase_taxes_and_charges_template": "purchase_taxes_and_charges_template_example",
  "sales_taxes_and_charges_template": "sales_taxes_and_charges_template_example",
  "base_total_taxes_and_charges": 0,
  "total_taxes_and_charges": 0,
  "paid_amount_after_tax": 0,
  "base_paid_amount_after_tax": 0,
  "received_amount_after_tax": 0,
  "base_received_amount_after_tax": 0,
  "paid_from_account_type": "paid_from_account_type_example",
  "paid_to_account_type": "paid_to_account_type_example",
  "book_advance_payments_in_separate_party_account": false,
  "base_in_words": "base_in_words_example",
  "in_words": "in_words_example",
  "reconcile_on_advance_payment_date": false,
  "is_opening": "No",
  "apply_tds": false,
  "tax_withholding_group": "tax_withholding_group_example",
  "ignore_tax_withholding_threshold": false,
  "override_tax_withholding_entries": false
}
GET /api/accounts/payment-entry

List all payment entrys

Returns a list of payment 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 payment entry objects.

GET /api/accounts/payment-entry 
curl https://api.overplane.dev/api/accounts/payment-entry \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "payment-entry_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "payment_type": "payment_type_example",
      "posting_date": "2024-01-15",
      "company": "Example Corp",
      "cost_center": "cost_center_example",
      "mode_of_payment": "mode_of_payment_example",
      "party_type": "party_type_example",
      "party": "party_example",
      "party_name": "party_name_example",
      "contact_person": "contact_person_example",
      "contact_email": "user@example.com",
      "paid_from": "paid_from_example",
      "paid_from_account_currency": "USD",
      "paid_to": "paid_to_example",
      "paid_to_account_currency": "USD",
      "paid_amount": 0,
      "source_exchange_rate": 0,
      "base_paid_amount": 0,
      "received_amount": 0,
      "target_exchange_rate": 0,
      "base_received_amount": 0,
      "total_allocated_amount": 0,
      "base_total_allocated_amount": 0,
      "unallocated_amount": 0,
      "difference_amount": 0,
      "reference_no": "reference_no_example",
      "reference_date": "2024-01-15",
      "clearance_date": "2024-01-15",
      "project": "project_example",
      "remarks": "remarks_example",
      "letter_head": "letter_head_example",
      "print_heading": "print_heading_example",
      "bank": "bank_example",
      "bank_account_no": "bank_account_no_example",
      "payment_order": "payment_order_example",
      "auto_repeat": "auto_repeat_example",
      "title": "title_example",
      "bank_account": "bank_account_example",
      "party_bank_account": "party_bank_account_example",
      "payment_order_status": "payment_order_status_example",
      "custom_remarks": false,
      "tax_withholding_category": "tax_withholding_category_example",
      "purchase_taxes_and_charges_template": "purchase_taxes_and_charges_template_example",
      "sales_taxes_and_charges_template": "sales_taxes_and_charges_template_example",
      "base_total_taxes_and_charges": 0,
      "total_taxes_and_charges": 0,
      "paid_amount_after_tax": 0,
      "base_paid_amount_after_tax": 0,
      "received_amount_after_tax": 0,
      "base_received_amount_after_tax": 0,
      "paid_from_account_type": "paid_from_account_type_example",
      "paid_to_account_type": "paid_to_account_type_example",
      "book_advance_payments_in_separate_party_account": false,
      "base_in_words": "base_in_words_example",
      "in_words": "in_words_example",
      "reconcile_on_advance_payment_date": false,
      "is_opening": "No",
      "apply_tds": 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/payment-entry

Create a payment entry

Creates a new payment entry object.

Body parameters

status string

Default: draft

payment_type string required
posting_date string required
company string required
cost_center string
mode_of_payment string
party_type string
party string
party_name string
contact_person string
contact_email string
paid_from string required
paid_from_account_currency string required
paid_to string required
paid_to_account_currency string required
paid_amount number required
source_exchange_rate number required
base_paid_amount number required
received_amount number required
target_exchange_rate number required
base_received_amount number required
total_allocated_amount number
base_total_allocated_amount number
unallocated_amount number
difference_amount number
reference_no string
reference_date string
clearance_date string
project string
remarks string
letter_head string
print_heading string
bank string
bank_account_no string
payment_order string
auto_repeat string
title string
bank_account string
party_bank_account string
payment_order_status string
custom_remarks boolean

Default: false

tax_withholding_category string
purchase_taxes_and_charges_template string
sales_taxes_and_charges_template string
base_total_taxes_and_charges number
total_taxes_and_charges number
paid_amount_after_tax number
base_paid_amount_after_tax number
received_amount_after_tax number
base_received_amount_after_tax number
paid_from_account_type string
paid_to_account_type string
book_advance_payments_in_separate_party_account boolean

Default: false

base_in_words string
in_words string
reconcile_on_advance_payment_date boolean

Default: false

is_opening string

Default: No

apply_tds 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 payment entry object if the call succeeded.

POST /api/accounts/payment-entry 
curl https://api.overplane.dev/api/accounts/payment-entry \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"payment_type":"payment_type_example","posting_date":"2024-01-15","company":"Example Corp","paid_from":"paid_from_example","paid_from_account_currency":"USD","paid_to":"paid_to_example","paid_to_account_currency":"USD","paid_amount":0,"source_exchange_rate":0,"base_paid_amount":0,"received_amount":0,"target_exchange_rate":0,"base_received_amount":0}'
Response 
{
  "id": "payment-entry_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "payment_type": "payment_type_example",
  "posting_date": "2024-01-15",
  "company": "Example Corp",
  "cost_center": "cost_center_example",
  "mode_of_payment": "mode_of_payment_example",
  "party_type": "party_type_example",
  "party": "party_example",
  "party_name": "party_name_example",
  "contact_person": "contact_person_example",
  "contact_email": "user@example.com",
  "paid_from": "paid_from_example",
  "paid_from_account_currency": "USD",
  "paid_to": "paid_to_example",
  "paid_to_account_currency": "USD",
  "paid_amount": 0,
  "source_exchange_rate": 0,
  "base_paid_amount": 0,
  "received_amount": 0,
  "target_exchange_rate": 0,
  "base_received_amount": 0,
  "total_allocated_amount": 0,
  "base_total_allocated_amount": 0,
  "unallocated_amount": 0,
  "difference_amount": 0,
  "reference_no": "reference_no_example",
  "reference_date": "2024-01-15",
  "clearance_date": "2024-01-15",
  "project": "project_example",
  "remarks": "remarks_example",
  "letter_head": "letter_head_example",
  "print_heading": "print_heading_example",
  "bank": "bank_example",
  "bank_account_no": "bank_account_no_example",
  "payment_order": "payment_order_example",
  "auto_repeat": "auto_repeat_example",
  "title": "title_example",
  "bank_account": "bank_account_example",
  "party_bank_account": "party_bank_account_example",
  "payment_order_status": "payment_order_status_example",
  "custom_remarks": false,
  "tax_withholding_category": "tax_withholding_category_example",
  "purchase_taxes_and_charges_template": "purchase_taxes_and_charges_template_example",
  "sales_taxes_and_charges_template": "sales_taxes_and_charges_template_example",
  "base_total_taxes_and_charges": 0,
  "total_taxes_and_charges": 0,
  "paid_amount_after_tax": 0,
  "base_paid_amount_after_tax": 0,
  "received_amount_after_tax": 0,
  "base_received_amount_after_tax": 0,
  "paid_from_account_type": "paid_from_account_type_example",
  "paid_to_account_type": "paid_to_account_type_example",
  "book_advance_payments_in_separate_party_account": false,
  "base_in_words": "base_in_words_example",
  "in_words": "in_words_example",
  "reconcile_on_advance_payment_date": false,
  "is_opening": "No",
  "apply_tds": false,
  "tax_withholding_group": "tax_withholding_group_example",
  "ignore_tax_withholding_threshold": false,
  "override_tax_withholding_entries": false
}
PATCH /api/accounts/payment-entry/{id}

Update a payment entry

Updates the specified payment 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 payment entry to update.

Body parameters

status string

Default: draft

payment_type string
posting_date string
company string
cost_center string
mode_of_payment string
party_type string
party string
party_name string
contact_person string
contact_email string
paid_from string
paid_from_account_currency string
paid_to string
paid_to_account_currency string
paid_amount number
source_exchange_rate number
base_paid_amount number
received_amount number
target_exchange_rate number
base_received_amount number
total_allocated_amount number
base_total_allocated_amount number
unallocated_amount number
difference_amount number
reference_no string
reference_date string
clearance_date string
project string
remarks string
letter_head string
print_heading string
bank string
bank_account_no string
payment_order string
auto_repeat string
title string
bank_account string
party_bank_account string
payment_order_status string
custom_remarks boolean

Default: false

tax_withholding_category string
purchase_taxes_and_charges_template string
sales_taxes_and_charges_template string
base_total_taxes_and_charges number
total_taxes_and_charges number
paid_amount_after_tax number
base_paid_amount_after_tax number
received_amount_after_tax number
base_received_amount_after_tax number
paid_from_account_type string
paid_to_account_type string
book_advance_payments_in_separate_party_account boolean

Default: false

base_in_words string
in_words string
reconcile_on_advance_payment_date boolean

Default: false

is_opening string

Default: No

apply_tds 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 payment entry object.

PATCH /api/accounts/payment-entry/{id} 
curl https://api.overplane.dev/api/accounts/payment-entry/payment-entry_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","payment_type":"payment_type_example"}'
Response 
{
  "id": "payment-entry_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "payment_type": "payment_type_example",
  "posting_date": "2024-01-15",
  "company": "Example Corp",
  "cost_center": "cost_center_example",
  "mode_of_payment": "mode_of_payment_example",
  "party_type": "party_type_example",
  "party": "party_example",
  "party_name": "party_name_example",
  "contact_person": "contact_person_example",
  "contact_email": "user@example.com",
  "paid_from": "paid_from_example",
  "paid_from_account_currency": "USD",
  "paid_to": "paid_to_example",
  "paid_to_account_currency": "USD",
  "paid_amount": 0,
  "source_exchange_rate": 0,
  "base_paid_amount": 0,
  "received_amount": 0,
  "target_exchange_rate": 0,
  "base_received_amount": 0,
  "total_allocated_amount": 0,
  "base_total_allocated_amount": 0,
  "unallocated_amount": 0,
  "difference_amount": 0,
  "reference_no": "reference_no_example",
  "reference_date": "2024-01-15",
  "clearance_date": "2024-01-15",
  "project": "project_example",
  "remarks": "remarks_example",
  "letter_head": "letter_head_example",
  "print_heading": "print_heading_example",
  "bank": "bank_example",
  "bank_account_no": "bank_account_no_example",
  "payment_order": "payment_order_example",
  "auto_repeat": "auto_repeat_example",
  "title": "title_example",
  "bank_account": "bank_account_example",
  "party_bank_account": "party_bank_account_example",
  "payment_order_status": "payment_order_status_example",
  "custom_remarks": false,
  "tax_withholding_category": "tax_withholding_category_example",
  "purchase_taxes_and_charges_template": "purchase_taxes_and_charges_template_example",
  "sales_taxes_and_charges_template": "sales_taxes_and_charges_template_example",
  "base_total_taxes_and_charges": 0,
  "total_taxes_and_charges": 0,
  "paid_amount_after_tax": 0,
  "base_paid_amount_after_tax": 0,
  "received_amount_after_tax": 0,
  "base_received_amount_after_tax": 0,
  "paid_from_account_type": "paid_from_account_type_example",
  "paid_to_account_type": "paid_to_account_type_example",
  "book_advance_payments_in_separate_party_account": false,
  "base_in_words": "base_in_words_example",
  "in_words": "in_words_example",
  "reconcile_on_advance_payment_date": false,
  "is_opening": "No",
  "apply_tds": false,
  "tax_withholding_group": "tax_withholding_group_example",
  "ignore_tax_withholding_threshold": false,
  "override_tax_withholding_entries": false
}
DELETE /api/accounts/payment-entry/{id}

Delete a payment entry

Permanently deletes a payment entry. This cannot be undone.

Path parameters

id string required

The identifier of the payment entry to delete.

Returns

Returns a confirmation that the payment entry has been deleted.

DELETE /api/accounts/payment-entry/{id} 
curl https://api.overplane.dev/api/accounts/payment-entry/payment-entry_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "payment-entry_abc123",
  "deleted": true
}
POST /api/accounts/payment-entry/{id}/submit

Submit a payment entry

Submits a draft payment entry, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the payment entry to act on.

Returns

Returns the payment entry object with updated status.

POST /api/accounts/payment-entry/{id}/submit 
curl https://api.overplane.dev/api/accounts/payment-entry/payment-entry_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "payment-entry_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "payment_type": "payment_type_example",
  "posting_date": "2024-01-15",
  "company": "Example Corp",
  "cost_center": "cost_center_example",
  "mode_of_payment": "mode_of_payment_example",
  "party_type": "party_type_example",
  "party": "party_example",
  "party_name": "party_name_example",
  "contact_person": "contact_person_example",
  "contact_email": "user@example.com",
  "paid_from": "paid_from_example",
  "paid_from_account_currency": "USD",
  "paid_to": "paid_to_example",
  "paid_to_account_currency": "USD",
  "paid_amount": 0,
  "source_exchange_rate": 0,
  "base_paid_amount": 0,
  "received_amount": 0,
  "target_exchange_rate": 0,
  "base_received_amount": 0,
  "total_allocated_amount": 0,
  "base_total_allocated_amount": 0,
  "unallocated_amount": 0,
  "difference_amount": 0,
  "reference_no": "reference_no_example",
  "reference_date": "2024-01-15",
  "clearance_date": "2024-01-15",
  "project": "project_example",
  "remarks": "remarks_example",
  "letter_head": "letter_head_example",
  "print_heading": "print_heading_example",
  "bank": "bank_example",
  "bank_account_no": "bank_account_no_example",
  "payment_order": "payment_order_example",
  "auto_repeat": "auto_repeat_example",
  "title": "title_example",
  "bank_account": "bank_account_example",
  "party_bank_account": "party_bank_account_example",
  "payment_order_status": "payment_order_status_example",
  "custom_remarks": false,
  "tax_withholding_category": "tax_withholding_category_example",
  "purchase_taxes_and_charges_template": "purchase_taxes_and_charges_template_example",
  "sales_taxes_and_charges_template": "sales_taxes_and_charges_template_example",
  "base_total_taxes_and_charges": 0,
  "total_taxes_and_charges": 0,
  "paid_amount_after_tax": 0,
  "base_paid_amount_after_tax": 0,
  "received_amount_after_tax": 0,
  "base_received_amount_after_tax": 0,
  "paid_from_account_type": "paid_from_account_type_example",
  "paid_to_account_type": "paid_to_account_type_example",
  "book_advance_payments_in_separate_party_account": false,
  "base_in_words": "base_in_words_example",
  "in_words": "in_words_example",
  "reconcile_on_advance_payment_date": false,
  "is_opening": "No",
  "apply_tds": false,
  "tax_withholding_group": "tax_withholding_group_example",
  "ignore_tax_withholding_threshold": false,
  "override_tax_withholding_entries": false
}
POST /api/accounts/payment-entry/{id}/cancel

Cancel a payment entry

Cancels a submitted payment entry, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the payment entry to act on.

Returns

Returns the payment entry object with updated status.

POST /api/accounts/payment-entry/{id}/cancel 
curl https://api.overplane.dev/api/accounts/payment-entry/payment-entry_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "payment-entry_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "payment_type": "payment_type_example",
  "posting_date": "2024-01-15",
  "company": "Example Corp",
  "cost_center": "cost_center_example",
  "mode_of_payment": "mode_of_payment_example",
  "party_type": "party_type_example",
  "party": "party_example",
  "party_name": "party_name_example",
  "contact_person": "contact_person_example",
  "contact_email": "user@example.com",
  "paid_from": "paid_from_example",
  "paid_from_account_currency": "USD",
  "paid_to": "paid_to_example",
  "paid_to_account_currency": "USD",
  "paid_amount": 0,
  "source_exchange_rate": 0,
  "base_paid_amount": 0,
  "received_amount": 0,
  "target_exchange_rate": 0,
  "base_received_amount": 0,
  "total_allocated_amount": 0,
  "base_total_allocated_amount": 0,
  "unallocated_amount": 0,
  "difference_amount": 0,
  "reference_no": "reference_no_example",
  "reference_date": "2024-01-15",
  "clearance_date": "2024-01-15",
  "project": "project_example",
  "remarks": "remarks_example",
  "letter_head": "letter_head_example",
  "print_heading": "print_heading_example",
  "bank": "bank_example",
  "bank_account_no": "bank_account_no_example",
  "payment_order": "payment_order_example",
  "auto_repeat": "auto_repeat_example",
  "title": "title_example",
  "bank_account": "bank_account_example",
  "party_bank_account": "party_bank_account_example",
  "payment_order_status": "payment_order_status_example",
  "custom_remarks": false,
  "tax_withholding_category": "tax_withholding_category_example",
  "purchase_taxes_and_charges_template": "purchase_taxes_and_charges_template_example",
  "sales_taxes_and_charges_template": "sales_taxes_and_charges_template_example",
  "base_total_taxes_and_charges": 0,
  "total_taxes_and_charges": 0,
  "paid_amount_after_tax": 0,
  "base_paid_amount_after_tax": 0,
  "received_amount_after_tax": 0,
  "base_received_amount_after_tax": 0,
  "paid_from_account_type": "paid_from_account_type_example",
  "paid_to_account_type": "paid_to_account_type_example",
  "book_advance_payments_in_separate_party_account": false,
  "base_in_words": "base_in_words_example",
  "in_words": "in_words_example",
  "reconcile_on_advance_payment_date": false,
  "is_opening": "No",
  "apply_tds": 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 payment entry. These are accessed via the parent's ID.

Advance Taxes And Charges

Attributes

idx integer
payment_entry_id string required
charge_type string required
row_id string
account_head string required
description string required
cost_center string
project string
rate number
tax_amount number
total number
base_tax_amount number
base_total number
add_deduct_tax string required
included_in_paid_amount boolean
currency string
net_amount number
base_net_amount number
set_by_item_tax_template boolean
is_tax_withholding_account boolean

Endpoints

GET /api/accounts/advance-taxes-and-charges?parent_id={id}
POST /api/accounts/advance-taxes-and-charges
PATCH /api/accounts/advance-taxes-and-charges/{id}
DELETE /api/accounts/advance-taxes-and-charges/{id}
POST /api/accounts/advance-taxes-and-charges/reorder
Advance Taxes And Charges object 
{
  "id": "advance-taxes-and-charges_abc123",
  "idx": 1,
  "payment_entry_id": "payment_entry_id_example",
  "charge_type": "charge_type_example",
  "row_id": "row_id_example",
  "account_head": "account_head_example",
  "description": "description_example",
  "cost_center": "cost_center_example",
  "project": "project_example",
  "rate": 0,
  "tax_amount": 0,
  "total": 0,
  "base_tax_amount": 0,
  "base_total": 0,
  "add_deduct_tax": "add_deduct_tax_example",
  "included_in_paid_amount": false,
  "currency": "USD",
  "net_amount": 0,
  "base_net_amount": 0,
  "set_by_item_tax_template": false,
  "is_tax_withholding_account": false
}

Payment Entry Deduction

Attributes

idx integer
payment_entry_id string required
account string required
cost_center string required
amount number required
description string
is_exchange_gain_loss boolean

Endpoints

GET /api/accounts/payment-entry-deduction?parent_id={id}
POST /api/accounts/payment-entry-deduction
PATCH /api/accounts/payment-entry-deduction/{id}
DELETE /api/accounts/payment-entry-deduction/{id}
POST /api/accounts/payment-entry-deduction/reorder
Payment Entry Deduction object 
{
  "id": "payment-entry-deduction_abc123",
  "idx": 1,
  "payment_entry_id": "payment_entry_id_example",
  "account": "account_example",
  "cost_center": "cost_center_example",
  "amount": 0,
  "description": "description_example",
  "is_exchange_gain_loss": false
}

Payment Entry Reference

Attributes

idx integer
payment_entry_id string required
reference_doctype string required
reference_name string required
due_date string
bill_no string
total_amount number
outstanding_amount number
allocated_amount number
exchange_rate number
payment_term string
exchange_gain_loss number
account string
account_type string
payment_type string
payment_request string
payment_term_outstanding number
reconcile_effect_on string
advance_voucher_type string
advance_voucher_no string

Endpoints

GET /api/accounts/payment-entry-reference?parent_id={id}
POST /api/accounts/payment-entry-reference
PATCH /api/accounts/payment-entry-reference/{id}
DELETE /api/accounts/payment-entry-reference/{id}
POST /api/accounts/payment-entry-reference/reorder
Payment Entry Reference object 
{
  "id": "payment-entry-reference_abc123",
  "idx": 1,
  "payment_entry_id": "payment_entry_id_example",
  "reference_doctype": "reference_doctype_example",
  "reference_name": "reference_name_example",
  "due_date": "2024-01-15",
  "bill_no": "bill_no_example",
  "total_amount": 0,
  "outstanding_amount": 0,
  "allocated_amount": 0,
  "exchange_rate": 0,
  "payment_term": "payment_term_example",
  "exchange_gain_loss": 0,
  "account": "account_example",
  "account_type": "account_type_example",
  "payment_type": "payment_type_example",
  "payment_request": "payment_request_example",
  "payment_term_outstanding": 0,
  "reconcile_effect_on": "reconcile_effect_on_example",
  "advance_voucher_type": "advance_voucher_type_example",
  "advance_voucher_no": "advance_voucher_no_example"
}