The Purchase Invoice 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
supplier string required
supplier_name string
tax_id string
due_date string
is_paid boolean

Default: false

is_return boolean

Default: false

apply_tds boolean

Default: false

company string
cost_center string
posting_date string required
posting_time string
set_posting_time boolean

Default: false

on_hold boolean

Default: false

release_date string
hold_comment string
bill_no string
bill_date string
return_against string
update_billed_amount_in_purchase_order boolean

Default: false

update_billed_amount_in_purchase_receipt boolean

Default: true

supplier_address string
address_display string
contact_person string
contact_display string
contact_mobile string
contact_email string
shipping_address string
shipping_address_display string
currency string
conversion_rate number
buying_price_list string
price_list_currency string
plc_conversion_rate number
ignore_pricing_rule boolean

Default: false

set_warehouse string
rejected_warehouse string
is_subcontracted boolean

Default: false

update_stock boolean

Default: false

scan_barcode string
total_qty number
base_total number
base_net_total number
total number
net_total number
total_net_weight number
tax_category string
shipping_rule string
taxes_and_charges string
other_charges_calculation string
base_taxes_and_charges_added number
base_taxes_and_charges_deducted number
base_total_taxes_and_charges number
taxes_and_charges_added number
taxes_and_charges_deducted number
total_taxes_and_charges number
apply_discount_on string

Default: Grand Total

base_discount_amount number
additional_discount_percentage number
discount_amount number
base_grand_total number
base_rounding_adjustment number
base_rounded_total number
base_in_words string
grand_total number
rounding_adjustment number
rounded_total number
in_words string
total_advance number
outstanding_amount number
disable_rounded_total boolean

Default: false

mode_of_payment string
cash_bank_account string
clearance_date string
paid_amount number
base_paid_amount number
write_off_amount number
base_write_off_amount number
write_off_account string
write_off_cost_center string
allocate_advances_automatically boolean

Default: false

payment_terms_template string
tc_name string
terms string
letter_head string
group_same_items boolean

Default: false

select_print_heading string
language string
is_internal_supplier boolean

Default: false

credit_to string required
party_account_currency string
is_opening string

Default: No

against_expense_account string
inter_company_invoice_reference string
remarks string
from_date string
to_date string
auto_repeat string
billing_address string
billing_address_display string
project string
unrealized_profit_loss_account string
represents_company string
set_from_warehouse string
supplier_warehouse string
per_received number
ignore_default_payment_terms_template boolean

Default: false

subscription string
is_old_subcontracting_flow boolean

Default: false

incoterm string
named_place string
only_include_allocated_payments boolean

Default: false

use_company_roundoff_cost_center boolean

Default: false

use_transaction_date_exchange_rate boolean

Default: false

supplier_group string
update_outstanding_for_self boolean

Default: true

sender string
dispatch_address_display string
dispatch_address string
claimed_landed_cost_amount number
tax_withholding_group string
ignore_tax_withholding_threshold boolean

Default: false

override_tax_withholding_entries boolean

Default: false

signing_document_id string
The Purchase Invoice object
{
  "id": "purchase-invoice_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "title_example",
  "supplier": "supplier_example",
  "supplier_name": "supplier_name_example",
  "tax_id": "tax_id_example",
  "due_date": "2024-01-15",
  "is_paid": false,
  "is_return": false,
  "apply_tds": false,
  "company": "Example Corp",
  "cost_center": "cost_center_example",
  "posting_date": "2024-01-15",
  "posting_time": "posting_time_example",
  "set_posting_time": false,
  "on_hold": false,
  "release_date": "2024-01-15",
  "hold_comment": "hold_comment_example",
  "bill_no": "bill_no_example",
  "bill_date": "2024-01-15",
  "return_against": "return_against_example",
  "update_billed_amount_in_purchase_order": false,
  "update_billed_amount_in_purchase_receipt": true,
  "supplier_address": "supplier_address_example",
  "address_display": "address_display_example",
  "contact_person": "contact_person_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "shipping_address": "shipping_address_example",
  "shipping_address_display": "shipping_address_display_example",
  "currency": "USD",
  "conversion_rate": 0,
  "buying_price_list": "buying_price_list_example",
  "price_list_currency": "USD",
  "plc_conversion_rate": 0,
  "ignore_pricing_rule": false,
  "set_warehouse": "set_warehouse_example",
  "rejected_warehouse": "rejected_warehouse_example",
  "is_subcontracted": false,
  "update_stock": false,
  "scan_barcode": "scan_barcode_example",
  "total_qty": 0,
  "base_total": 0,
  "base_net_total": 0,
  "total": 0,
  "net_total": 0,
  "total_net_weight": 0,
  "tax_category": "tax_category_example",
  "shipping_rule": "shipping_rule_example",
  "taxes_and_charges": "taxes_and_charges_example",
  "other_charges_calculation": "other_charges_calculation_example",
  "base_taxes_and_charges_added": 0,
  "base_taxes_and_charges_deducted": 0,
  "base_total_taxes_and_charges": 0,
  "taxes_and_charges_added": 0,
  "taxes_and_charges_deducted": 0,
  "total_taxes_and_charges": 0,
  "apply_discount_on": "Grand Total",
  "base_discount_amount": 0,
  "additional_discount_percentage": 0,
  "discount_amount": 0,
  "base_grand_total": 0,
  "base_rounding_adjustment": 0,
  "base_rounded_total": 0,
  "base_in_words": "base_in_words_example",
  "grand_total": 0,
  "rounding_adjustment": 0,
  "rounded_total": 0,
  "in_words": "in_words_example",
  "total_advance": 0,
  "outstanding_amount": 0,
  "disable_rounded_total": false,
  "mode_of_payment": "mode_of_payment_example",
  "cash_bank_account": "cash_bank_account_example",
  "clearance_date": "2024-01-15",
  "paid_amount": 0,
  "base_paid_amount": 0,
  "write_off_amount": 0,
  "base_write_off_amount": 0,
  "write_off_account": "write_off_account_example",
  "write_off_cost_center": "write_off_cost_center_example",
  "allocate_advances_automatically": false,
  "payment_terms_template": "payment_terms_template_example",
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "letter_head": "letter_head_example",
  "group_same_items": false,
  "select_print_heading": "select_print_heading_example",
  "language": "language_example",
  "is_internal_supplier": false,
  "credit_to": "credit_to_example",
  "party_account_currency": "USD",
  "is_opening": "No",
  "against_expense_account": "against_expense_account_example",
  "inter_company_invoice_reference": "Example Corp",
  "remarks": "remarks_example",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "auto_repeat": "auto_repeat_example",
  "billing_address": "billing_address_example",
  "billing_address_display": "billing_address_display_example",
  "project": "project_example",
  "unrealized_profit_loss_account": "unrealized_profit_loss_account_example",
  "represents_company": "Example Corp",
  "set_from_warehouse": "set_from_warehouse_example",
  "supplier_warehouse": "supplier_warehouse_example",
  "per_received": 0,
  "ignore_default_payment_terms_template": false,
  "subscription": "subscription_example",
  "is_old_subcontracting_flow": false,
  "incoterm": "incoterm_example",
  "named_place": "named_place_example",
  "only_include_allocated_payments": false,
  "use_company_roundoff_cost_center": false,
  "use_transaction_date_exchange_rate": false,
  "supplier_group": "supplier_group_example",
  "update_outstanding_for_self": true,
  "sender": "sender_example",
  "dispatch_address_display": "dispatch_address_display_example",
  "dispatch_address": "dispatch_address_example",
  "claimed_landed_cost_amount": 0,
  "tax_withholding_group": "tax_withholding_group_example",
  "ignore_tax_withholding_threshold": false,
  "override_tax_withholding_entries": false,
  "signing_document_id": "signing_document_id_example"
}
GET /api/accounts/purchase-invoice/{id}

Retrieve a purchase invoice

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

Path parameters

id string required

The identifier of the purchase invoice to retrieve.

Returns

Returns the purchase invoice object if a valid identifier was provided.

GET /api/accounts/purchase-invoice/{id}
curl https://api.overplane.dev/api/accounts/purchase-invoice/purchase-invoice_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response
{
  "id": "purchase-invoice_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "title_example",
  "supplier": "supplier_example",
  "supplier_name": "supplier_name_example",
  "tax_id": "tax_id_example",
  "due_date": "2024-01-15",
  "is_paid": false,
  "is_return": false,
  "apply_tds": false,
  "company": "Example Corp",
  "cost_center": "cost_center_example",
  "posting_date": "2024-01-15",
  "posting_time": "posting_time_example",
  "set_posting_time": false,
  "on_hold": false,
  "release_date": "2024-01-15",
  "hold_comment": "hold_comment_example",
  "bill_no": "bill_no_example",
  "bill_date": "2024-01-15",
  "return_against": "return_against_example",
  "update_billed_amount_in_purchase_order": false,
  "update_billed_amount_in_purchase_receipt": true,
  "supplier_address": "supplier_address_example",
  "address_display": "address_display_example",
  "contact_person": "contact_person_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "shipping_address": "shipping_address_example",
  "shipping_address_display": "shipping_address_display_example",
  "currency": "USD",
  "conversion_rate": 0,
  "buying_price_list": "buying_price_list_example",
  "price_list_currency": "USD",
  "plc_conversion_rate": 0,
  "ignore_pricing_rule": false,
  "set_warehouse": "set_warehouse_example",
  "rejected_warehouse": "rejected_warehouse_example",
  "is_subcontracted": false,
  "update_stock": false,
  "scan_barcode": "scan_barcode_example",
  "total_qty": 0,
  "base_total": 0,
  "base_net_total": 0,
  "total": 0,
  "net_total": 0,
  "total_net_weight": 0,
  "tax_category": "tax_category_example",
  "shipping_rule": "shipping_rule_example",
  "taxes_and_charges": "taxes_and_charges_example",
  "other_charges_calculation": "other_charges_calculation_example",
  "base_taxes_and_charges_added": 0,
  "base_taxes_and_charges_deducted": 0,
  "base_total_taxes_and_charges": 0,
  "taxes_and_charges_added": 0,
  "taxes_and_charges_deducted": 0,
  "total_taxes_and_charges": 0,
  "apply_discount_on": "Grand Total",
  "base_discount_amount": 0,
  "additional_discount_percentage": 0,
  "discount_amount": 0,
  "base_grand_total": 0,
  "base_rounding_adjustment": 0,
  "base_rounded_total": 0,
  "base_in_words": "base_in_words_example",
  "grand_total": 0,
  "rounding_adjustment": 0,
  "rounded_total": 0,
  "in_words": "in_words_example",
  "total_advance": 0,
  "outstanding_amount": 0,
  "disable_rounded_total": false,
  "mode_of_payment": "mode_of_payment_example",
  "cash_bank_account": "cash_bank_account_example",
  "clearance_date": "2024-01-15",
  "paid_amount": 0,
  "base_paid_amount": 0,
  "write_off_amount": 0,
  "base_write_off_amount": 0,
  "write_off_account": "write_off_account_example",
  "write_off_cost_center": "write_off_cost_center_example",
  "allocate_advances_automatically": false,
  "payment_terms_template": "payment_terms_template_example",
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "letter_head": "letter_head_example",
  "group_same_items": false,
  "select_print_heading": "select_print_heading_example",
  "language": "language_example",
  "is_internal_supplier": false,
  "credit_to": "credit_to_example",
  "party_account_currency": "USD",
  "is_opening": "No",
  "against_expense_account": "against_expense_account_example",
  "inter_company_invoice_reference": "Example Corp",
  "remarks": "remarks_example",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "auto_repeat": "auto_repeat_example",
  "billing_address": "billing_address_example",
  "billing_address_display": "billing_address_display_example",
  "project": "project_example",
  "unrealized_profit_loss_account": "unrealized_profit_loss_account_example",
  "represents_company": "Example Corp",
  "set_from_warehouse": "set_from_warehouse_example",
  "supplier_warehouse": "supplier_warehouse_example",
  "per_received": 0,
  "ignore_default_payment_terms_template": false,
  "subscription": "subscription_example",
  "is_old_subcontracting_flow": false,
  "incoterm": "incoterm_example",
  "named_place": "named_place_example",
  "only_include_allocated_payments": false,
  "use_company_roundoff_cost_center": false,
  "use_transaction_date_exchange_rate": false,
  "supplier_group": "supplier_group_example",
  "update_outstanding_for_self": true,
  "sender": "sender_example",
  "dispatch_address_display": "dispatch_address_display_example",
  "dispatch_address": "dispatch_address_example",
  "claimed_landed_cost_amount": 0,
  "tax_withholding_group": "tax_withholding_group_example",
  "ignore_tax_withholding_threshold": false,
  "override_tax_withholding_entries": false,
  "signing_document_id": "signing_document_id_example"
}
GET /api/accounts/purchase-invoice

List all purchase invoices

Returns a list of purchase invoices. 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 purchase invoice objects.

GET /api/accounts/purchase-invoice
curl https://api.overplane.dev/api/accounts/purchase-invoice \
  -H "Authorization: Bearer sk_test_..."
Response
{
  "data": [
    {
      "id": "purchase-invoice_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "title": "title_example",
      "supplier": "supplier_example",
      "supplier_name": "supplier_name_example",
      "tax_id": "tax_id_example",
      "due_date": "2024-01-15",
      "is_paid": false,
      "is_return": false,
      "apply_tds": false,
      "company": "Example Corp",
      "cost_center": "cost_center_example",
      "posting_date": "2024-01-15",
      "posting_time": "posting_time_example",
      "set_posting_time": false,
      "on_hold": false,
      "release_date": "2024-01-15",
      "hold_comment": "hold_comment_example",
      "bill_no": "bill_no_example",
      "bill_date": "2024-01-15",
      "return_against": "return_against_example",
      "update_billed_amount_in_purchase_order": false,
      "update_billed_amount_in_purchase_receipt": true,
      "supplier_address": "supplier_address_example",
      "address_display": "address_display_example",
      "contact_person": "contact_person_example",
      "contact_display": "contact_display_example",
      "contact_mobile": "contact_mobile_example",
      "contact_email": "user@example.com",
      "shipping_address": "shipping_address_example",
      "shipping_address_display": "shipping_address_display_example",
      "currency": "USD",
      "conversion_rate": 0,
      "buying_price_list": "buying_price_list_example",
      "price_list_currency": "USD",
      "plc_conversion_rate": 0,
      "ignore_pricing_rule": false,
      "set_warehouse": "set_warehouse_example",
      "rejected_warehouse": "rejected_warehouse_example",
      "is_subcontracted": false,
      "update_stock": false,
      "scan_barcode": "scan_barcode_example",
      "total_qty": 0,
      "base_total": 0,
      "base_net_total": 0,
      "total": 0,
      "net_total": 0,
      "total_net_weight": 0,
      "tax_category": "tax_category_example",
      "shipping_rule": "shipping_rule_example",
      "taxes_and_charges": "taxes_and_charges_example",
      "other_charges_calculation": "other_charges_calculation_example",
      "base_taxes_and_charges_added": 0,
      "base_taxes_and_charges_deducted": 0,
      "base_total_taxes_and_charges": 0,
      "taxes_and_charges_added": 0,
      "taxes_and_charges_deducted": 0,
      "total_taxes_and_charges": 0,
      "apply_discount_on": "Grand Total",
      "base_discount_amount": 0,
      "additional_discount_percentage": 0,
      "discount_amount": 0,
      "base_grand_total": 0,
      "base_rounding_adjustment": 0,
      "base_rounded_total": 0,
      "base_in_words": "base_in_words_example",
      "grand_total": 0,
      "rounding_adjustment": 0,
      "rounded_total": 0,
      "in_words": "in_words_example",
      "total_advance": 0,
      "outstanding_amount": 0,
      "disable_rounded_total": false,
      "mode_of_payment": "mode_of_payment_example",
      "cash_bank_account": "cash_bank_account_example",
      "clearance_date": "2024-01-15",
      "paid_amount": 0,
      "base_paid_amount": 0,
      "write_off_amount": 0,
      "base_write_off_amount": 0,
      "write_off_account": "write_off_account_example",
      "write_off_cost_center": "write_off_cost_center_example",
      "allocate_advances_automatically": false,
      "payment_terms_template": "payment_terms_template_example",
      "tc_name": "tc_name_example",
      "terms": "terms_example",
      "letter_head": "letter_head_example",
      "group_same_items": false,
      "select_print_heading": "select_print_heading_example",
      "language": "language_example",
      "is_internal_supplier": false,
      "credit_to": "credit_to_example",
      "party_account_currency": "USD",
      "is_opening": "No",
      "against_expense_account": "against_expense_account_example",
      "inter_company_invoice_reference": "Example Corp",
      "remarks": "remarks_example",
      "from_date": "2024-01-15",
      "to_date": "2024-01-15",
      "auto_repeat": "auto_repeat_example",
      "billing_address": "billing_address_example",
      "billing_address_display": "billing_address_display_example",
      "project": "project_example",
      "unrealized_profit_loss_account": "unrealized_profit_loss_account_example",
      "represents_company": "Example Corp",
      "set_from_warehouse": "set_from_warehouse_example",
      "supplier_warehouse": "supplier_warehouse_example",
      "per_received": 0,
      "ignore_default_payment_terms_template": false,
      "subscription": "subscription_example",
      "is_old_subcontracting_flow": false,
      "incoterm": "incoterm_example",
      "named_place": "named_place_example",
      "only_include_allocated_payments": false,
      "use_company_roundoff_cost_center": false,
      "use_transaction_date_exchange_rate": false,
      "supplier_group": "supplier_group_example",
      "update_outstanding_for_self": true,
      "sender": "sender_example",
      "dispatch_address_display": "dispatch_address_display_example",
      "dispatch_address": "dispatch_address_example",
      "claimed_landed_cost_amount": 0,
      "tax_withholding_group": "tax_withholding_group_example",
      "ignore_tax_withholding_threshold": false,
      "override_tax_withholding_entries": false,
      "signing_document_id": "signing_document_id_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/purchase-invoice

Create a purchase invoice

Creates a new purchase invoice object.

Body parameters

status string

Default: draft

title string
supplier string required
supplier_name string
tax_id string
due_date string
is_paid boolean

Default: false

is_return boolean

Default: false

apply_tds boolean

Default: false

company string
cost_center string
posting_date string required
posting_time string
set_posting_time boolean

Default: false

on_hold boolean

Default: false

release_date string
hold_comment string
bill_no string
bill_date string
return_against string
update_billed_amount_in_purchase_order boolean

Default: false

update_billed_amount_in_purchase_receipt boolean

Default: true

supplier_address string
address_display string
contact_person string
contact_display string
contact_mobile string
contact_email string
shipping_address string
shipping_address_display string
currency string
conversion_rate number
buying_price_list string
price_list_currency string
plc_conversion_rate number
ignore_pricing_rule boolean

Default: false

set_warehouse string
rejected_warehouse string
is_subcontracted boolean

Default: false

update_stock boolean

Default: false

scan_barcode string
total_qty number
base_total number
base_net_total number
total number
net_total number
total_net_weight number
tax_category string
shipping_rule string
taxes_and_charges string
other_charges_calculation string
base_taxes_and_charges_added number
base_taxes_and_charges_deducted number
base_total_taxes_and_charges number
taxes_and_charges_added number
taxes_and_charges_deducted number
total_taxes_and_charges number
apply_discount_on string

Default: Grand Total

base_discount_amount number
additional_discount_percentage number
discount_amount number
base_grand_total number
base_rounding_adjustment number
base_rounded_total number
base_in_words string
grand_total number
rounding_adjustment number
rounded_total number
in_words string
total_advance number
outstanding_amount number
disable_rounded_total boolean

Default: false

mode_of_payment string
cash_bank_account string
clearance_date string
paid_amount number
base_paid_amount number
write_off_amount number
base_write_off_amount number
write_off_account string
write_off_cost_center string
allocate_advances_automatically boolean

Default: false

payment_terms_template string
tc_name string
terms string
letter_head string
group_same_items boolean

Default: false

select_print_heading string
language string
is_internal_supplier boolean

Default: false

credit_to string required
party_account_currency string
is_opening string

Default: No

against_expense_account string
inter_company_invoice_reference string
remarks string
from_date string
to_date string
auto_repeat string
billing_address string
billing_address_display string
project string
unrealized_profit_loss_account string
represents_company string
set_from_warehouse string
supplier_warehouse string
per_received number
ignore_default_payment_terms_template boolean

Default: false

subscription string
is_old_subcontracting_flow boolean

Default: false

incoterm string
named_place string
only_include_allocated_payments boolean

Default: false

use_company_roundoff_cost_center boolean

Default: false

use_transaction_date_exchange_rate boolean

Default: false

supplier_group string
update_outstanding_for_self boolean

Default: true

sender string
dispatch_address_display string
dispatch_address string
claimed_landed_cost_amount number
tax_withholding_group string
ignore_tax_withholding_threshold boolean

Default: false

override_tax_withholding_entries boolean

Default: false

signing_document_id string

Returns

Returns the newly created purchase invoice object if the call succeeded.

POST /api/accounts/purchase-invoice
curl https://api.overplane.dev/api/accounts/purchase-invoice \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"supplier":"supplier_example","posting_date":"2024-01-15","credit_to":"credit_to_example"}'
Response
{
  "id": "purchase-invoice_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "title_example",
  "supplier": "supplier_example",
  "supplier_name": "supplier_name_example",
  "tax_id": "tax_id_example",
  "due_date": "2024-01-15",
  "is_paid": false,
  "is_return": false,
  "apply_tds": false,
  "company": "Example Corp",
  "cost_center": "cost_center_example",
  "posting_date": "2024-01-15",
  "posting_time": "posting_time_example",
  "set_posting_time": false,
  "on_hold": false,
  "release_date": "2024-01-15",
  "hold_comment": "hold_comment_example",
  "bill_no": "bill_no_example",
  "bill_date": "2024-01-15",
  "return_against": "return_against_example",
  "update_billed_amount_in_purchase_order": false,
  "update_billed_amount_in_purchase_receipt": true,
  "supplier_address": "supplier_address_example",
  "address_display": "address_display_example",
  "contact_person": "contact_person_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "shipping_address": "shipping_address_example",
  "shipping_address_display": "shipping_address_display_example",
  "currency": "USD",
  "conversion_rate": 0,
  "buying_price_list": "buying_price_list_example",
  "price_list_currency": "USD",
  "plc_conversion_rate": 0,
  "ignore_pricing_rule": false,
  "set_warehouse": "set_warehouse_example",
  "rejected_warehouse": "rejected_warehouse_example",
  "is_subcontracted": false,
  "update_stock": false,
  "scan_barcode": "scan_barcode_example",
  "total_qty": 0,
  "base_total": 0,
  "base_net_total": 0,
  "total": 0,
  "net_total": 0,
  "total_net_weight": 0,
  "tax_category": "tax_category_example",
  "shipping_rule": "shipping_rule_example",
  "taxes_and_charges": "taxes_and_charges_example",
  "other_charges_calculation": "other_charges_calculation_example",
  "base_taxes_and_charges_added": 0,
  "base_taxes_and_charges_deducted": 0,
  "base_total_taxes_and_charges": 0,
  "taxes_and_charges_added": 0,
  "taxes_and_charges_deducted": 0,
  "total_taxes_and_charges": 0,
  "apply_discount_on": "Grand Total",
  "base_discount_amount": 0,
  "additional_discount_percentage": 0,
  "discount_amount": 0,
  "base_grand_total": 0,
  "base_rounding_adjustment": 0,
  "base_rounded_total": 0,
  "base_in_words": "base_in_words_example",
  "grand_total": 0,
  "rounding_adjustment": 0,
  "rounded_total": 0,
  "in_words": "in_words_example",
  "total_advance": 0,
  "outstanding_amount": 0,
  "disable_rounded_total": false,
  "mode_of_payment": "mode_of_payment_example",
  "cash_bank_account": "cash_bank_account_example",
  "clearance_date": "2024-01-15",
  "paid_amount": 0,
  "base_paid_amount": 0,
  "write_off_amount": 0,
  "base_write_off_amount": 0,
  "write_off_account": "write_off_account_example",
  "write_off_cost_center": "write_off_cost_center_example",
  "allocate_advances_automatically": false,
  "payment_terms_template": "payment_terms_template_example",
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "letter_head": "letter_head_example",
  "group_same_items": false,
  "select_print_heading": "select_print_heading_example",
  "language": "language_example",
  "is_internal_supplier": false,
  "credit_to": "credit_to_example",
  "party_account_currency": "USD",
  "is_opening": "No",
  "against_expense_account": "against_expense_account_example",
  "inter_company_invoice_reference": "Example Corp",
  "remarks": "remarks_example",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "auto_repeat": "auto_repeat_example",
  "billing_address": "billing_address_example",
  "billing_address_display": "billing_address_display_example",
  "project": "project_example",
  "unrealized_profit_loss_account": "unrealized_profit_loss_account_example",
  "represents_company": "Example Corp",
  "set_from_warehouse": "set_from_warehouse_example",
  "supplier_warehouse": "supplier_warehouse_example",
  "per_received": 0,
  "ignore_default_payment_terms_template": false,
  "subscription": "subscription_example",
  "is_old_subcontracting_flow": false,
  "incoterm": "incoterm_example",
  "named_place": "named_place_example",
  "only_include_allocated_payments": false,
  "use_company_roundoff_cost_center": false,
  "use_transaction_date_exchange_rate": false,
  "supplier_group": "supplier_group_example",
  "update_outstanding_for_self": true,
  "sender": "sender_example",
  "dispatch_address_display": "dispatch_address_display_example",
  "dispatch_address": "dispatch_address_example",
  "claimed_landed_cost_amount": 0,
  "tax_withholding_group": "tax_withholding_group_example",
  "ignore_tax_withholding_threshold": false,
  "override_tax_withholding_entries": false,
  "signing_document_id": "signing_document_id_example"
}
PATCH /api/accounts/purchase-invoice/{id}

Update a purchase invoice

Updates the specified purchase invoice 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 purchase invoice to update.

Body parameters

status string

Default: draft

title string
supplier string
supplier_name string
tax_id string
due_date string
is_paid boolean

Default: false

is_return boolean

Default: false

apply_tds boolean

Default: false

company string
cost_center string
posting_date string
posting_time string
set_posting_time boolean

Default: false

on_hold boolean

Default: false

release_date string
hold_comment string
bill_no string
bill_date string
return_against string
update_billed_amount_in_purchase_order boolean

Default: false

update_billed_amount_in_purchase_receipt boolean

Default: true

supplier_address string
address_display string
contact_person string
contact_display string
contact_mobile string
contact_email string
shipping_address string
shipping_address_display string
currency string
conversion_rate number
buying_price_list string
price_list_currency string
plc_conversion_rate number
ignore_pricing_rule boolean

Default: false

set_warehouse string
rejected_warehouse string
is_subcontracted boolean

Default: false

update_stock boolean

Default: false

scan_barcode string
total_qty number
base_total number
base_net_total number
total number
net_total number
total_net_weight number
tax_category string
shipping_rule string
taxes_and_charges string
other_charges_calculation string
base_taxes_and_charges_added number
base_taxes_and_charges_deducted number
base_total_taxes_and_charges number
taxes_and_charges_added number
taxes_and_charges_deducted number
total_taxes_and_charges number
apply_discount_on string

Default: Grand Total

base_discount_amount number
additional_discount_percentage number
discount_amount number
base_grand_total number
base_rounding_adjustment number
base_rounded_total number
base_in_words string
grand_total number
rounding_adjustment number
rounded_total number
in_words string
total_advance number
outstanding_amount number
disable_rounded_total boolean

Default: false

mode_of_payment string
cash_bank_account string
clearance_date string
paid_amount number
base_paid_amount number
write_off_amount number
base_write_off_amount number
write_off_account string
write_off_cost_center string
allocate_advances_automatically boolean

Default: false

payment_terms_template string
tc_name string
terms string
letter_head string
group_same_items boolean

Default: false

select_print_heading string
language string
is_internal_supplier boolean

Default: false

credit_to string
party_account_currency string
is_opening string

Default: No

against_expense_account string
inter_company_invoice_reference string
remarks string
from_date string
to_date string
auto_repeat string
billing_address string
billing_address_display string
project string
unrealized_profit_loss_account string
represents_company string
set_from_warehouse string
supplier_warehouse string
per_received number
ignore_default_payment_terms_template boolean

Default: false

subscription string
is_old_subcontracting_flow boolean

Default: false

incoterm string
named_place string
only_include_allocated_payments boolean

Default: false

use_company_roundoff_cost_center boolean

Default: false

use_transaction_date_exchange_rate boolean

Default: false

supplier_group string
update_outstanding_for_self boolean

Default: true

sender string
dispatch_address_display string
dispatch_address string
claimed_landed_cost_amount number
tax_withholding_group string
ignore_tax_withholding_threshold boolean

Default: false

override_tax_withholding_entries boolean

Default: false

signing_document_id string

Returns

Returns the updated purchase invoice object.

PATCH /api/accounts/purchase-invoice/{id}
curl https://api.overplane.dev/api/accounts/purchase-invoice/purchase-invoice_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","title":"title_example"}'
Response
{
  "id": "purchase-invoice_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "title_example",
  "supplier": "supplier_example",
  "supplier_name": "supplier_name_example",
  "tax_id": "tax_id_example",
  "due_date": "2024-01-15",
  "is_paid": false,
  "is_return": false,
  "apply_tds": false,
  "company": "Example Corp",
  "cost_center": "cost_center_example",
  "posting_date": "2024-01-15",
  "posting_time": "posting_time_example",
  "set_posting_time": false,
  "on_hold": false,
  "release_date": "2024-01-15",
  "hold_comment": "hold_comment_example",
  "bill_no": "bill_no_example",
  "bill_date": "2024-01-15",
  "return_against": "return_against_example",
  "update_billed_amount_in_purchase_order": false,
  "update_billed_amount_in_purchase_receipt": true,
  "supplier_address": "supplier_address_example",
  "address_display": "address_display_example",
  "contact_person": "contact_person_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "shipping_address": "shipping_address_example",
  "shipping_address_display": "shipping_address_display_example",
  "currency": "USD",
  "conversion_rate": 0,
  "buying_price_list": "buying_price_list_example",
  "price_list_currency": "USD",
  "plc_conversion_rate": 0,
  "ignore_pricing_rule": false,
  "set_warehouse": "set_warehouse_example",
  "rejected_warehouse": "rejected_warehouse_example",
  "is_subcontracted": false,
  "update_stock": false,
  "scan_barcode": "scan_barcode_example",
  "total_qty": 0,
  "base_total": 0,
  "base_net_total": 0,
  "total": 0,
  "net_total": 0,
  "total_net_weight": 0,
  "tax_category": "tax_category_example",
  "shipping_rule": "shipping_rule_example",
  "taxes_and_charges": "taxes_and_charges_example",
  "other_charges_calculation": "other_charges_calculation_example",
  "base_taxes_and_charges_added": 0,
  "base_taxes_and_charges_deducted": 0,
  "base_total_taxes_and_charges": 0,
  "taxes_and_charges_added": 0,
  "taxes_and_charges_deducted": 0,
  "total_taxes_and_charges": 0,
  "apply_discount_on": "Grand Total",
  "base_discount_amount": 0,
  "additional_discount_percentage": 0,
  "discount_amount": 0,
  "base_grand_total": 0,
  "base_rounding_adjustment": 0,
  "base_rounded_total": 0,
  "base_in_words": "base_in_words_example",
  "grand_total": 0,
  "rounding_adjustment": 0,
  "rounded_total": 0,
  "in_words": "in_words_example",
  "total_advance": 0,
  "outstanding_amount": 0,
  "disable_rounded_total": false,
  "mode_of_payment": "mode_of_payment_example",
  "cash_bank_account": "cash_bank_account_example",
  "clearance_date": "2024-01-15",
  "paid_amount": 0,
  "base_paid_amount": 0,
  "write_off_amount": 0,
  "base_write_off_amount": 0,
  "write_off_account": "write_off_account_example",
  "write_off_cost_center": "write_off_cost_center_example",
  "allocate_advances_automatically": false,
  "payment_terms_template": "payment_terms_template_example",
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "letter_head": "letter_head_example",
  "group_same_items": false,
  "select_print_heading": "select_print_heading_example",
  "language": "language_example",
  "is_internal_supplier": false,
  "credit_to": "credit_to_example",
  "party_account_currency": "USD",
  "is_opening": "No",
  "against_expense_account": "against_expense_account_example",
  "inter_company_invoice_reference": "Example Corp",
  "remarks": "remarks_example",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "auto_repeat": "auto_repeat_example",
  "billing_address": "billing_address_example",
  "billing_address_display": "billing_address_display_example",
  "project": "project_example",
  "unrealized_profit_loss_account": "unrealized_profit_loss_account_example",
  "represents_company": "Example Corp",
  "set_from_warehouse": "set_from_warehouse_example",
  "supplier_warehouse": "supplier_warehouse_example",
  "per_received": 0,
  "ignore_default_payment_terms_template": false,
  "subscription": "subscription_example",
  "is_old_subcontracting_flow": false,
  "incoterm": "incoterm_example",
  "named_place": "named_place_example",
  "only_include_allocated_payments": false,
  "use_company_roundoff_cost_center": false,
  "use_transaction_date_exchange_rate": false,
  "supplier_group": "supplier_group_example",
  "update_outstanding_for_self": true,
  "sender": "sender_example",
  "dispatch_address_display": "dispatch_address_display_example",
  "dispatch_address": "dispatch_address_example",
  "claimed_landed_cost_amount": 0,
  "tax_withholding_group": "tax_withholding_group_example",
  "ignore_tax_withholding_threshold": false,
  "override_tax_withholding_entries": false,
  "signing_document_id": "signing_document_id_example"
}
DELETE /api/accounts/purchase-invoice/{id}

Delete a purchase invoice

Permanently deletes a purchase invoice. This cannot be undone.

Path parameters

id string required

The identifier of the purchase invoice to delete.

Returns

Returns a confirmation that the purchase invoice has been deleted.

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

Submit a purchase invoice

Submits a draft purchase invoice, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the purchase invoice to act on.

Returns

Returns the purchase invoice object with updated status.

POST /api/accounts/purchase-invoice/{id}/submit
curl https://api.overplane.dev/api/accounts/purchase-invoice/purchase-invoice_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response
{
  "id": "purchase-invoice_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "title_example",
  "supplier": "supplier_example",
  "supplier_name": "supplier_name_example",
  "tax_id": "tax_id_example",
  "due_date": "2024-01-15",
  "is_paid": false,
  "is_return": false,
  "apply_tds": false,
  "company": "Example Corp",
  "cost_center": "cost_center_example",
  "posting_date": "2024-01-15",
  "posting_time": "posting_time_example",
  "set_posting_time": false,
  "on_hold": false,
  "release_date": "2024-01-15",
  "hold_comment": "hold_comment_example",
  "bill_no": "bill_no_example",
  "bill_date": "2024-01-15",
  "return_against": "return_against_example",
  "update_billed_amount_in_purchase_order": false,
  "update_billed_amount_in_purchase_receipt": true,
  "supplier_address": "supplier_address_example",
  "address_display": "address_display_example",
  "contact_person": "contact_person_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "shipping_address": "shipping_address_example",
  "shipping_address_display": "shipping_address_display_example",
  "currency": "USD",
  "conversion_rate": 0,
  "buying_price_list": "buying_price_list_example",
  "price_list_currency": "USD",
  "plc_conversion_rate": 0,
  "ignore_pricing_rule": false,
  "set_warehouse": "set_warehouse_example",
  "rejected_warehouse": "rejected_warehouse_example",
  "is_subcontracted": false,
  "update_stock": false,
  "scan_barcode": "scan_barcode_example",
  "total_qty": 0,
  "base_total": 0,
  "base_net_total": 0,
  "total": 0,
  "net_total": 0,
  "total_net_weight": 0,
  "tax_category": "tax_category_example",
  "shipping_rule": "shipping_rule_example",
  "taxes_and_charges": "taxes_and_charges_example",
  "other_charges_calculation": "other_charges_calculation_example",
  "base_taxes_and_charges_added": 0,
  "base_taxes_and_charges_deducted": 0,
  "base_total_taxes_and_charges": 0,
  "taxes_and_charges_added": 0,
  "taxes_and_charges_deducted": 0,
  "total_taxes_and_charges": 0,
  "apply_discount_on": "Grand Total",
  "base_discount_amount": 0,
  "additional_discount_percentage": 0,
  "discount_amount": 0,
  "base_grand_total": 0,
  "base_rounding_adjustment": 0,
  "base_rounded_total": 0,
  "base_in_words": "base_in_words_example",
  "grand_total": 0,
  "rounding_adjustment": 0,
  "rounded_total": 0,
  "in_words": "in_words_example",
  "total_advance": 0,
  "outstanding_amount": 0,
  "disable_rounded_total": false,
  "mode_of_payment": "mode_of_payment_example",
  "cash_bank_account": "cash_bank_account_example",
  "clearance_date": "2024-01-15",
  "paid_amount": 0,
  "base_paid_amount": 0,
  "write_off_amount": 0,
  "base_write_off_amount": 0,
  "write_off_account": "write_off_account_example",
  "write_off_cost_center": "write_off_cost_center_example",
  "allocate_advances_automatically": false,
  "payment_terms_template": "payment_terms_template_example",
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "letter_head": "letter_head_example",
  "group_same_items": false,
  "select_print_heading": "select_print_heading_example",
  "language": "language_example",
  "is_internal_supplier": false,
  "credit_to": "credit_to_example",
  "party_account_currency": "USD",
  "is_opening": "No",
  "against_expense_account": "against_expense_account_example",
  "inter_company_invoice_reference": "Example Corp",
  "remarks": "remarks_example",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "auto_repeat": "auto_repeat_example",
  "billing_address": "billing_address_example",
  "billing_address_display": "billing_address_display_example",
  "project": "project_example",
  "unrealized_profit_loss_account": "unrealized_profit_loss_account_example",
  "represents_company": "Example Corp",
  "set_from_warehouse": "set_from_warehouse_example",
  "supplier_warehouse": "supplier_warehouse_example",
  "per_received": 0,
  "ignore_default_payment_terms_template": false,
  "subscription": "subscription_example",
  "is_old_subcontracting_flow": false,
  "incoterm": "incoterm_example",
  "named_place": "named_place_example",
  "only_include_allocated_payments": false,
  "use_company_roundoff_cost_center": false,
  "use_transaction_date_exchange_rate": false,
  "supplier_group": "supplier_group_example",
  "update_outstanding_for_self": true,
  "sender": "sender_example",
  "dispatch_address_display": "dispatch_address_display_example",
  "dispatch_address": "dispatch_address_example",
  "claimed_landed_cost_amount": 0,
  "tax_withholding_group": "tax_withholding_group_example",
  "ignore_tax_withholding_threshold": false,
  "override_tax_withholding_entries": false,
  "signing_document_id": "signing_document_id_example"
}
POST /api/accounts/purchase-invoice/{id}/cancel

Cancel a purchase invoice

Cancels a submitted purchase invoice, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the purchase invoice to act on.

Returns

Returns the purchase invoice object with updated status.

POST /api/accounts/purchase-invoice/{id}/cancel
curl https://api.overplane.dev/api/accounts/purchase-invoice/purchase-invoice_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response
{
  "id": "purchase-invoice_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "title": "title_example",
  "supplier": "supplier_example",
  "supplier_name": "supplier_name_example",
  "tax_id": "tax_id_example",
  "due_date": "2024-01-15",
  "is_paid": false,
  "is_return": false,
  "apply_tds": false,
  "company": "Example Corp",
  "cost_center": "cost_center_example",
  "posting_date": "2024-01-15",
  "posting_time": "posting_time_example",
  "set_posting_time": false,
  "on_hold": false,
  "release_date": "2024-01-15",
  "hold_comment": "hold_comment_example",
  "bill_no": "bill_no_example",
  "bill_date": "2024-01-15",
  "return_against": "return_against_example",
  "update_billed_amount_in_purchase_order": false,
  "update_billed_amount_in_purchase_receipt": true,
  "supplier_address": "supplier_address_example",
  "address_display": "address_display_example",
  "contact_person": "contact_person_example",
  "contact_display": "contact_display_example",
  "contact_mobile": "contact_mobile_example",
  "contact_email": "user@example.com",
  "shipping_address": "shipping_address_example",
  "shipping_address_display": "shipping_address_display_example",
  "currency": "USD",
  "conversion_rate": 0,
  "buying_price_list": "buying_price_list_example",
  "price_list_currency": "USD",
  "plc_conversion_rate": 0,
  "ignore_pricing_rule": false,
  "set_warehouse": "set_warehouse_example",
  "rejected_warehouse": "rejected_warehouse_example",
  "is_subcontracted": false,
  "update_stock": false,
  "scan_barcode": "scan_barcode_example",
  "total_qty": 0,
  "base_total": 0,
  "base_net_total": 0,
  "total": 0,
  "net_total": 0,
  "total_net_weight": 0,
  "tax_category": "tax_category_example",
  "shipping_rule": "shipping_rule_example",
  "taxes_and_charges": "taxes_and_charges_example",
  "other_charges_calculation": "other_charges_calculation_example",
  "base_taxes_and_charges_added": 0,
  "base_taxes_and_charges_deducted": 0,
  "base_total_taxes_and_charges": 0,
  "taxes_and_charges_added": 0,
  "taxes_and_charges_deducted": 0,
  "total_taxes_and_charges": 0,
  "apply_discount_on": "Grand Total",
  "base_discount_amount": 0,
  "additional_discount_percentage": 0,
  "discount_amount": 0,
  "base_grand_total": 0,
  "base_rounding_adjustment": 0,
  "base_rounded_total": 0,
  "base_in_words": "base_in_words_example",
  "grand_total": 0,
  "rounding_adjustment": 0,
  "rounded_total": 0,
  "in_words": "in_words_example",
  "total_advance": 0,
  "outstanding_amount": 0,
  "disable_rounded_total": false,
  "mode_of_payment": "mode_of_payment_example",
  "cash_bank_account": "cash_bank_account_example",
  "clearance_date": "2024-01-15",
  "paid_amount": 0,
  "base_paid_amount": 0,
  "write_off_amount": 0,
  "base_write_off_amount": 0,
  "write_off_account": "write_off_account_example",
  "write_off_cost_center": "write_off_cost_center_example",
  "allocate_advances_automatically": false,
  "payment_terms_template": "payment_terms_template_example",
  "tc_name": "tc_name_example",
  "terms": "terms_example",
  "letter_head": "letter_head_example",
  "group_same_items": false,
  "select_print_heading": "select_print_heading_example",
  "language": "language_example",
  "is_internal_supplier": false,
  "credit_to": "credit_to_example",
  "party_account_currency": "USD",
  "is_opening": "No",
  "against_expense_account": "against_expense_account_example",
  "inter_company_invoice_reference": "Example Corp",
  "remarks": "remarks_example",
  "from_date": "2024-01-15",
  "to_date": "2024-01-15",
  "auto_repeat": "auto_repeat_example",
  "billing_address": "billing_address_example",
  "billing_address_display": "billing_address_display_example",
  "project": "project_example",
  "unrealized_profit_loss_account": "unrealized_profit_loss_account_example",
  "represents_company": "Example Corp",
  "set_from_warehouse": "set_from_warehouse_example",
  "supplier_warehouse": "supplier_warehouse_example",
  "per_received": 0,
  "ignore_default_payment_terms_template": false,
  "subscription": "subscription_example",
  "is_old_subcontracting_flow": false,
  "incoterm": "incoterm_example",
  "named_place": "named_place_example",
  "only_include_allocated_payments": false,
  "use_company_roundoff_cost_center": false,
  "use_transaction_date_exchange_rate": false,
  "supplier_group": "supplier_group_example",
  "update_outstanding_for_self": true,
  "sender": "sender_example",
  "dispatch_address_display": "dispatch_address_display_example",
  "dispatch_address": "dispatch_address_example",
  "claimed_landed_cost_amount": 0,
  "tax_withholding_group": "tax_withholding_group_example",
  "ignore_tax_withholding_threshold": false,
  "override_tax_withholding_entries": false,
  "signing_document_id": "signing_document_id_example"
}

Line items

Child objects that belong to this purchase invoice. These are accessed via the parent's ID.

Purchase Invoice Advance

Attributes

idx integer
purchase_invoice_id string required
reference_type string
reference_name string
remarks string
reference_row string
advance_amount number
allocated_amount number
exchange_gain_loss number
ref_exchange_rate number
difference_posting_date string

Endpoints

GET /api/accounts/purchase-invoice-advance?parent_id={id}
POST /api/accounts/purchase-invoice-advance
PATCH /api/accounts/purchase-invoice-advance/{id}
DELETE /api/accounts/purchase-invoice-advance/{id}
POST /api/accounts/purchase-invoice-advance/reorder
Purchase Invoice Advance object
{
  "id": "purchase-invoice-advance_abc123",
  "idx": 1,
  "purchase_invoice_id": "purchase_invoice_id_example",
  "reference_type": "reference_type_example",
  "reference_name": "reference_name_example",
  "remarks": "remarks_example",
  "reference_row": "reference_row_example",
  "advance_amount": 0,
  "allocated_amount": 0,
  "exchange_gain_loss": 0,
  "ref_exchange_rate": 0,
  "difference_posting_date": "2024-01-15"
}

Purchase Invoice Item

Attributes

idx integer
purchase_invoice_id string required
item_code string
item_name string required
description string
image string
image_view string
received_qty number
qty number required
rejected_qty number
stock_uom string
uom string required
conversion_factor number required
stock_qty number required
price_list_rate number
discount_percentage number
discount_amount number
base_price_list_rate number
rate number required
amount number required
base_rate number required
base_amount number required
pricing_rules string
is_free_item boolean
net_rate number
net_amount number
base_net_rate number
base_net_amount number
weight_per_unit number
total_weight number
weight_uom string
warehouse string
rejected_warehouse string
quality_inspection string
batch_no string
serial_no string
rejected_serial_no string
expense_account string
item_tax_template string
project string
cost_center string
deferred_expense_account string
service_stop_date string
enable_deferred_expense boolean
service_start_date string
service_end_date string
allow_zero_valuation_rate boolean
brand string
item_group string
item_tax_rate string
item_tax_amount number
purchase_order string
bom string
include_exploded_items boolean
is_fixed_asset boolean
asset_location string
po_detail string
purchase_receipt string
page_break boolean
pr_detail string
valuation_rate number
rm_supp_cost number
landed_cost_voucher_amount number
manufacturer string
manufacturer_part_no string
asset_category string
from_warehouse string
purchase_invoice_item string
stock_uom_rate number
sales_invoice_item string
margin_type string
margin_rate_or_amount number
rate_with_margin number
base_rate_with_margin number
product_bundle string
apply_tds boolean
serial_and_batch_bundle string
rejected_serial_and_batch_bundle string
wip_composite_asset string
use_serial_batch_fields boolean
material_request string
material_request_item string
sales_incoming_rate number
distributed_discount_amount number
tax_withholding_category string

Endpoints

GET /api/accounts/purchase-invoice-item?parent_id={id}
POST /api/accounts/purchase-invoice-item
PATCH /api/accounts/purchase-invoice-item/{id}
DELETE /api/accounts/purchase-invoice-item/{id}
POST /api/accounts/purchase-invoice-item/reorder
Purchase Invoice Item object
{
  "id": "purchase-invoice-item_abc123",
  "idx": 1,
  "purchase_invoice_id": "purchase_invoice_id_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "description": "description_example",
  "image": "image_example",
  "image_view": "image_view_example",
  "received_qty": 0,
  "qty": 0,
  "rejected_qty": 0,
  "stock_uom": "stock_uom_example",
  "uom": "uom_example",
  "conversion_factor": 0,
  "stock_qty": 0,
  "price_list_rate": 0,
  "discount_percentage": 0,
  "discount_amount": 0,
  "base_price_list_rate": 0,
  "rate": 0,
  "amount": 0,
  "base_rate": 0,
  "base_amount": 0,
  "pricing_rules": "pricing_rules_example",
  "is_free_item": false,
  "net_rate": 0,
  "net_amount": 0,
  "base_net_rate": 0,
  "base_net_amount": 0,
  "weight_per_unit": 0,
  "total_weight": 0,
  "weight_uom": "weight_uom_example",
  "warehouse": "warehouse_example",
  "rejected_warehouse": "rejected_warehouse_example",
  "quality_inspection": "quality_inspection_example",
  "batch_no": "batch_no_example",
  "serial_no": "serial_no_example",
  "rejected_serial_no": "rejected_serial_no_example",
  "expense_account": "expense_account_example",
  "item_tax_template": "item_tax_template_example",
  "project": "project_example",
  "cost_center": "cost_center_example",
  "deferred_expense_account": "deferred_expense_account_example",
  "service_stop_date": "2024-01-15",
  "enable_deferred_expense": false,
  "service_start_date": "2024-01-15",
  "service_end_date": "2024-01-15",
  "allow_zero_valuation_rate": false,
  "brand": "brand_example",
  "item_group": "item_group_example",
  "item_tax_rate": "item_tax_rate_example",
  "item_tax_amount": 0,
  "purchase_order": "purchase_order_example",
  "bom": "bom_example",
  "include_exploded_items": false,
  "is_fixed_asset": false,
  "asset_location": "asset_location_example",
  "po_detail": "po_detail_example",
  "purchase_receipt": "purchase_receipt_example",
  "page_break": false,
  "pr_detail": "pr_detail_example",
  "valuation_rate": 0,
  "rm_supp_cost": 0,
  "landed_cost_voucher_amount": 0,
  "manufacturer": "manufacturer_example",
  "manufacturer_part_no": "manufacturer_part_no_example",
  "asset_category": "asset_category_example",
  "from_warehouse": "from_warehouse_example",
  "purchase_invoice_item": "purchase_invoice_item_example",
  "stock_uom_rate": 0,
  "sales_invoice_item": "sales_invoice_item_example",
  "margin_type": "margin_type_example",
  "margin_rate_or_amount": 0,
  "rate_with_margin": 0,
  "base_rate_with_margin": 0,
  "product_bundle": "product_bundle_example",
  "apply_tds": true,
  "serial_and_batch_bundle": "serial_and_batch_bundle_example",
  "rejected_serial_and_batch_bundle": "rejected_serial_and_batch_bundle_example",
  "wip_composite_asset": "wip_composite_asset_example",
  "use_serial_batch_fields": false,
  "material_request": "material_request_example",
  "material_request_item": "material_request_item_example",
  "sales_incoming_rate": 0,
  "distributed_discount_amount": 0,
  "tax_withholding_category": "tax_withholding_category_example"
}