> ## Documentation Index > Fetch the complete documentation index at: https://developers.cmicglobal.com/llms.txt > Use this file to discover all available pages before exploring further. # Create AP Manual Check With Extension > ## Create Manual Cheque with Extension ### ## OpenAPI ````json POST /ap-rest-api/rest/1/manualcheck { "openapi": "3.0.0", "info": { "title": "API Catalog", "description": "", "version": "1.0.0" }, "servers": [ { "url": "https://mobtest.cmiccloudr12.com/cmictestrti", "description": "CMIC API Server" } ], "security": [ { "cmicBasicAuth": [] } ], "tags": [ { "name": "Highlights" }, { "name": "Asset Management | Equipment" }, { "name": "Asset Management | Fixed Assets" }, { "name": "Asset Management | Purchase Order" }, { "name": "Asset Management | Inventory" }, { "name": "Asset Management | Requisition" }, { "name": "Asset Management | Purchase Change Order" }, { "name": "Bim Model" }, { "name": "Bim Model Revision" }, { "name": "Bim Tag Model" }, { "name": "Bim Tags" }, { "name": "Bim FileUpload Jersey" }, { "name": "Core System | Business Partners" }, { "name": "Core System | Business Partner Addresses" }, { "name": "Core System | Bank" }, { "name": "Core System | Currency" }, { "name": "Core System | Exchange Rates" }, { "name": "Core System | Global Table Text Codes" }, { "name": "Core System | Global Table Regions" }, { "name": "Core System | Terms" }, { "name": "Core System | System Contact" }, { "name": "Core System | Weight Measures" }, { "name": "Core System | Field User Defined Classifiers" }, { "name": "Core System | User Defined Classifiers by Object" }, { "name": "Core System | User Extension Definitions by Object" }, { "name": "Core System | User Extention Field Data Value" }, { "name": "Core System | User Extension Values by Object" }, { "name": "Core System | User System Role" }, { "name": "Core System | User Project Role" }, { "name": "Core System | Documents by Object" }, { "name": "Core System | Audit Status Log by Object" }, { "name": "Core System | Licensed Users" }, { "name": "Core System | Company Access" }, { "name": "Core System | Copy User Settings" }, { "name": "Core System | User Maintenance" }, { "name": "Core System | User Roles" }, { "name": "Core System | Security Groups" }, { "name": "Core System | Job/Project Security" }, { "name": "Core System | Weight Measure with Conversions Code" }, { "name": "Core System | Weight Measure Conversions Code" }, { "name": "Core System | User-defined-fields" }, { "name": "Core System | User-extension" }, { "name": "ECM and Workflow | Image Manager" }, { "name": "Financials | General Ledger" }, { "name": "Financials | Accounts Payable" }, { "name": "Financials | Accounts Receivable" }, { "name": "Preventative Maintenance | Issue Work Orders" }, { "name": "Preventative Maintenance | Issue Work Items" }, { "name": "Preventative Maintenance | Issue Work Budgets" }, { "name": "Preventative Maintenance | Issue Priorities" }, { "name": "Preventative Maintenance | Issue Status" }, { "name": "Preventative Maintenance | Issue Types" }, { "name": "Preventative Maintenance | Accumulative Equipment" }, { "name": "Preventative Maintenance | Work Orders" }, { "name": "Preventative Maintenance | Work Items" }, { "name": "Preventative Maintenance | Work Budgets" }, { "name": "Preventative Maintenance | Priorities" }, { "name": "Preventative Maintenance | Tasks" }, { "name": "HCM | UKG Pay Deductions" }, { "name": "HCM | UKG Pay Earnings" }, { "name": "HCM | UKG Pay Headers" }, { "name": "HCM | UKG Pay Taxes" }, { "name": "HCM | Payroll Geographical States" }, { "name": "HCM | Payroll Trades" }, { "name": "HCM | Payroll Union" }, { "name": "HCM | Payroll Pay Runs" }, { "name": "HCM | Payroll Pay Groups" }, { "name": "HCM | Payroll Tax" }, { "name": "HCM | Payroll Worker Compensation" }, { "name": "HCM | Payroll Work Locations" }, { "name": "HCM | Payroll Trade Pay Rates" }, { "name": "HCM | Payroll Union Pay Rates" }, { "name": "HCM | Payroll Job Pay Rates" }, { "name": "HCM | Payroll Master Benefits" }, { "name": "HCM | Payroll Master Deductions" }, { "name": "HCM | Payroll Ben/Ded/Leave Base Codes" }, { "name": "HCM | Payroll Ben/Ded Plans" }, { "name": "HCM | Payroll Ben/Ded Plan Options" }, { "name": "HCM | Payroll Company Benefits" }, { "name": "HCM | Payroll Company Deductions" }, { "name": "HCM | Payroll Vertex Geographic Locations" }, { "name": "HCM | Payroll Checks" }, { "name": "HCM | Payroll Timesheets" }, { "name": "HCM | Employee" }, { "name": "HCM | Employee (Minimum payload)" }, { "name": "HCM | Employee History" }, { "name": "HCM | Tax Exemptions" }, { "name": "HCM | Employee Tax Overrides" }, { "name": "HCM | Employee Pay Splits" }, { "name": "HCM | Employee Benefits" }, { "name": "HCM | Employee Clock In and Out" }, { "name": "HCM | Employee Deductions" }, { "name": "HCM | Employee Leaves" }, { "name": "HCM | Employee Leave History" }, { "name": "HCM | Employee Hour Types" }, { "name": "HCM | Employee Pay History" }, { "name": "HCM | Employee Work Statuses" }, { "name": "HCM | Employee Security Group" }, { "name": "HCM | Crewtime Crew" }, { "name": "HCM | Crewtime Employee Timesheet" }, { "name": "HCM | Crewtime Equipment Timesheet" }, { "name": "HCM | Crew Maintenance Activity Assignment" }, { "name": "HCM | Crew Maintenance Member Assignment" }, { "name": "HCM | Crew Maintenance Member Trade and Union Assignment" }, { "name": "HCM | Crew Maintenance Equipment Assignment" }, { "name": "HCM | Crew Maintenance Equipment Detail Assignment" }, { "name": "HCM | HR Requisitions" }, { "name": "HCM | HR Relations" }, { "name": "HCM | HR Employee Skills" }, { "name": "HCM | HR Incident" }, { "name": "HCM | HR Employee Relatives / Dependents" }, { "name": "HCM | HR Employee Positions" }, { "name": "HCM | HR Applicants" }, { "name": "HCM | HR Applications" }, { "name": "HCM | Vertex Location City" }, { "name": "HCM | HR Application History" }, { "name": "HCM | HR Dependent Benefits" }, { "name": "HCM | HR Dependent Deductions" }, { "name": "HCM | HR Employee Elected Plans" }, { "name": "HCM | HR Employee Training Certifications" }, { "name": "HCM | HR Trainings" }, { "name": "HCM | E-Timesheets" }, { "name": "HCM | System Contacts" }, { "name": "HCM | System User Payroll Security Group" }, { "name": "HCM | Payroll Timesheet Posting" }, { "name": "HCM | CrewTimesheet Posting" }, { "name": "HCM | HR Positions Master" }, { "name": "HCM | Payroll Pay Periods" }, { "name": "HCM | Payroll Rate Codes" }, { "name": "HCM | Payroll Overhead Codes and Rates" }, { "name": "HCM | Payroll Assigned Overhead to Jobs" }, { "name": "Materials Management | Material Sale Orders" }, { "name": "Materials Management | Material Sale Orders Details" }, { "name": "Materials Management | Truck Rate Detail" }, { "name": "Opportunity Management | Competitors" }, { "name": "Opportunity Management | Opportunities" }, { "name": "Opportunity Management | Revenue Details" }, { "name": "Opportunity Management | Opportunity History" }, { "name": "Opportunity Management | Organization" }, { "name": "Project Controls | Job Billing" }, { "name": "Project Controls | Job Cost" }, { "name": "Project Controls | PCI Details" }, { "name": "Project Controls | Unposted PCI Details" }, { "name": "Project Controls | PCI Headers" }, { "name": "Project Controls | Owner Change Orders" }, { "name": "Project Controls | CM Statuses" }, { "name": "Project Controls | CM Types" }, { "name": "Project Controls | CM Vendor Details" }, { "name": "Project Controls | Post PCI" }, { "name": "Project Management | Uploading Documents" }, { "name": "Project Management | Downloading Documents" }, { "name": "Project Management | Foreign Bid Item Imports" }, { "name": "Project Management | Communications" }, { "name": "Project Management | Daily Journals" }, { "name": "Project Management | Communications Types" }, { "name": "Project Management | Daily Journal Daily Work Plans" }, { "name": "Project Management | Daily Journal Field Forces" }, { "name": "Project Management | Daily Journal Labour" }, { "name": "Project Management | Daily Journal Materials" }, { "name": "Project Management | Daily Journal Owner Equipment" }, { "name": "Project Management | Daily Journal Quality Control" }, { "name": "Project Management | Daily Journal Tasks" }, { "name": "Project Management | Daily Journal Trade Equipment" }, { "name": "Project Management | Daily Journal Transactions" }, { "name": "Project Management | Daily Journal User Defined Data" }, { "name": "Project Management | Daily Journal Visitors" }, { "name": "Project Management | Daily Journal Bill Details" }, { "name": "Project Management | Field Work Directives" }, { "name": "Project Management | Contract Types" }, { "name": "Project Management | Company Contacts" }, { "name": "Project Management | Distribution BCC" }, { "name": "Project Management | Distribution CC" }, { "name": "Project Management | Field Work Directive Statuses" }, { "name": "Project Management | Issues" }, { "name": "Project Management | Key Players" }, { "name": "Project Management | Meetings" }, { "name": "Project Management | Meeting Attendees" }, { "name": "Project Management | Meeting Item Statuses" }, { "name": "Project Management | Meeting Tracks" }, { "name": "Project Management | Notes" }, { "name": "Project Management | Projects" }, { "name": "Project Management | Project Items" }, { "name": "Project Management | Project Item Phase Segment Sums" }, { "name": "Project Management | Project Partners" }, { "name": "Project Management | Notices" }, { "name": "Project Management | Notice Statuses" }, { "name": "Project Management | Owner JS Query" }, { "name": "Project Management | PCI Real Locations" }, { "name": "Project Management | Project Contacts" }, { "name": "Project Management | RFIs (Requests for Information)" }, { "name": "Project Management | RFI Statuses" }, { "name": "Project Management | Submittal Packages" }, { "name": "Project Management | Submittal Package Details" }, { "name": "Project Management | Submittal Package Status" }, { "name": "Project Management | Submittals" }, { "name": "Project Management | Submittal Status" }, { "name": "Project Management | Transmittals" }, { "name": "Project Management | Subcontract Headers" }, { "name": "Project Management | Subcontract Schedules" }, { "name": "Project Management | Subcontract Sechedule Phase Segment Sums" }, { "name": "Project Management | User Roles" }, { "name": "Project Management | Punchlists" }, { "name": "Project Management | Punchlist Details" }, { "name": "Project Management | Punchlist Statuses" }, { "name": "Project Management | Meeting Items" }, { "name": "Project Management | Self Perform Vendor" }, { "name": "Project Management | Submittal Types" }, { "name": "Project Management | Assign contact and partner to project" }, { "name": "Project Management | Subcontract Prequal" }, { "name": "Project Management | Bid Item Package" } ], "paths": { "/ap-rest-api/rest/1/manualcheck": { "post": { "tags": [ "Financials | Accounts Payable" ], "summary": "Create AP Manual Check With Extension", "description": "## Create Manual Cheque with Extension\n\n###", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ChqAccCode": { "type": "string", "description": "This is the GL Account Code for the bank account the check was paid from. This must be a VALID CMiC Account Code." }, "ChqVouCode": { "type": "string", "maxLength": 1, "description": "This field indicates that the check paid a voucher rather than being a Non Accounts Payable Check. Set the field to 'Y' to indicate the check paid a voucher." }, "ChqBankCompCode": { "type": "string", "maxLength": 8, "description": "This is the company code of the bank account the check was paid out of." }, "ChqRecCode": { "type": "string", "maxLength": 1, "description": "Code to indicate if Reconciled date is null or not" }, "ChqDate": { "type": "string", "description": "This is the date of the check." }, "ChqVenCode": { "type": "string", "description": "This is the vendor code of the vendor the check was produced for. This must be a VALID CMiC Vendor Code." }, "PayamtChqmanViewObj": { "type": "string", "description": "" }, "ChqPostDate": { "type": "string", "description": "This is the post date of the check. This should be the same date as the post date on the check." }, "ChqBchPost": { "type": "string", "description": "" }, "ChqDesc": { "type": "string", "maxLength": 60, "description": "This is only applicable if the check was a manual check and a unique description is available for the check." }, "ChqBchName": { "type": "string", "description": "" }, "ChqDeptCode": { "type": "string", "description": "This is department of the GL Bank Account that the check was paid out of. This must be a VALID CMiC department code for the company in CHQ_COMP_CODE." }, "ChqNum": { "type": "number", "maxLength": 2211, "description": "Check Number" }, "ChqCompCode": { "type": "string", "maxLength": 8, "description": "This is the company code that prepared the check. This must be a VALID CMiC Company Code." }, "ChqSeqNum": { "type": "string", "description": "This is an internal check number created by the system. Start numbering at –50000 and increment by 1 for each record. (i.e. –50000, -49999, -49998….) It must be unique across all checks." }, "ChqAmt": { "type": "string", "description": "This is the full amount of the check." } }, "required": [ "ChqAccCode", "ChqDate", "ChqVenCode", "ChqDeptCode", "ChqSeqNum", "ChqAmt" ], "example": { "ChqAccCode": "10001", "ChqAmt": "3000", "ChqBankCompCode": "001", "ChqBchName": "TEST", "ChqBchPost": "N", "ChqPostDate": null, "ChqCompCode": "001", "ChqDate": "2023-06-23", "ChqDeptCode": "00", "ChqDesc": null, "ChqNum": "5201100", "ChqRecCode": "N", "ChqSeqNum": "1453", "ChqVenCode": "0714", "ChqVouCode": "Y", "PayamtChqmanViewObj": [ { "PaCompCode": "001", "PaChqCompCode": "001", "PaVenCode": "0714", "PaChqNum": "5201100", "PaPayCurrAmt": "3000", "PaAmt": "3000", "PaVouInvCode": "LTEST1234", "PaDiscAmt": "-200", "PaChqSeqNum": "1453" } ] } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/vnd.oracle.adf.resourceItem+json" } ], "responses": { "201": { "description": "Created", "headers": { "Content-Type": { "schema": { "type": "string", "example": "application/vnd.oracle.adf.resourceitem+json" } } }, "content": { "application/json": { "schema": { "type": "object" }, "examples": { "example-0": { "summary": "Successful Response", "value": { "Chq1099Code": "X", "ChqAccCode": "10001", "ChqAmt": 3000, "ChqBankCompCode": "001", "ChqBchName": "TEST", "ChqBchNum": 4461781, "ChqBchPost": "N", "ChqCompCode": "001", "ChqCurrCode": "USD", "ChqCurcFactorNum": 1, "ChqDate": "2023-06-23", "ChqDeptCode": "00", "ChqDesc": null, "ChqDraftCode": null, "ChqJobCode": null, "ChqJointVenName": null, "ChqNum": 5201101, "ChqPayeeAddr1": null, "ChqPayeeAddr2": null, "ChqPayeeAddr3": null, "ChqPayeeCountry": null, "ChqPayeeName1": null, "ChqPayeeName2": null, "ChqPayeePostalCode": null, "ChqPayeeRegCode": null, "ChqPostDate": null, "ChqRecCode": "N", "ChqSeqNum": 1829278, "ChqTempBchNum": 4461781, "ChqVenCode": "0714", "ChqVouCode": "Y", "ChqRefundFlag": "N", "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/manualcheck/1829278", "name": "manualcheck", "kind": "item" }, { "rel": "canonical", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/manualcheck/1829278", "name": "manualcheck", "kind": "item" }, { "rel": "child", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/manualcheck/1829278/child/VouChqViewObj", "name": "VouChqViewObj", "kind": "collection" }, { "rel": "child", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/manualcheck/1829278/child/PayamtChqmanViewObj", "name": "PayamtChqmanViewObj", "kind": "collection" } ] } }, "example-1": { "summary": "Successful Response", "value": { "Chq1099Code": "X", "ChqAccCode": "10001", "ChqAmt": 3000, "ChqBankCompCode": "001", "ChqBchName": "TEST", "ChqBchNum": 4461781, "ChqBchPost": "N", "ChqCompCode": "001", "ChqCurrCode": "USD", "ChqCurcFactorNum": 1, "ChqDate": "2023-06-23", "ChqDeptCode": "00", "ChqDesc": null, "ChqDraftCode": null, "ChqJobCode": null, "ChqJointVenName": null, "ChqNum": 5201101, "ChqPayeeAddr1": null, "ChqPayeeAddr2": null, "ChqPayeeAddr3": null, "ChqPayeeCountry": null, "ChqPayeeName1": null, "ChqPayeeName2": null, "ChqPayeePostalCode": null, "ChqPayeeRegCode": null, "ChqPostDate": null, "ChqRecCode": "N", "ChqSeqNum": 1829278, "ChqTempBchNum": 4461781, "ChqVenCode": "0714", "ChqVouCode": "Y", "ChqRefundFlag": "N", "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/manualcheck/1829278", "name": "manualcheck", "kind": "item" }, { "rel": "canonical", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/manualcheck/1829278", "name": "manualcheck", "kind": "item" }, { "rel": "child", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/manualcheck/1829278/child/VouChqViewObj", "name": "VouChqViewObj", "kind": "collection" }, { "rel": "child", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/manualcheck/1829278/child/PayamtChqmanViewObj", "name": "PayamtChqmanViewObj", "kind": "collection" } ] } } } } } } } } } }, "components": { "securitySchemes": { "cmicBasicAuth": { "type": "http", "scheme": "basic", "description": "Basic authentication" } } } } ````