The Landed Cost Voucher 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

company string required
total_taxes_and_charges number required
distribute_charges_based_on string required
posting_date string required
total_vendor_invoices_cost number
The Landed Cost Voucher object 
{
  "id": "landed-cost-voucher_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "total_taxes_and_charges": 0,
  "distribute_charges_based_on": "distribute_charges_based_on_example",
  "posting_date": "2024-01-15",
  "total_vendor_invoices_cost": 0
}
GET /api/stock/landed-cost-voucher/{id}

Retrieve a landed cost voucher

Retrieves the details of an existing landed cost voucher. Supply the unique landed cost voucher ID that was returned from a previous request.

Path parameters

id string required

The identifier of the landed cost voucher to retrieve.

Returns

Returns the landed cost voucher object if a valid identifier was provided.

GET /api/stock/landed-cost-voucher/{id} 
curl https://api.overplane.dev/api/stock/landed-cost-voucher/landed-cost-voucher_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "landed-cost-voucher_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "total_taxes_and_charges": 0,
  "distribute_charges_based_on": "distribute_charges_based_on_example",
  "posting_date": "2024-01-15",
  "total_vendor_invoices_cost": 0
}
GET /api/stock/landed-cost-voucher

List all landed cost vouchers

Returns a list of landed cost vouchers. 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 landed cost voucher objects.

GET /api/stock/landed-cost-voucher 
curl https://api.overplane.dev/api/stock/landed-cost-voucher \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "landed-cost-voucher_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "company": "Example Corp",
      "total_taxes_and_charges": 0,
      "distribute_charges_based_on": "distribute_charges_based_on_example",
      "posting_date": "2024-01-15",
      "total_vendor_invoices_cost": 0
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/stock/landed-cost-voucher

Create a landed cost voucher

Creates a new landed cost voucher object.

Body parameters

status string

Default: draft

company string required
total_taxes_and_charges number required
distribute_charges_based_on string required
posting_date string required
total_vendor_invoices_cost number

Returns

Returns the newly created landed cost voucher object if the call succeeded.

POST /api/stock/landed-cost-voucher 
curl https://api.overplane.dev/api/stock/landed-cost-voucher \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"company":"Example Corp","total_taxes_and_charges":0,"distribute_charges_based_on":"distribute_charges_based_on_example","posting_date":"2024-01-15"}'
Response 
{
  "id": "landed-cost-voucher_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "total_taxes_and_charges": 0,
  "distribute_charges_based_on": "distribute_charges_based_on_example",
  "posting_date": "2024-01-15",
  "total_vendor_invoices_cost": 0
}
PATCH /api/stock/landed-cost-voucher/{id}

Update a landed cost voucher

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

Body parameters

status string

Default: draft

company string
total_taxes_and_charges number
distribute_charges_based_on string
posting_date string
total_vendor_invoices_cost number

Returns

Returns the updated landed cost voucher object.

PATCH /api/stock/landed-cost-voucher/{id} 
curl https://api.overplane.dev/api/stock/landed-cost-voucher/landed-cost-voucher_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","company":"Example Corp"}'
Response 
{
  "id": "landed-cost-voucher_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "total_taxes_and_charges": 0,
  "distribute_charges_based_on": "distribute_charges_based_on_example",
  "posting_date": "2024-01-15",
  "total_vendor_invoices_cost": 0
}
DELETE /api/stock/landed-cost-voucher/{id}

Delete a landed cost voucher

Permanently deletes a landed cost voucher. This cannot be undone.

Path parameters

id string required

The identifier of the landed cost voucher to delete.

Returns

Returns a confirmation that the landed cost voucher has been deleted.

DELETE /api/stock/landed-cost-voucher/{id} 
curl https://api.overplane.dev/api/stock/landed-cost-voucher/landed-cost-voucher_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "landed-cost-voucher_abc123",
  "deleted": true
}
POST /api/stock/landed-cost-voucher/{id}/submit

Submit a landed cost voucher

Submits a draft landed cost voucher, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the landed cost voucher to act on.

Returns

Returns the landed cost voucher object with updated status.

POST /api/stock/landed-cost-voucher/{id}/submit 
curl https://api.overplane.dev/api/stock/landed-cost-voucher/landed-cost-voucher_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "landed-cost-voucher_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "total_taxes_and_charges": 0,
  "distribute_charges_based_on": "distribute_charges_based_on_example",
  "posting_date": "2024-01-15",
  "total_vendor_invoices_cost": 0
}
POST /api/stock/landed-cost-voucher/{id}/cancel

Cancel a landed cost voucher

Cancels a submitted landed cost voucher, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the landed cost voucher to act on.

Returns

Returns the landed cost voucher object with updated status.

POST /api/stock/landed-cost-voucher/{id}/cancel 
curl https://api.overplane.dev/api/stock/landed-cost-voucher/landed-cost-voucher_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "landed-cost-voucher_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "company": "Example Corp",
  "total_taxes_and_charges": 0,
  "distribute_charges_based_on": "distribute_charges_based_on_example",
  "posting_date": "2024-01-15",
  "total_vendor_invoices_cost": 0
}

Line items

Child objects that belong to this landed cost voucher. These are accessed via the parent's ID.

Landed Cost Item

Attributes

idx integer
landed_cost_voucher_id string required
item_code string required
description string
receipt_document_type string
receipt_document string
qty number
rate number
amount number required
applicable_charges number
purchase_receipt_item string
cost_center string
is_fixed_asset boolean
stock_entry_item string

Endpoints

GET /api/stock/landed-cost-item?parent_id={id}
POST /api/stock/landed-cost-item
PATCH /api/stock/landed-cost-item/{id}
DELETE /api/stock/landed-cost-item/{id}
POST /api/stock/landed-cost-item/reorder
Landed Cost Item object 
{
  "id": "landed-cost-item_abc123",
  "idx": 1,
  "landed_cost_voucher_id": "landed_cost_voucher_id_example",
  "item_code": "item_code_example",
  "description": "description_example",
  "receipt_document_type": "receipt_document_type_example",
  "receipt_document": "receipt_document_example",
  "qty": 0,
  "rate": 0,
  "amount": 0,
  "applicable_charges": 0,
  "purchase_receipt_item": "purchase_receipt_item_example",
  "cost_center": "cost_center_example",
  "is_fixed_asset": false,
  "stock_entry_item": "stock_entry_item_example"
}

Landed Cost Purchase Receipt

Attributes

idx integer
landed_cost_voucher_id string required
receipt_document_type string required
receipt_document string required
supplier string
posting_date string
grand_total number

Endpoints

GET /api/stock/landed-cost-purchase-receipt?parent_id={id}
POST /api/stock/landed-cost-purchase-receipt
PATCH /api/stock/landed-cost-purchase-receipt/{id}
DELETE /api/stock/landed-cost-purchase-receipt/{id}
POST /api/stock/landed-cost-purchase-receipt/reorder
Landed Cost Purchase Receipt object 
{
  "id": "landed-cost-purchase-receipt_abc123",
  "idx": 1,
  "landed_cost_voucher_id": "landed_cost_voucher_id_example",
  "receipt_document_type": "receipt_document_type_example",
  "receipt_document": "receipt_document_example",
  "supplier": "supplier_example",
  "posting_date": "2024-01-15",
  "grand_total": 0
}

Landed Cost Vendor Invoice

Attributes

idx integer
landed_cost_voucher_id string required
vendor_invoice string
amount number

Endpoints

GET /api/stock/landed-cost-vendor-invoice?parent_id={id}
POST /api/stock/landed-cost-vendor-invoice
PATCH /api/stock/landed-cost-vendor-invoice/{id}
DELETE /api/stock/landed-cost-vendor-invoice/{id}
POST /api/stock/landed-cost-vendor-invoice/reorder
Landed Cost Vendor Invoice object 
{
  "id": "landed-cost-vendor-invoice_abc123",
  "idx": 1,
  "landed_cost_voucher_id": "landed_cost_voucher_id_example",
  "vendor_invoice": "vendor_invoice_example",
  "amount": 0
}