Example : Sample payload for Use Case Management APIs
This is an example of a sample payload used for User Case Management APIs
Get Template For Case Type
Endpoint:
Get/api/v1/rpa/exception/{casetype}/tempate
Content-Type:application/json
{
"name": "InvoiceProcessing",
"erp": "Test_Usecase_list_label",
"categories": [
{
"key": "MISSINGINFORMATION",
"value": "Missing Information",
"list_labels": [
{
"key": "INVOICE_NUMBER",
"value": "Invoice Number"
},
{
"key": "PO_NUMBER",
"value": "Po Number"
},
{
"key": "INVOICE_DATE",
"value": "Invoice Date"
},
{
"key": "LAST_RUN_TIME",
"value": "last Run Time"
}
]
},
{
"key": "NEEDSVERIFICATION",
"value": "Needs Verification",
"list_labels": [
{
"key": "INVOICE_NUMBER",
"value": "Invoice Number"
},
{
"key": "PO_NUMBER",
"value": "Po Number"
}
]
},
{
"key": "PENDINGPROCESS",
"value": "Pending Process",
"list_labels": [
{
"key": "INVOICE_NUMBER",
"value": "Invoice Number"
},
{
"key": "PO_NUMBER",
"value": "Po Number"
},
{
"key": "INVOICE_DATE",
"value": "Invoice Date"
}
]
}
],
"subcategories": [
{
"key": "HEADERS",
"value": "Headers",
"type": "standard",
"associations": [
"INVOICE_NUMBER",
"INVOICE_TYPE",
"COMMENTS",
"PO_NUMBER",
"INVOICE_DATE",
"TOTAL",
"TAX",
"VENDOR_ID",
"SHIPPING_HANDLING_CHARGE",
"DISCOUNT",
"VENDOR_NAME"
]
},
{
"key": "VALID_LINES",
"value": "Valid Lines",
"type": "table",
"associations": [
"valid_lines"
]
},
{
"key": "INVALID_LINES",
"value": "Invalid Lines",
"type": "table",
"associations": [
"invalid_lines"
]
}
],
"filters": [
{
"key": "DIVISION",
"type": "Document",
"display_name": "Division",
"data_type": "string"
},
{
"key": "TOTAL_AMOUNT",
"type": "Document",
"display_name": "Total Amount",
"data_type": "string"
},
{
"key": "INVOICE_NUMBER",
"type": "Document",
"display_name": "Invoice Number",
"data_type": "string"
},
{
"key": "INVOICE_DATE",
"type": "Document",
"display_name": "Invoice Date",
"data_type": "date"
},
{
"key": "LAST_RUN_TIME",
"type": "Document",
"display_name": "Last Run Time",
"data_type": "date -> {accepts both date and datetime to store in the server}"
},
{
"key": "VENDOR_ID",
"type": "Document",
"display_name": "VENDOR_ID",
"data_type": "string"
}
],
"exception_type": "document",
"default_category": "MISSINGINFORMATION",
"list_labels": [
{
"key": "INVOICE_NUMBER",
"value": "Invoice Number"
},
{
"key": "PO_NUMBER",
"value": "Po Number"
},
{
"key": "INVOICE_DATE",
"value": "Invoice Date"
},
{
"key": "LAST_RUN_TIME",
"value": "last Run Time"
}
],
"document_entities": [
{
"value": "Invoice Number",
"key": "INVOICE_NUMBER",
"required": true,
"disabled": false,
"field_type": "string",
"min_length": 1,
"max_length": 10,
"category_associations": [
{
"key": "MISSINGINFORMATION",
"disabled": true,
"required": true
},
{
"key": "NEEDSVERIFICATION",
"disabled": true,
"required": true
},
{
"key": "PENDINGPROCESS",
"disabled": false,
"required": false
},
{
"key": "OTHERS",
"disabled": false,
"required": false
}
],
"control_dropdown": false,
"default_dropdown": null,
"dropdown_controls": null,
"lookup_enabled": false,
"lookup_metadata": null
},
{
"value": "Invoice Type",
"key": "INVOICE_TYPE",
"required": false,
"disabled": true,
"field_type": "dropdown",
"min_length": 1,
"max_length": 10,
"category_associations": [
{
"key": "NEEDSVERIFICATION",
"disabled": false,
"required": true
}
],
"control_dropdown": true,
"default_dropdown": "POINVOICE",
"dropdown_controls": [
{
"key": "PO_INVOICE",
"value": "PO INVOICE",
"control_fields": [
{
"required": false,
"disabled": false,
"label_key": "COMMENTS"
},
{
"required": true,
"disabled": false,
"label_key": "PO_NUMBER"
},
{
"required": false,
"disabled": false,
"label_key": "VENDOR_ID"
}
]
},
{
"key": "EXPENSE_WITH_PO",
"value": "EXPENSE WITH PO",
"control_fields": [
{
"required": true,
"disabled": false,
"label_key": "COMMENTS"
},
{
"required": true,
"disabled": false,
"label_key": "PO_NUMBER"
},
{
"required": false,
"disabled": false,
"label_key": "VENDOR_ID"
}
]
},
{
"key": "EXPENSE_WITHOUT_PO",
"value": "EXPENSE WITHOUT PO",
"control_fields": [
{
"required": true,
"disabled": false,
"label_key": "COMMENTS"
},
{
"required": false,
"disabled": false,
"label_key": "PO_NUMBER"
},
{
"required": true,
"disabled": false,
"label_key": "VENDOR_ID"
}
]
},
{
"key": "DELIVERYNOTENUMBER",
"value": "DELIVERY NOTE NUMBER",
"control_fields": [
{
"required": false,
"disabled": false,
"label_key": "COMMENTS"
},
{
"required": true,
"disabled": false,
"label_key": "PO_NUMBER"
},
{
"required": false,
"disabled": false,
"label_key": "VENDOR_ID"
}
]
}
],
"lookup_enabled": false,
"lookup_metadata": null
},
{
"value": "PO Number",
"key": "PO_NUMBER",
"required": true,
"disabled": false,
"field_type": "string",
"min_length": 1,
"max_length": 10,
"category_associations": [
{
"key": "MISSINGINFORMATION",
"disabled": false,
"required": false
},
{
"key": "NEEDSVERIFICATION",
"disabled": false,
"required": true
},
{
"key": "PENDINGPROCESS",
"disabled": false,
"required": false
},
{
"key": "OTHERS",
"disabled": true,
"required": false
}
],
"control_dropdown": false,
"default_dropdown": null,
"dropdown_controls": null,
"lookup_enabled": true,
"lookup_metadata": {
"attributes": [
"VENDOR_NAME",
"VENDOR_ADDRESS",
"VENDOR_PHONE"
],
"message": "M3_InvoiceProcessing_Vendor_ID"
}
},
{
"value": "Invoice Date",
"key": "INVOICE_DATE",
"required": true,
"disabled": false,
"field_type": "date",
"min_length": 1,
"max_length": 10,
"category_associations": [
{
"key": "MISSINGINFORMATION",
"disabled": false,
"required": true
},
{
"key": "NEEDSVERIFICATION",
"disabled": false,
"required": true
},
{
"key": "PENDINGPROCESS",
"disabled": false,
"required": false
},
{
"key": "OTHERS",
"disabled": false,
"required": false
}
],
"control_dropdown": false,
"default_dropdown": null,
"dropdown_controls": null,
"lookup_enabled": false,
"lookup_metadata": null
},
{
"value": "Vendor ID",
"key": "VENDOR_ID",
"required": true,
"disabled": false,
"field_type": "string",
"min_length": 1,
"max_length": 10,
"category_associations": [
{
"key": "MISSINGINFORMATION",
"disabled": false,
"required": true
},
{
"key": "NEEDSVERIFICATION",
"disabled": false,
"required": false
},
{
"key": "PENDINGPROCESS",
"disabled": false,
"required": false
},
{
"key": "OTHERS",
"disabled": true,
"required": false
}
],
"control_dropdown": false,
"default_dropdown": null,
"dropdown_controls": null,
"lookup_enabled": true,
"lookup_metadata": {
"attributes": [
"Vendor_Name",
"Vendor_Address",
"Vendor_Phone"
],
"message": "M3_InvoiceProcessing_Vendor_ID"
}
},
{
"value": "Total",
"key": "TOTAL",
"required": true,
"disabled": false,
"field_type": "decimal",
"min_length": 1,
"max_length": 10,
"category_associations": [
{
"key": "MISSINGINFORMATION",
"disabled": false,
"required": true
},
{
"key": "NEEDSVERIFICATION",
"disabled": false,
"required": true
},
{
"key": "PENDINGPROCESS",
"disabled": false,
"required": false
},
{
"key": "OTHERS",
"disabled": true,
"required": false
}
],
"control_dropdown": false,
"default_dropdown": null,
"dropdown_controls": null,
"lookup_enabled": false,
"lookup_metadata": null
},
{
"value": "Discount",
"key": "DISCOUNT",
"required": false,
"disabled": false,
"field_type": "decimal",
"min_length": 1,
"max_length": 10,
"category_associations": [
{
"key": "MISSINGINFORMATION",
"disabled": false,
"required": false
},
{
"key": "NEEDSVERIFICATION",
"disabled": false,
"required": true
},
{
"key": "PENDINGPROCESS",
"disabled": false,
"required": false
},
{
"key": "OTHERS",
"disabled": true,
"required": false
}
],
"control_dropdown": false,
"default_dropdown": null,
"dropdown_controls": null,
"lookup_enabled": false,
"lookup_metadata": null
},
{
"value": "Shipping Handling Charge",
"key": "SHIPPING_HANDLING_CHARGE",
"required": false,
"disabled": false,
"field_type": "decimal",
"min_length": 1,
"max_length": 10,
"category_associations": [
{
"key": "MISSINGINFORMATION",
"disabled": false,
"required": false
},
{
"key": "NEEDSVERIFICATION",
"disabled": false,
"required": true
},
{
"key": "PENDINGPROCESS",
"disabled": false,
"required": false
},
{
"key": "OTHERS",
"disabled": true,
"required": false
}
],
"control_dropdown": false,
"default_dropdown": null,
"dropdown_controls": null,
"lookup_enabled": false,
"lookup_metadata": null
},
{
"value": "Tax",
"key": "TAX",
"required": false,
"disabled": false,
"field_type": "decimal",
"min_length": 1,
"max_length": 10,
"category_associations": [
{
"key": "MISSINGINFORMATION",
"disabled": false,
"required": false
},
{
"key": "NEEDSVERIFICATION",
"disabled": false,
"required": false
},
{
"key": "PENDINGPROCESS",
"disabled": false,
"required": false
},
{
"key": "OTHERS",
"disabled": true,
"required": false
}
],
"control_dropdown": false,
"default_dropdown": null,
"dropdown_controls": null,
"lookup_enabled": false,
"lookup_metadata": null
},
{
"value": "Vendor Name",
"key": "VENDOR_NAME",
"required": false,
"disabled": false,
"field_type": "string",
"min_length": 1,
"max_length": 10,
"category_associations": [
{
"key": "MISSINGINFORMATION",
"disabled": false,
"required": false
},
{
"key": "NEEDSVERIFICATION",
"disabled": false,
"required": false
},
{
"key": "PENDINGPROCESS",
"disabled": false,
"required": false
},
{
"key": "OTHERS",
"disabled": true,
"required": false
}
],
"control_dropdown": false,
"default_dropdown": null,
"dropdown_controls": null,
"lookup_enabled": false,
"lookup_metadata": null
},
{
"value": "Comments",
"key": "COMMENTS",
"required": false,
"disabled": false,
"field_type": "string",
"min_length": 1,
"max_length": 10,
"category_associations": [
{
"key": "MISSINGINFORMATION",
"disabled": false,
"required": false
},
{
"key": "NEEDSVERIFICATION",
"disabled": false,
"required": false
},
{
"key": "PENDINGPROCESS",
"disabled": false,
"required": false
},
{
"key": "OTHERS",
"disabled": true,
"required": false
}
],
"control_dropdown": false,
"default_dropdown": null,
"dropdown_controls": null,
"lookup_enabled": false,
"lookup_metadata": null
},
{
"value": "Division",
"key": "DIVISION",
"required": false,
"disabled": true,
"field_type": "string",
"min_length": 1,
"max_length": 10,
"category_associations": null,
"control_dropdown": false,
"default_dropdown": null,
"dropdown_controls": null,
"lookup_enabled": false,
"lookup_metadata": null
}
],
"table_definitions": [
{
"name": "valid_lines",
"column_definitions": [
{
"key": "ITEMCODE",
"display": "Item Code",
"type": "string",
"min_length": 1,
"max_length": 10,
"category_associations": null
},
{
"key": "DESCRIPTION",
"display": "Description",
"type": "string",
"min_length": 1,
"max_length": 10,
"category_associations": null
},
{
"key": "QUANTITY",
"display": "Quantity",
"type": "number",
"min_length": 1,
"max_length": 10,
"category_associations": null
},
{
"key": "UNITPRICE",
"display": "Unit Price",
"type": "decimal",
"min_length": 1,
"max_length": 10,
"category_associations": null
},
{
"key": "AMOUNT",
"display": "Amount",
"type": "decimal",
"min_length": 1,
"max_length": 10,
"category_associations": null
},
{
"key": "STATUS",
"display": "Status",
"type": "string",
"min_length": 1,
"max_length": 10,
"category_associations": null
}
]
},
{
"name": "invalid_lines",
"column_definitions": [
{
"key": "ITEMCODE",
"display": "Item Code",
"type": "string",
"min_length": 1,
"max_length": 10,
"category_associations": null
},
{
"key": "DESCRIPTION",
"display": "Description",
"type": "string",
"min_length": 1,
"max_length": 10,
"category_associations": null
},
{
"key": "QUANTITY",
"display": "Quantity",
"type": "number",
"min_length": 1,
"max_length": 10,
"category_associations": null
},
{
"key": "UNITPRICE",
"display": "Unit Price",
"type": "decimal",
"min_length": 1,
"max_length": 10,
"category_associations": null
},
{
"key": "AMOUNT",
"display": "Amount",
"type": "decimal",
"min_length": 1,
"max_length": 10,
"category_associations": null
},
{
"key": "STATUS",
"display": "Status",
"type": "string",
"min_length": 1,
"max_length": 10,
"category_associations": null
}
]
},
{
"name": "vat_lines",
"column_definitions": [
{
"key": "AMOUNT",
"display": "Amount",
"type": "decimal",
"min_length": 1,
"max_length": 10,
"category_associations": null
},
{
"key": "DESCRIPTION",
"display": "Description",
"type": "string",
"min_length": 1,
"max_length": 10,
"category_associations": null
},
{
"key": "VATAMOUNT",
"display": "Vat Amount",
"type": "decimal",
"min_length": 1,
"max_length": 10,
"category_associations": null
},
{
"key": "VATRATE",
"display": "Vat Rate",
"type": "decimal",
"min_length": 1,
"max_length": 10,
"category_associations": null
}
]
}
]
}