The Landed Cost Taxes And Charges object

Attributes

id string

Unique identifier for the object.

idx integer
parent_id string required
parent_type string required
description string required
amount number required
expense_account string
account_currency string
exchange_rate number
base_amount number
has_corrective_cost boolean

Default: false

has_operating_cost boolean

Default: false

The Landed Cost Taxes And Charges object 
{
  "id": "landed-cost-taxes-and-charges_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "description": "description_example",
  "amount": 0,
  "expense_account": "expense_account_example",
  "account_currency": "USD",
  "exchange_rate": 0,
  "base_amount": 0,
  "has_corrective_cost": false,
  "has_operating_cost": false
}
GET /api/stock/landed-cost-taxes-and-charges?parent_id={id}

List landed cost taxes and chargess by parent

Returns all landed cost taxes and chargess belonging to the specified parent.

Query parameters

parent_id string required

The ID of the parent to list children for.

Returns

A list of landed cost taxes and charges objects belonging to the parent.

GET /api/stock/landed-cost-taxes-and-charges?parent_id={id} 
curl https://api.overplane.dev/api/stock/landed-cost-taxes-and-charges?parent_id=parent_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "landed-cost-taxes-and-charges_abc123",
      "idx": 1,
      "parent_id": null,
      "parent_type": "parent_type_example",
      "description": "description_example",
      "amount": 0,
      "expense_account": "expense_account_example",
      "account_currency": "USD",
      "exchange_rate": 0,
      "base_amount": 0,
      "has_corrective_cost": false,
      "has_operating_cost": false
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/stock/landed-cost-taxes-and-charges

Create a landed cost taxes and charges

Creates a new landed cost taxes and charges object.

Body parameters

idx integer
parent_id string required
parent_type string required
description string required
amount number required
expense_account string
account_currency string
exchange_rate number
base_amount number
has_corrective_cost boolean

Default: false

has_operating_cost boolean

Default: false

Returns

Returns the newly created landed cost taxes and charges object if the call succeeded.

POST /api/stock/landed-cost-taxes-and-charges 
curl https://api.overplane.dev/api/stock/landed-cost-taxes-and-charges \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"parent_id":null,"parent_type":"parent_type_example","description":"description_example","amount":0}'
Response 
{
  "id": "landed-cost-taxes-and-charges_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "description": "description_example",
  "amount": 0,
  "expense_account": "expense_account_example",
  "account_currency": "USD",
  "exchange_rate": 0,
  "base_amount": 0,
  "has_corrective_cost": false,
  "has_operating_cost": false
}
PATCH /api/stock/landed-cost-taxes-and-charges/{id}

Update a landed cost taxes and charges

Updates the specified landed cost taxes and charges 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 landed cost taxes and charges to update.

Body parameters

idx integer
parent_id string
parent_type string
description string
amount number
expense_account string
account_currency string
exchange_rate number
base_amount number
has_corrective_cost boolean

Default: false

has_operating_cost boolean

Default: false

Returns

Returns the updated landed cost taxes and charges object.

PATCH /api/stock/landed-cost-taxes-and-charges/{id} 
curl https://api.overplane.dev/api/stock/landed-cost-taxes-and-charges/landed-cost-taxes-and-charges_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"idx":1,"parent_id":null}'
Response 
{
  "id": "landed-cost-taxes-and-charges_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "description": "description_example",
  "amount": 0,
  "expense_account": "expense_account_example",
  "account_currency": "USD",
  "exchange_rate": 0,
  "base_amount": 0,
  "has_corrective_cost": false,
  "has_operating_cost": false
}
DELETE /api/stock/landed-cost-taxes-and-charges/{id}

Delete a landed cost taxes and charges

Permanently deletes a landed cost taxes and charges. This cannot be undone.

Path parameters

id string required

The identifier of the landed cost taxes and charges to delete.

Returns

Returns a confirmation that the landed cost taxes and charges has been deleted.

DELETE /api/stock/landed-cost-taxes-and-charges/{id} 
curl https://api.overplane.dev/api/stock/landed-cost-taxes-and-charges/landed-cost-taxes-and-charges_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "landed-cost-taxes-and-charges_abc123",
  "deleted": true
}
POST /api/stock/landed-cost-taxes-and-charges/reorder

Reorder landed cost taxes and chargess

Updates the sort order of landed cost taxes and chargess within their parent by setting new index values.

Returns

Returns the reordered list.

POST /api/stock/landed-cost-taxes-and-charges/reorder 
curl https://api.overplane.dev/api/stock/landed-cost-taxes-and-charges/reorder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "landed-cost-taxes-and-charges_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "description": "description_example",
  "amount": 0,
  "expense_account": "expense_account_example",
  "account_currency": "USD",
  "exchange_rate": 0,
  "base_amount": 0,
  "has_corrective_cost": false,
  "has_operating_cost": false
}