.png){kind=logo}
Create a New Registered Pay Request Imaging Document
- 15 Dec 2025
- 2 Minutes to read
- Print
- DarkLight
Create a New Registered Pay Request Imaging Document
- Updated on 15 Dec 2025
- 2 Minutes to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Post
/ecm-rest-api/jersey/v1/UploadData/UploadRegPayRequest
Overview
This endpoint provides the ability to upload a document along with flysheet data to create a Registered Pay Request with allocated detail lines.
Notes
- Endpoint name is /ecm-rest-api/jersey/v1/UploadData/uploadRegPayRequest
- srcUuid and docTypeUuid identify the corresponding source and document type to which the document will be uploaded
- Payload also contains a header section (headerFlysheet, headerData) and a detail section (detailFlysheet, detailData) to support the different flysheet data components to be inserted
- The pay request invoice is made against a subcontract (linked via the contract code field)
UI Navigation
Enterprise Content Management > Imaging > Flysheet
Reference Article
Pay Request – Create Subcontract Tied to Pay Request
Commonly Used Body Parameters
| CMiC UI Fieldname | Object | Name | Description | Type | Data Length | Example |
|---|---|---|---|---|---|---|
| Company | headerData | Apri_Comp_Code | This is the company code associated with the pay request invoice. Must be a valid CMiC Company Code. | string | 8 | 001 |
| Vendor | headerData | Apri_Ven_Code | This is the vendor code associated with the pay request invoice. Must be a valid vendor code in CMiC. | string | 10 | MICR01 |
| Invoice Job Code | headerData | Apri_Job_Code | This is the job code associated with the pay request invoice. Must be a valid job code in CMiC. | string | 10 | 017401 |
| Contract Code | headerData | Apri_Cont_Code | This is the contract code associated with the pay request invoice. Must be a valid contract code in CMiC. | string | 20 | ZZ-WMT001 |
| Invoice Registry Group Code | headerData | Apri_Group_Code | Invoice registration groups are used to group the access, entry and approval of invoices entered through the Register Invoices screen. Must be a valid Invoice Registry Group Code in CMiC. | string | 10 | CMIC |
| Invoice Number | headerData | Apri_Inv_Code | This is the invoice number associated with this invoice. This number appears on the vendors’ invoice and it is not the same as the voucher number. | string | 20 | TESTINV988 |
| Invoice Header Date | headerData | Apri_Inv_Date | This is the date the invoice was issued/created. | datetime | YYYY/MM/DD | 2025/03/31 |
| Description | headerData | Apri_Desc | This is a short description for the invoice. | string | 30 | Purchases from Home Depot. |
| Original Amount | headerData | Apri_Orig_Amt | Original invoice amount is the pre-tax invoice amount – this is used in the validation workflow. | number | 18 | 1825.00 |
| Amount | headerData | Apri_Inv_Amt | This invoice amount can be the same as the Original Invoice Amount if no taxes are applied. Otherwise, this is the post-tax invoice amount (net amount). | number | 18 | 1825.00 |
| Contract Detail Task Code | detailData | Aprdist_Task_Code | This is the task code assigned to the subcontract detail line which can be allocated against. | string | 16 | TASK1 |
| Contract Task Change Code | detailData | Aprdist_Chg_Code | This is the specific item quantity for the Purchase Order line item. | string | 20 | 001 |
| Detail Line Amount | detailData | Aprdist_Debit_Amt | This is the invoice amount allocated to the subcontract detail line. | number (with decimals) | 18,2 | 25.00 |
Security
HTTP
Type basic
Basic authentication
Header parameters
Content-Type
string
Exampleapplication/vnd.oracle.adf.resourceItem+json
Body parameters
object
fileDetails
string
Example{"srcUuid":"0AC3DE23133C61F0E063AF811DAC5CAD","docTypeUuid":"ADC78973BD901170E053508010AC2DB4","headerFlysheet":"Registered Pay Request Header","headerData":{"Apri_Comp_Code":"ZZ","Apri_Ven_Code":"G00001","Apri_Job_Code":"JOB-01-CTR","Apri_Cont_Code":"000000009","Apri_Group_Code":"CMIC","Apri_Inv_Code":"ROASTINV004","Apri_Inv_Date":"2025-03-29","Apri_Inv_Amt":"1","Apri_Orig_Amt":"1"},"detailFlysheet":"Registered - Pay Request Details","detailData":[{"Aprdist_Task_Code":"TASK1","Aprdist_Chg_Code":"000","Aprdist_Debit_Amt":"50"}]}
document-content-file
string (binary)
Responses
201
Successful response