The Buying Settings 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.

supp_master_name string

Default: Supplier Name

supplier_group string

buying_price_list string

po_required string

pr_required string

maintain_same_rate boolean

Default: false

allow_multiple_items boolean

Default: false

backflush_raw_materials_of_subcontract_based_on string

Default: BOM

over_transfer_allowance number

maintain_same_rate_action string

Default: Stop

role_to_override_stop_action string

bill_for_rejected_quantity_in_purchase_invoice boolean

Default: true

disable_last_purchase_rate boolean

Default: false

show_pay_button boolean

Default: true

set_landed_cost_based_on_purchase_invoice_rate boolean

Default: false

use_transaction_date_exchange_rate boolean

Default: false

blanket_order_allowance number

Default: 0

auto_create_subcontracting_order boolean

Default: false

auto_create_purchase_receipt boolean

Default: false

project_update_frequency string

Default: Each Transaction

allow_zero_qty_in_purchase_order boolean

Default: false

allow_zero_qty_in_request_for_quotation boolean

Default: false

allow_zero_qty_in_supplier_quotation boolean

Default: false

set_valuation_rate_for_rejected_materials boolean

Default: false

fixed_email string

validate_consumed_qty boolean

Default: false

The Buying Settings object

{
  "id": "buying-settings_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "supp_master_name": "Supplier Name",
  "supplier_group": "supplier_group_example",
  "buying_price_list": "buying_price_list_example",
  "po_required": "po_required_example",
  "pr_required": "pr_required_example",
  "maintain_same_rate": false,
  "allow_multiple_items": false,
  "backflush_raw_materials_of_subcontract_based_on": "BOM",
  "over_transfer_allowance": 0,
  "maintain_same_rate_action": "Stop",
  "role_to_override_stop_action": "role_to_override_stop_action_example",
  "bill_for_rejected_quantity_in_purchase_invoice": true,
  "disable_last_purchase_rate": false,
  "show_pay_button": true,
  "set_landed_cost_based_on_purchase_invoice_rate": false,
  "use_transaction_date_exchange_rate": false,
  "blanket_order_allowance": 0,
  "auto_create_subcontracting_order": false,
  "auto_create_purchase_receipt": false,
  "project_update_frequency": "Each Transaction",
  "allow_zero_qty_in_purchase_order": false,
  "allow_zero_qty_in_request_for_quotation": false,
  "allow_zero_qty_in_supplier_quotation": false,
  "set_valuation_rate_for_rejected_materials": false,
  "fixed_email": "user@example.com",
  "validate_consumed_qty": false
}

GET /api/buying/buying-settings

Retrieve buying settings

Retrieves the current buying settings. This is a singleton resource.

Returns

Returns the buying settings object.

GET /api/buying/buying-settings

curl https://api.overplane.dev/api/buying/buying-settings \
  -H "Authorization: Bearer sk_test_..."

Response

{
  "id": "buying-settings_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "supp_master_name": "Supplier Name",
  "supplier_group": "supplier_group_example",
  "buying_price_list": "buying_price_list_example",
  "po_required": "po_required_example",
  "pr_required": "pr_required_example",
  "maintain_same_rate": false,
  "allow_multiple_items": false,
  "backflush_raw_materials_of_subcontract_based_on": "BOM",
  "over_transfer_allowance": 0,
  "maintain_same_rate_action": "Stop",
  "role_to_override_stop_action": "role_to_override_stop_action_example",
  "bill_for_rejected_quantity_in_purchase_invoice": true,
  "disable_last_purchase_rate": false,
  "show_pay_button": true,
  "set_landed_cost_based_on_purchase_invoice_rate": false,
  "use_transaction_date_exchange_rate": false,
  "blanket_order_allowance": 0,
  "auto_create_subcontracting_order": false,
  "auto_create_purchase_receipt": false,
  "project_update_frequency": "Each Transaction",
  "allow_zero_qty_in_purchase_order": false,
  "allow_zero_qty_in_request_for_quotation": false,
  "allow_zero_qty_in_supplier_quotation": false,
  "set_valuation_rate_for_rejected_materials": false,
  "fixed_email": "user@example.com",
  "validate_consumed_qty": false
}

PATCH /api/buying/buying-settings/{id}

Update a buying settings

Updates the specified buying settings 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 buying settings to update.

Body parameters

supp_master_name string

Default: Supplier Name

supplier_group string

buying_price_list string

po_required string

pr_required string

maintain_same_rate boolean

Default: false

allow_multiple_items boolean

Default: false

backflush_raw_materials_of_subcontract_based_on string

Default: BOM

over_transfer_allowance number

maintain_same_rate_action string

Default: Stop

role_to_override_stop_action string

bill_for_rejected_quantity_in_purchase_invoice boolean

Default: true

disable_last_purchase_rate boolean

Default: false

show_pay_button boolean

Default: true

set_landed_cost_based_on_purchase_invoice_rate boolean

Default: false

use_transaction_date_exchange_rate boolean

Default: false

blanket_order_allowance number

Default: 0

auto_create_subcontracting_order boolean

Default: false

auto_create_purchase_receipt boolean

Default: false

project_update_frequency string

Default: Each Transaction

allow_zero_qty_in_purchase_order boolean

Default: false

allow_zero_qty_in_request_for_quotation boolean

Default: false

allow_zero_qty_in_supplier_quotation boolean

Default: false

set_valuation_rate_for_rejected_materials boolean

Default: false

fixed_email string

validate_consumed_qty boolean

Default: false

Returns

Returns the updated buying settings object.

PATCH /api/buying/buying-settings/{id}

curl https://api.overplane.dev/api/buying/buying-settings/buying-settings_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"supp_master_name":"Supplier Name","supplier_group":"supplier_group_example"}'

Response

{
  "id": "buying-settings_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "supp_master_name": "Supplier Name",
  "supplier_group": "supplier_group_example",
  "buying_price_list": "buying_price_list_example",
  "po_required": "po_required_example",
  "pr_required": "pr_required_example",
  "maintain_same_rate": false,
  "allow_multiple_items": false,
  "backflush_raw_materials_of_subcontract_based_on": "BOM",
  "over_transfer_allowance": 0,
  "maintain_same_rate_action": "Stop",
  "role_to_override_stop_action": "role_to_override_stop_action_example",
  "bill_for_rejected_quantity_in_purchase_invoice": true,
  "disable_last_purchase_rate": false,
  "show_pay_button": true,
  "set_landed_cost_based_on_purchase_invoice_rate": false,
  "use_transaction_date_exchange_rate": false,
  "blanket_order_allowance": 0,
  "auto_create_subcontracting_order": false,
  "auto_create_purchase_receipt": false,
  "project_update_frequency": "Each Transaction",
  "allow_zero_qty_in_purchase_order": false,
  "allow_zero_qty_in_request_for_quotation": false,
  "allow_zero_qty_in_supplier_quotation": false,
  "set_valuation_rate_for_rejected_materials": false,
  "fixed_email": "user@example.com",
  "validate_consumed_qty": false
}

The Buying Settings object

Attributes

Retrieve buying settings

Returns

Update a buying settings

Path parameters

Body parameters

Returns

Coming Soon