Contents x
      Create an AP Registered Invoice
      • 06 Jan 2026
      • 3 Minutes to read
      • Print
      • Dark
        Light
      Contents

      Create an AP Registered Invoice

      • Updated on 06 Jan 2026
      • 3 Minutes to read
      • Print
      • Dark
        Light
      Article summary

      Post
      /ap-rest-api/rest/1/apreginv

      Overview

      Using the Invoice Registry, users can enter invoices into the system as registered invoices, without having to enter all the required information and distribution. These registered invoices are then held in suspense until their required information and distribution is known. The APRegInvoice API allows the create, update, query and delete of registered invoices in CMiC.

      Notes

      Invoices maintained in the Invoice Registry must be entered against a registration group to which the user has access. Once assigned to a group, the details of the invoice can be entered. Invoices created into the registry require the entry of basic information, such as the registration group, vendor, invoice number, invoice date, and currency, but additional details, such as the description, check handling code, job code, and retainage percentage, can be entered later.

      UI Navigation

      Financials > Accounts Payable > Voucher > Register Invoices

      Reference Article

      apreginv Attributes (required)

      CMiC UI FieldnameObjectNameDescriptionTypeData LengthExample
      AmountapreginvApriAmtThis is the amount of the invoice, in the currency of the invoice.number181035.00
      Company CodeapreginvApriCompCodeThis is the company where the vendor and invoice are created against. Must be a valid Company Code in CMiC.string8001
      Currency NameapreginvApriCurrNameThis is the name associated with the Currency Code in CMiC. The Currency Code must be a valid code in CMiC.string30US Dollars
      Due DateapreginvApriDueDateThis date is usually printed on the invoice by the supplier, indicating the final date that payment must be received.datetime2025-11-20
      Group CodeapreginvApriGroupCodeThis is the Registration Group to which this invoice belongs. This must be a valid Registration Group Code in CMiC.string8AP
      Invoice CodeapreginvApriInvCodeA unique code for the invoice.string20INV452.99
      Invoice DateapreginvApriInvDateThis is the date associated with the invoice created in CMiC.datetime2025-10-14
      Invoice Series CodeapreginvApriInvSerCodeThis is the Invoice Series Code. The invoice series code provides a means of sorting and sequencing registered invoices as well as providing for the automatic distribution (whether partial or whole) of those invoices.string4SUBS
      VUuidapreginvApriVUuidThis is the unique identifier for this record. Leave Blank. Automatically generated by the system when invoice inserted.string64C67A493EFD6982DAE053B08610AC73FD
      Vendor CodeapreginvApriVenCodeThis is the vendor the invoice is being processed for. The Vendor Code must be a valid vendor code in CMiC.string83657
      Pay By Manual Check FlagapreginvApriPayByManualChqFlagIf this invoice must be paid by manual check, set this flag to ‘Y’.string1Y/N
      Security
      HTTP
      Type basic

      Basic authentication

      Header parameters
      Content-Type
      string
      Exampleapplication/vnd.oracle.adf.resourceItem+json
      Body parameters
      object
      Example{ "ApriPayByManualChqFlag": "N", "ApriCompCode": "001", "ApriVenCode": "3657", "ApriCurrName": "US Dollars", "ApriInvCode": "INV452.99", "ApriInvDate": "2025-10-14", "ApriDueDate": "2025-11-20", "ApriAmt": 1, "ApriGroupCode": "AP", "ApriInvSerCode": "SUBS", "ApriVUuid": "" }
      Responses
      201

      Created

      Headers
      Content-Type
      string
      Exampleapplication/vnd.oracle.adf.resourceitem+json
      {
  "Apri1099Code": null,
  "Apri1099Name": null,
  "ApriAcctDescription": null,
  "ApriAdjustingInvCode": null,
  "ApriAmt": 0,
  "ApriAppr1": null,
  "ApriAppr2": null,
  "ApriApprovedFlag": null,
  "ApriCashAccCode": null,
  "ApriChgCode": null,
  "ApriChqHandleCode": null,
  "ApriCompCode": "001",
  "ApriCompName": null,
  "ApriContCode": null,
  "ApriCreditTaxAmt": null,
  "ApriCurrCode": null,
  "ApriCurrName": "Canadian Dollar",
  "ApriDeptCode": null,
  "ApriDesc": null,
  "ApriDetExists": null,
  "ApriDetailHyperlink": null,
  "ApriDfltTaxableAmt": null,
  "ApriDiscAllocMethCode": null,
  "ApriDiscAmt": null,
  "ApriDiscCheckFlag": null,
  "ApriDiscDate": null,
  "ApriDiscPc": null,
  "ApriDrawNum": null,
  "ApriDueDate": "2022-08-19",
  "ApriEditHyperlink": null,
  "ApriEftFlag": null,
  "ApriEqpCode": null,
  "ApriExpDeptCode": null,
  "ApriExpDeptName": null,
  "ApriGrossAmt": null,
  "ApriGroupCode": "AP",
  "ApriGroupName": null,
  "ApriHldbkAmt": null,
  "ApriHldbkPc": null,
  "ApriHldbkRlsAmt": null,
  "ApriHoldPaymentDays": null,
  "ApriHoldPaymentFlag": null,
  "ApriImageFilename": null,
  "ApriImgGrossAmt": null,
  "ApriImgNetAmt": null,
  "ApriImgTaxInfo": null,
  "ApriInvCode": "19.1005.10",
  "ApriInvCopyCheck": null,
  "ApriInvDate": "2022-07-20",
  "ApriInvSerCode": null,
  "ApriInvSerName": null,
  "ApriJobCode": null,
  "ApriJobName": null,
  "ApriNoncreditTaxAmt": null,
  "ApriOrigAmt": null,
  "ApriOriginatingVouNum": null,
  "ApriPartialApprovedAmt": null,
  "ApriPayByManualChqFlag": "N",
  "ApriPayCode": null,
  "ApriPoNum": null,
  "ApriPoPickFlag": null,
  "ApriPoReleaseNum": null,
  "ApriRemainingBalance": null,
  "ApriRemitDesc": null,
  "ApriRoutDept": null,
  "ApriRoutJob": null,
  "ApriSourceCode": null,
  "ApriStatCode": null,
  "ApriTax1Amt": null,
  "ApriTax1Code": null,
  "ApriTax1HldbkAmt": null,
  "ApriTax1TaxableAmt": null,
  "ApriTax1TaxableFlag": null,
  "ApriTax2Amt": null,
  "ApriTax2Code": null,
  "ApriTax2HldbkAmt": null,
  "ApriTax2TaxableAmt": null,
  "ApriTax2TaxableFlag": null,
  "ApriTax3Amt": null,
  "ApriTax3Code": null,
  "ApriTax3TaxableAmt": null,
  "ApriTax3TaxableFlag": null,
  "ApriTax4Amt": null,
  "ApriTax4Code": null,
  "ApriTax4TaxableAmt": null,
  "ApriTax4TaxableFlag": null,
  "ApriTax5Amt": null,
  "ApriTax5Code": null,
  "ApriTax5TaxableAmt": null,
  "ApriTax5TaxableFlag": null,
  "ApriTppayCode": null,
  "ApriVUuid": "F30AAFAB163F3578E05316821FAC8E9A",
  "ApriValidFlag": null,
  "ApriVenAddCode": null,
  "ApriVenCode": "K0002",
  "ApriVenName": null,
  "ApriVouNum": null,
  "ApriWoCode": null,
  "ApriIuCreateDate": null,
  "ApriIuUpdateDate": null,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/apreginv/F30AAFAB163F3578E05316821FAC8E9A",
      "name": "apreginv",
      "kind": "item"
    },
    {
      "rel": "canonical",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/apreginv/F30AAFAB163F3578E05316821FAC8E9A",
      "name": "apreginv",
      "kind": "item"
    },
    {
      "rel": "child",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/apreginv/F30AAFAB163F3578E05316821FAC8E9A/child/ApRegInvDetViewObj",
      "name": "ApRegInvDetViewObj",
      "kind": "collection"
    }
  ]
}
      object
      What's Next
      Contact Us
      Copyright © 2024 CMiC All Rights Reserved