The Job Card 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

work_order string required
bom_no string
workstation string required
operation string required
posting_date string
company string required
for_quantity number
wip_warehouse string
total_completed_qty number

Default: 0

total_time_in_mins number
operation_id string
transferred_qty number

Default: 0

requested_qty number

Default: 0

project string
remarks string
production_item string
barcode string
item_name string
operation_row_number string
sequence_id integer
quality_inspection string
hour_rate number
is_corrective_job_card boolean

Default: false

for_job_card string
for_operation string
serial_no string
batch_no string
quality_inspection_template string
workstation_type string
expected_start_date string
expected_end_date string
serial_and_batch_bundle string
process_loss_qty number
time_required number
actual_start_date string
actual_end_date string
finished_good string
target_warehouse string
operation_row_id integer
source_warehouse string
semi_fg_bom string
is_subcontracted boolean

Default: false

manufactured_qty number
skip_material_transfer boolean

Default: false

backflush_from_wip_warehouse boolean

Default: false

is_paused boolean

Default: false

track_semi_finished_goods boolean

Default: false

The Job Card object 
{
  "id": "job-card_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "work_order": "work_order_example",
  "bom_no": "bom_no_example",
  "workstation": "workstation_example",
  "operation": "operation_example",
  "posting_date": "2024-01-15",
  "company": "Example Corp",
  "for_quantity": 0,
  "wip_warehouse": "wip_warehouse_example",
  "total_completed_qty": 0,
  "total_time_in_mins": 0,
  "operation_id": "operation_id_example",
  "transferred_qty": 0,
  "requested_qty": 0,
  "project": "project_example",
  "remarks": "remarks_example",
  "production_item": "production_item_example",
  "barcode": "barcode_example",
  "item_name": "item_name_example",
  "operation_row_number": "operation_row_number_example",
  "sequence_id": 0,
  "quality_inspection": "quality_inspection_example",
  "hour_rate": 0,
  "is_corrective_job_card": false,
  "for_job_card": "for_job_card_example",
  "for_operation": "for_operation_example",
  "serial_no": "serial_no_example",
  "batch_no": "batch_no_example",
  "quality_inspection_template": "quality_inspection_template_example",
  "workstation_type": "workstation_type_example",
  "expected_start_date": "2024-01-15",
  "expected_end_date": "2024-01-15",
  "serial_and_batch_bundle": "serial_and_batch_bundle_example",
  "process_loss_qty": 0,
  "time_required": 0,
  "actual_start_date": "2024-01-15",
  "actual_end_date": "2024-01-15",
  "finished_good": "finished_good_example",
  "target_warehouse": "target_warehouse_example",
  "operation_row_id": 0,
  "source_warehouse": "source_warehouse_example",
  "semi_fg_bom": "semi_fg_bom_example",
  "is_subcontracted": false,
  "manufactured_qty": 0,
  "skip_material_transfer": false,
  "backflush_from_wip_warehouse": false,
  "is_paused": false,
  "track_semi_finished_goods": false
}
GET /api/manufacturing/job-card/{id}

Retrieve a job card

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

Path parameters

id string required

The identifier of the job card to retrieve.

Returns

Returns the job card object if a valid identifier was provided.

GET /api/manufacturing/job-card/{id} 
curl https://api.overplane.dev/api/manufacturing/job-card/job-card_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "job-card_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "work_order": "work_order_example",
  "bom_no": "bom_no_example",
  "workstation": "workstation_example",
  "operation": "operation_example",
  "posting_date": "2024-01-15",
  "company": "Example Corp",
  "for_quantity": 0,
  "wip_warehouse": "wip_warehouse_example",
  "total_completed_qty": 0,
  "total_time_in_mins": 0,
  "operation_id": "operation_id_example",
  "transferred_qty": 0,
  "requested_qty": 0,
  "project": "project_example",
  "remarks": "remarks_example",
  "production_item": "production_item_example",
  "barcode": "barcode_example",
  "item_name": "item_name_example",
  "operation_row_number": "operation_row_number_example",
  "sequence_id": 0,
  "quality_inspection": "quality_inspection_example",
  "hour_rate": 0,
  "is_corrective_job_card": false,
  "for_job_card": "for_job_card_example",
  "for_operation": "for_operation_example",
  "serial_no": "serial_no_example",
  "batch_no": "batch_no_example",
  "quality_inspection_template": "quality_inspection_template_example",
  "workstation_type": "workstation_type_example",
  "expected_start_date": "2024-01-15",
  "expected_end_date": "2024-01-15",
  "serial_and_batch_bundle": "serial_and_batch_bundle_example",
  "process_loss_qty": 0,
  "time_required": 0,
  "actual_start_date": "2024-01-15",
  "actual_end_date": "2024-01-15",
  "finished_good": "finished_good_example",
  "target_warehouse": "target_warehouse_example",
  "operation_row_id": 0,
  "source_warehouse": "source_warehouse_example",
  "semi_fg_bom": "semi_fg_bom_example",
  "is_subcontracted": false,
  "manufactured_qty": 0,
  "skip_material_transfer": false,
  "backflush_from_wip_warehouse": false,
  "is_paused": false,
  "track_semi_finished_goods": false
}
GET /api/manufacturing/job-card

List all job cards

Returns a list of job cards. 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 job card objects.

GET /api/manufacturing/job-card 
curl https://api.overplane.dev/api/manufacturing/job-card \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "job-card_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "work_order": "work_order_example",
      "bom_no": "bom_no_example",
      "workstation": "workstation_example",
      "operation": "operation_example",
      "posting_date": "2024-01-15",
      "company": "Example Corp",
      "for_quantity": 0,
      "wip_warehouse": "wip_warehouse_example",
      "total_completed_qty": 0,
      "total_time_in_mins": 0,
      "operation_id": "operation_id_example",
      "transferred_qty": 0,
      "requested_qty": 0,
      "project": "project_example",
      "remarks": "remarks_example",
      "production_item": "production_item_example",
      "barcode": "barcode_example",
      "item_name": "item_name_example",
      "operation_row_number": "operation_row_number_example",
      "sequence_id": 0,
      "quality_inspection": "quality_inspection_example",
      "hour_rate": 0,
      "is_corrective_job_card": false,
      "for_job_card": "for_job_card_example",
      "for_operation": "for_operation_example",
      "serial_no": "serial_no_example",
      "batch_no": "batch_no_example",
      "quality_inspection_template": "quality_inspection_template_example",
      "workstation_type": "workstation_type_example",
      "expected_start_date": "2024-01-15",
      "expected_end_date": "2024-01-15",
      "serial_and_batch_bundle": "serial_and_batch_bundle_example",
      "process_loss_qty": 0,
      "time_required": 0,
      "actual_start_date": "2024-01-15",
      "actual_end_date": "2024-01-15",
      "finished_good": "finished_good_example",
      "target_warehouse": "target_warehouse_example",
      "operation_row_id": 0,
      "source_warehouse": "source_warehouse_example",
      "semi_fg_bom": "semi_fg_bom_example",
      "is_subcontracted": false,
      "manufactured_qty": 0,
      "skip_material_transfer": false,
      "backflush_from_wip_warehouse": false,
      "is_paused": false,
      "track_semi_finished_goods": false
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/manufacturing/job-card

Create a job card

Creates a new job card object.

Body parameters

status string

Default: draft

work_order string required
bom_no string
workstation string required
operation string required
posting_date string
company string required
for_quantity number
wip_warehouse string
total_completed_qty number

Default: 0

total_time_in_mins number
operation_id string
transferred_qty number

Default: 0

requested_qty number

Default: 0

project string
remarks string
production_item string
barcode string
item_name string
operation_row_number string
sequence_id integer
quality_inspection string
hour_rate number
is_corrective_job_card boolean

Default: false

for_job_card string
for_operation string
serial_no string
batch_no string
quality_inspection_template string
workstation_type string
expected_start_date string
expected_end_date string
serial_and_batch_bundle string
process_loss_qty number
time_required number
actual_start_date string
actual_end_date string
finished_good string
target_warehouse string
operation_row_id integer
source_warehouse string
semi_fg_bom string
is_subcontracted boolean

Default: false

manufactured_qty number
skip_material_transfer boolean

Default: false

backflush_from_wip_warehouse boolean

Default: false

is_paused boolean

Default: false

track_semi_finished_goods boolean

Default: false

Returns

Returns the newly created job card object if the call succeeded.

POST /api/manufacturing/job-card 
curl https://api.overplane.dev/api/manufacturing/job-card \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"work_order":"work_order_example","workstation":"workstation_example","operation":"operation_example","company":"Example Corp"}'
Response 
{
  "id": "job-card_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "work_order": "work_order_example",
  "bom_no": "bom_no_example",
  "workstation": "workstation_example",
  "operation": "operation_example",
  "posting_date": "2024-01-15",
  "company": "Example Corp",
  "for_quantity": 0,
  "wip_warehouse": "wip_warehouse_example",
  "total_completed_qty": 0,
  "total_time_in_mins": 0,
  "operation_id": "operation_id_example",
  "transferred_qty": 0,
  "requested_qty": 0,
  "project": "project_example",
  "remarks": "remarks_example",
  "production_item": "production_item_example",
  "barcode": "barcode_example",
  "item_name": "item_name_example",
  "operation_row_number": "operation_row_number_example",
  "sequence_id": 0,
  "quality_inspection": "quality_inspection_example",
  "hour_rate": 0,
  "is_corrective_job_card": false,
  "for_job_card": "for_job_card_example",
  "for_operation": "for_operation_example",
  "serial_no": "serial_no_example",
  "batch_no": "batch_no_example",
  "quality_inspection_template": "quality_inspection_template_example",
  "workstation_type": "workstation_type_example",
  "expected_start_date": "2024-01-15",
  "expected_end_date": "2024-01-15",
  "serial_and_batch_bundle": "serial_and_batch_bundle_example",
  "process_loss_qty": 0,
  "time_required": 0,
  "actual_start_date": "2024-01-15",
  "actual_end_date": "2024-01-15",
  "finished_good": "finished_good_example",
  "target_warehouse": "target_warehouse_example",
  "operation_row_id": 0,
  "source_warehouse": "source_warehouse_example",
  "semi_fg_bom": "semi_fg_bom_example",
  "is_subcontracted": false,
  "manufactured_qty": 0,
  "skip_material_transfer": false,
  "backflush_from_wip_warehouse": false,
  "is_paused": false,
  "track_semi_finished_goods": false
}
PATCH /api/manufacturing/job-card/{id}

Update a job card

Updates the specified job card 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 job card to update.

Body parameters

status string

Default: draft

work_order string
bom_no string
workstation string
operation string
posting_date string
company string
for_quantity number
wip_warehouse string
total_completed_qty number

Default: 0

total_time_in_mins number
operation_id string
transferred_qty number

Default: 0

requested_qty number

Default: 0

project string
remarks string
production_item string
barcode string
item_name string
operation_row_number string
sequence_id integer
quality_inspection string
hour_rate number
is_corrective_job_card boolean

Default: false

for_job_card string
for_operation string
serial_no string
batch_no string
quality_inspection_template string
workstation_type string
expected_start_date string
expected_end_date string
serial_and_batch_bundle string
process_loss_qty number
time_required number
actual_start_date string
actual_end_date string
finished_good string
target_warehouse string
operation_row_id integer
source_warehouse string
semi_fg_bom string
is_subcontracted boolean

Default: false

manufactured_qty number
skip_material_transfer boolean

Default: false

backflush_from_wip_warehouse boolean

Default: false

is_paused boolean

Default: false

track_semi_finished_goods boolean

Default: false

Returns

Returns the updated job card object.

PATCH /api/manufacturing/job-card/{id} 
curl https://api.overplane.dev/api/manufacturing/job-card/job-card_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","work_order":"work_order_example"}'
Response 
{
  "id": "job-card_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "work_order": "work_order_example",
  "bom_no": "bom_no_example",
  "workstation": "workstation_example",
  "operation": "operation_example",
  "posting_date": "2024-01-15",
  "company": "Example Corp",
  "for_quantity": 0,
  "wip_warehouse": "wip_warehouse_example",
  "total_completed_qty": 0,
  "total_time_in_mins": 0,
  "operation_id": "operation_id_example",
  "transferred_qty": 0,
  "requested_qty": 0,
  "project": "project_example",
  "remarks": "remarks_example",
  "production_item": "production_item_example",
  "barcode": "barcode_example",
  "item_name": "item_name_example",
  "operation_row_number": "operation_row_number_example",
  "sequence_id": 0,
  "quality_inspection": "quality_inspection_example",
  "hour_rate": 0,
  "is_corrective_job_card": false,
  "for_job_card": "for_job_card_example",
  "for_operation": "for_operation_example",
  "serial_no": "serial_no_example",
  "batch_no": "batch_no_example",
  "quality_inspection_template": "quality_inspection_template_example",
  "workstation_type": "workstation_type_example",
  "expected_start_date": "2024-01-15",
  "expected_end_date": "2024-01-15",
  "serial_and_batch_bundle": "serial_and_batch_bundle_example",
  "process_loss_qty": 0,
  "time_required": 0,
  "actual_start_date": "2024-01-15",
  "actual_end_date": "2024-01-15",
  "finished_good": "finished_good_example",
  "target_warehouse": "target_warehouse_example",
  "operation_row_id": 0,
  "source_warehouse": "source_warehouse_example",
  "semi_fg_bom": "semi_fg_bom_example",
  "is_subcontracted": false,
  "manufactured_qty": 0,
  "skip_material_transfer": false,
  "backflush_from_wip_warehouse": false,
  "is_paused": false,
  "track_semi_finished_goods": false
}
DELETE /api/manufacturing/job-card/{id}

Delete a job card

Permanently deletes a job card. This cannot be undone.

Path parameters

id string required

The identifier of the job card to delete.

Returns

Returns a confirmation that the job card has been deleted.

DELETE /api/manufacturing/job-card/{id} 
curl https://api.overplane.dev/api/manufacturing/job-card/job-card_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "job-card_abc123",
  "deleted": true
}
POST /api/manufacturing/job-card/{id}/submit

Submit a job card

Submits a draft job card, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the job card to act on.

Returns

Returns the job card object with updated status.

POST /api/manufacturing/job-card/{id}/submit 
curl https://api.overplane.dev/api/manufacturing/job-card/job-card_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "job-card_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "work_order": "work_order_example",
  "bom_no": "bom_no_example",
  "workstation": "workstation_example",
  "operation": "operation_example",
  "posting_date": "2024-01-15",
  "company": "Example Corp",
  "for_quantity": 0,
  "wip_warehouse": "wip_warehouse_example",
  "total_completed_qty": 0,
  "total_time_in_mins": 0,
  "operation_id": "operation_id_example",
  "transferred_qty": 0,
  "requested_qty": 0,
  "project": "project_example",
  "remarks": "remarks_example",
  "production_item": "production_item_example",
  "barcode": "barcode_example",
  "item_name": "item_name_example",
  "operation_row_number": "operation_row_number_example",
  "sequence_id": 0,
  "quality_inspection": "quality_inspection_example",
  "hour_rate": 0,
  "is_corrective_job_card": false,
  "for_job_card": "for_job_card_example",
  "for_operation": "for_operation_example",
  "serial_no": "serial_no_example",
  "batch_no": "batch_no_example",
  "quality_inspection_template": "quality_inspection_template_example",
  "workstation_type": "workstation_type_example",
  "expected_start_date": "2024-01-15",
  "expected_end_date": "2024-01-15",
  "serial_and_batch_bundle": "serial_and_batch_bundle_example",
  "process_loss_qty": 0,
  "time_required": 0,
  "actual_start_date": "2024-01-15",
  "actual_end_date": "2024-01-15",
  "finished_good": "finished_good_example",
  "target_warehouse": "target_warehouse_example",
  "operation_row_id": 0,
  "source_warehouse": "source_warehouse_example",
  "semi_fg_bom": "semi_fg_bom_example",
  "is_subcontracted": false,
  "manufactured_qty": 0,
  "skip_material_transfer": false,
  "backflush_from_wip_warehouse": false,
  "is_paused": false,
  "track_semi_finished_goods": false
}
POST /api/manufacturing/job-card/{id}/cancel

Cancel a job card

Cancels a submitted job card, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the job card to act on.

Returns

Returns the job card object with updated status.

POST /api/manufacturing/job-card/{id}/cancel 
curl https://api.overplane.dev/api/manufacturing/job-card/job-card_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "job-card_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "work_order": "work_order_example",
  "bom_no": "bom_no_example",
  "workstation": "workstation_example",
  "operation": "operation_example",
  "posting_date": "2024-01-15",
  "company": "Example Corp",
  "for_quantity": 0,
  "wip_warehouse": "wip_warehouse_example",
  "total_completed_qty": 0,
  "total_time_in_mins": 0,
  "operation_id": "operation_id_example",
  "transferred_qty": 0,
  "requested_qty": 0,
  "project": "project_example",
  "remarks": "remarks_example",
  "production_item": "production_item_example",
  "barcode": "barcode_example",
  "item_name": "item_name_example",
  "operation_row_number": "operation_row_number_example",
  "sequence_id": 0,
  "quality_inspection": "quality_inspection_example",
  "hour_rate": 0,
  "is_corrective_job_card": false,
  "for_job_card": "for_job_card_example",
  "for_operation": "for_operation_example",
  "serial_no": "serial_no_example",
  "batch_no": "batch_no_example",
  "quality_inspection_template": "quality_inspection_template_example",
  "workstation_type": "workstation_type_example",
  "expected_start_date": "2024-01-15",
  "expected_end_date": "2024-01-15",
  "serial_and_batch_bundle": "serial_and_batch_bundle_example",
  "process_loss_qty": 0,
  "time_required": 0,
  "actual_start_date": "2024-01-15",
  "actual_end_date": "2024-01-15",
  "finished_good": "finished_good_example",
  "target_warehouse": "target_warehouse_example",
  "operation_row_id": 0,
  "source_warehouse": "source_warehouse_example",
  "semi_fg_bom": "semi_fg_bom_example",
  "is_subcontracted": false,
  "manufactured_qty": 0,
  "skip_material_transfer": false,
  "backflush_from_wip_warehouse": false,
  "is_paused": false,
  "track_semi_finished_goods": false
}

Line items

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

Job Card Item

Attributes

idx integer
job_card_id string required
item_code string
source_warehouse string
uom string
item_name string
description string
required_qty number
allow_alternative_item boolean
item_group string
stock_uom string
transferred_qty number
consumed_qty number

Endpoints

GET /api/manufacturing/job-card-item?parent_id={id}
POST /api/manufacturing/job-card-item
PATCH /api/manufacturing/job-card-item/{id}
DELETE /api/manufacturing/job-card-item/{id}
POST /api/manufacturing/job-card-item/reorder
Job Card Item object 
{
  "id": "job-card-item_abc123",
  "idx": 1,
  "job_card_id": "job_card_id_example",
  "item_code": "item_code_example",
  "source_warehouse": "source_warehouse_example",
  "uom": "uom_example",
  "item_name": "item_name_example",
  "description": "description_example",
  "required_qty": 0,
  "allow_alternative_item": false,
  "item_group": "item_group_example",
  "stock_uom": "stock_uom_example",
  "transferred_qty": 0,
  "consumed_qty": 0
}

Job Card Operation

Attributes

idx integer
job_card_id string required
status string
completed_time string
sub_operation string
completed_qty number

Endpoints

GET /api/manufacturing/job-card-operation?parent_id={id}
POST /api/manufacturing/job-card-operation
PATCH /api/manufacturing/job-card-operation/{id}
DELETE /api/manufacturing/job-card-operation/{id}
POST /api/manufacturing/job-card-operation/reorder
Job Card Operation object 
{
  "id": "job-card-operation_abc123",
  "idx": 1,
  "job_card_id": "job_card_id_example",
  "status": "Pending",
  "completed_time": "completed_time_example",
  "sub_operation": "sub_operation_example",
  "completed_qty": 0
}

Job Card Scheduled Time

Attributes

idx integer
job_card_id string required
from_time string
to_time string
time_in_mins number

Endpoints

GET /api/manufacturing/job-card-scheduled-time?parent_id={id}
POST /api/manufacturing/job-card-scheduled-time
PATCH /api/manufacturing/job-card-scheduled-time/{id}
DELETE /api/manufacturing/job-card-scheduled-time/{id}
POST /api/manufacturing/job-card-scheduled-time/reorder
Job Card Scheduled Time object 
{
  "id": "job-card-scheduled-time_abc123",
  "idx": 1,
  "job_card_id": "job_card_id_example",
  "from_time": "from_time_example",
  "to_time": "to_time_example",
  "time_in_mins": 0
}

Job Card Secondary Item

Attributes

idx integer
job_card_id string required
item_code string required
item_name string
description string
stock_qty number required
stock_uom string
type string required
bom_secondary_item string

Endpoints

GET /api/manufacturing/job-card-secondary-item?parent_id={id}
POST /api/manufacturing/job-card-secondary-item
PATCH /api/manufacturing/job-card-secondary-item/{id}
DELETE /api/manufacturing/job-card-secondary-item/{id}
POST /api/manufacturing/job-card-secondary-item/reorder
Job Card Secondary Item object 
{
  "id": "job-card-secondary-item_abc123",
  "idx": 1,
  "job_card_id": "job_card_id_example",
  "item_code": "item_code_example",
  "item_name": "item_name_example",
  "description": "description_example",
  "stock_qty": 0,
  "stock_uom": "stock_uom_example",
  "type": "type_example",
  "bom_secondary_item": "bom_secondary_item_example"
}