Create a New PO Invoice Imaging Document
    • 22 Oct 2025
    • 2 Minutes to read
    • Dark
      Light

    Create a New PO Invoice Imaging Document

    • Dark
      Light

    Article summary

    Post
    /ecm-rest-api/jersey/v1/UploadData/uploadPoInvoice

    Overview

    This payload creates an AP Invoice with PO details and allocations.

    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.
    • The invoice is linked to a PO (Po_Number).

    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)

    { "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" } ] }

    Commonly Used Body Parameters

    CMiC UI FieldnameObjectNameDescriptionTypeData LengthExample
    CompanyheaderDataCompanyThis is the company code associated with the purchase order invoice. Must be a valid CMiC Company Code.string8001
    VendorheaderDataApri_Ven_CodeThis is the vendor code associated with the purchase order invoice. Must be a valid vendor code in CMiC.string10MICR01
    Invoice Registry Group CodeheaderDataApri_Group_CodeInvoice 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.string10CMIC
    Invoice NumberheaderDataApri_Inv_CodeThis 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.string20ROASTINV988
    Invoice Header DateheaderDataApri_Inv_DateThis is the date the invoice was issued/crated.datetimeYYYY/MM/DD2025/03/31
    Valid FlagheaderDataApri_Valid_FlagThe 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’.string1Y/N
    DescriptionheaderDataApri_DescThis is a short description for the invoice.string30Purchases from Home Depot.
    Original AmountheaderDataApri_Orig_AmtOriginal invoice amount is the pre-tax invoice amount.number181825.00
    AmountheaderDataApri_AmtThis 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).number181825.00
    PO NumberheaderDataPo_NumberThis is the purchase order number. Must be a valid Purchase Order Number in CMiC.string1100008001
    PO Detail Release NumberheaderDataReleaseThis is the release number that matches the Purchase Order receipt header.number111
    PO Line NumberdetailDataPoda_Line_NumThis 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.number51
    Invoice QtydetailDataPoda_Inv_QtyThis is the specific item quantity for the Purchase Order line item.number16
    Invoice AmountdetailDataPoda_Inv_AmtThis is the invoice amount by PO detail line. Must total to the invoice header amount.number25
    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": "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" } ] }
    document-content-file
    string (binary)
    Responses
    201

    Successful response