Overview
This payload creates an AP Invoice with optional PO details and allocations. PO linkage (Po_Number and Release) is conditionally required based on the imaging system option flag imgso_allow_null_po_num_flag.
Notes
- The payload contains a header section (headerFlysheet, headerData) and a detail section (detailFlysheet, detailData).
- The srcUuid and docTypeUuid identify the source and document type.
- Whether
Po_Numberis required depends on the imaging system optionimgso_allow_null_po_num_flag:- If the flag is not set to
Y,Po_Numberis required. - If the flag is set to
Y,Po_Numbermay be omitted (PO-less invoice).
- If the flag is not set to
Releaseis required whenPo_Numberis not allowed to be null or whenPo_Numberis explicitly supplied in the payload. APo_Numbersupplied without aReleaseis always invalid.- When
Po_Numberis omitted,detailFlysheetanddetailDataare ignored even if provided.
UI Navigation
ECM > Imaging > Image Manager > Create Invoice (with PO) flysheet
Reference Article
Enterprise Content Management – ECM Documents
Imaging – PO Invoice 3 way Match
Example payload (JSON)
With PO Number (standard case or when imgso_allow_null_po_num_flag ≠ Y): { "srcUuid": "0AC3DE23133C61F0E063AF811DAC5CAD", "docTypeUuid": "ADC78973BD751170E053508010AC2DB4", "headerFlysheet": "AP Invoice with PO", "headerData": { "Company": "ZZ", "Apri_Ven_Code": "ABSCONT", "Apri_Group_Code": "CMIC", "Apri_Inv_Code": "ROASTINV988", "Apri_Inv_Date": "25/03/31", "Apri_Valid_Flag": "Y", "Apri_Desc": "test", "Apri_Orig_Amt": "100", "Apri_Amt": "100", "Po_Number": "WO00008001", "Release": "1" }, "detailFlysheet": "AP Invoice Allocation to PO", "detailData": [ { "Poda_Line_Num": "1", "Poda_Inv_Qty": "0", "Poda_Inv_Amt": "25" } ] }
Without PO Number (when imgso_allow_null_po_num_flag = Y): { "srcUuid": "0AC3DE23133C61F0E063AF811DAC5CAD", "docTypeUuid": "ADC78973BD751170E053508010AC2DB4", "headerFlysheet": "AP Invoice with PO", "headerData": { "Company": "ZZ", "Apri_Ven_Code": "ABSCONT", "Apri_Group_Code": "CMIC", "Apri_Inv_Code": "ROASTINV989", "Apri_Inv_Date": "25/03/31", "Apri_Valid_Flag": "Y", "Apri_Desc": "test", "Apri_Orig_Amt": "100", "Apri_Amt": "100" } }
Commonly Used Body Parameters
| CMiC UI Fieldname | Object | Name | Description | Type | Data Length | Example |
|---|---|---|---|---|---|---|
| Company | headerData | Company | This is the company code associated with the purchase order invoice. Must be a valid CMiC Company Code. | string | 8 | 001 |
| Vendor | headerData | Apri_Ven_Code | This is the vendor code associated with the purchase order invoice. Must be a valid vendor code in CMiC. | string | 10 | MICR01 |
| 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 | ROASTINV988 |
| Invoice Header Date | headerData | Apri_Inv_Date | This is the date the invoice was issued/created. | datetime | YYYY/MM/DD | 2025/03/31 |
| Valid Flag | headerData | Apri_Valid_Flag | The valid flag when set to 'Y' confirms the distribution created via the detail array matches the invoice header amount, otherwise it will default to 'N'. | string | 1 | Y/N |
| 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. | number | 18 | 1825.00 |
| Amount | headerData | Apri_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 |
| PO Number | headerData | Po_Number | This is the purchase order number. Must be a valid Purchase Order Number in CMiC. Conditionally required: omit only when the imaging system option imgso_allow_null_po_num_flag is set to Y. |
string | 11 | 00008001 |
| PO Detail Release Number | headerData | Release | This is the release number that matches the Purchase Order receipt header. Conditionally required: must be provided when Po_Number is supplied, or when null PO numbers are not permitted by system options. A Po_Number supplied without a Release is always invalid. |
number | 11 | 1 |
| PO Line Number | detailData | Poda_Line_Num | This is the unique line number linked to the purchase order detail that this invoice references. Each line corresponds to a specific detail on the original purchase order in Asset Management. A PO line number represents the distribution and allocations tied to that detail, such as Job/Dept/Equipment/Work Order, Cost Code/Account/Component/Work Item, and Category/Transaction Code/Expense. | number | 5 | 1 |
| Invoice Qty | detailData | Poda_Inv_Qty | This is the specific item quantity for the Purchase Order line item. | number | 16 | |
| Invoice Amount | detailData | Poda_Inv_Amt | This is the invoice amount by PO detail line. Must total to the invoice header amount. | number | 25 |
Basic authentication
Successful response