Create an AP Registered Invoice
    • 27 Feb 2025
    • 6 Minutes to read
    • Dark
      Light

    Create an AP Registered Invoice

    • Dark
      Light

    Article summary

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

    Create Registered Invoices

    UI Location: Financials - Accounts Payable - Voucher - Registered Invoices

    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": "K0002", "ApriCurrName": "Canadian Dollar", "ApriInvCode": "19.1005.10", "ApriInvDate": "2022-07-20T00:00:00-04:00", "ApriDueDate": "2022-08-19T00:00:00-04:00", "ApriAmt": "0", "ApriGroupCode": "AP", "ApriVUuid": "" }
    ApriGroupCode
    string Required

    Group Code

    💻 UI Fieldname: *Group

    Max length8
    ApriAmt
    number Required

    Voucher Amount

    💻 UI Fieldname: Invoice Amount

    Max length18
    ApriVUuid
    string Required

    Column for unique identification during use of JSON webservices with external systems

    Max length64
    ApriVenCode
    string Required

    Vendor Code

    💻 UI Fieldname: *Vendor

    Max length8
    ApriCompCode
    string Required

    Company Code

    Max length8
    ApriDueDate
    string Required

    Due Date

    💻 UI Fieldname: Due Date

    ApriInvDate
    string Required

    Voucher Date

    💻 UI Fieldname: *Invoice Date

    ApriPayByManualChqFlag
    string Required

    Y=Manual voucher payment by written check; N=Automatic voucher payment by the AP system.

    Max length1
    ApriCurrName
    string Required

    Currency Name

    Max length30
    ApriInvCode
    string Required

    Invoice Code

    💻 UI Fieldname: *Invoice Code

    Max length20
    ApriHoldPaymentFlag
    string

    Flag To Indicate Whether Payment Is To Be Held For PWP or not.

    Max length1
    ApriTax5Code
    string

    Tax 5 Code

    Max length11
    ApriRemainingBalance
    number

    Difference between Original Invoice Amount and detail lines

    Max length18
    ApriStatCode
    string

    Number of times invoice has been passed to Voucher Entry and then deleted from Voucher Entry

    Max length1
    ApriRoutJob
    string

    Check for valid job

    Max length10
    ApriHldbkRlsAmt
    number

    Retainage release amount modified when updating apregdist.

    Max length18
    ApriImgTaxInfo
    string

    Tax Info field used in Imaging

    Max length4000
    ApriTax5Amt
    number

    Tax 5 Amount

    Max length18
    ApriGrossAmt
    number

    Gross invoice amount (does not include direct taxes)

    Max length18
    ApriSourceCode
    string

    08.21311 - set to RGSC to tell validation package that this record is for a contract with payment type SC.

    Max length4
    ApriTax3Code
    string

    Tax 3 Code

    Max length11
    ApriTax1TaxableAmt
    number

    Tax 1 Taxable Amount

    💻 UI Fieldname: Tax Code

    Max length18
    ApriCompName
    string

    Company Name

    Max length30
    ApriCurrCode
    string

    Currency Code

    Max length3
    ApriDesc
    string

    Voucher Description

    💻 UI Fieldname: Description

    Max length60
    ApriJobCode
    string

    Job Code

    💻 UI Fieldname: Job Code

    Max length10
    ApriTax3TaxableFlag
    string

    Flag to indicate that a tax code exists but the tax amount will be calculated as zero. Valid values are (Y)es - meaning taxable and (N)o - meaning non taxable.

    Max length1
    ApriVouNum
    number

    Voucher Number Created

    Max length11
    ApriHoldPaymentDays
    number

    Number Of Days Payment Is To Be Held For PWP.

    Max length4
    ApriDiscDate
    string

    Discount Date

    💻 UI Fieldname: Discount Date

    ApriTax4TaxableFlag
    string

    Flag to indicate that a tax 4 code exists but the tax amount will be calculated as zero. Valid values are (Y)es - meaning taxable and (N)o - meaning non taxable.

    Max length1
    ApriTax2HldbkAmt
    number

    Tax 2 Retainage Amount

    Max length18
    ApriRemitDesc
    string

    Remittance Description

    Max length60
    ApriTax1TaxableFlag
    string

    Flag to indicate that a tax code exists but the tax amount will be calculated as zero. Valid values are (Y)es - meaning taxable and (N)o - meaning non taxable.

    Max length1
    ApriVenAddCode
    string

    Vendor address code

    💻 UI Fieldname: Address

    Max length5
    ApriExpDeptName
    string

    Exp. Department Name

    Max length30
    ApriPayCode
    string

    Not Used

    Max length10
    ApriDiscAllocMethCode
    string

    Discount Allocation Method Code: A-AP Dept/Acc,G-Job Dept/Acc,J-Job Cost/Cat

    Max length1
    ApriValidFlag
    string

    ?

    💻 UI Fieldname: Valid

    Max length1
    ApriExpDeptCode
    string

    Expense Department Code

    💻 UI Fieldname: Expense Dept

    Max length6
    ApriInvSerName
    string

    Invoice Series Code Description

    Max length60
    ApriHldbkAmt
    number

    Retainage Amount

    💻 UI Fieldname: Retainage Amount

    Max length18
    ApriPoPickFlag
    string

    Flag To Indicate The Registered Invoice Was Created From A Purchase Order. (Y)es Means Created From Purchase Order.

    Max length1
    ApriTppayCode
    string

    Third Party Payment Code

    💻 UI Fieldname: Third Party Payment Mode

    Max length2
    ApriTax2TaxableAmt
    number

    Tax 2 Taxable Amount

    Max length18
    ApriCashAccCode
    string

    Cash Account Code

    Max length16
    ApriDetailHyperlink
    string

    Detail Link

    Max length6
    Apri1099Code
    string

    1099 Code

    💻 UI Fieldname: 1099 Code

    Max length1
    ApriTax2Amt
    number

    Tax 2 Amount

    Max length18
    ApriTax5TaxableAmt
    number

    Tax 5 taxable amount

    Max length18
    ApriTax1HldbkAmt
    number

    Tax 1 Retainage Amount

    Max length18
    ApriInvCopyCheck
    string

    ?

    Max length1
    ApriGroupName
    string

    Group Description

    Max length60
    ApriCreditTaxAmt
    number

    Sum of all Credit Tax Amounts

    Max length18
    ApriTax1Code
    string

    Tax 1 Code

    💻 UI Fieldname: Tax Amount

    Max length11
    ApriChgCode
    string

    Change Order code for Subcontract on this voucher

    Max length6
    ApriTax4Code
    string

    Tax 4 Code

    Max length11
    ApriDeptCode
    string

    Cash Department Code

    Max length6
    ApriTax5TaxableFlag
    string

    Flag to indicate that a tax 5 code exists but the tax amount will be calculated as zero. Valid values are (Y)es - meaning taxable and (N)o - meaning non taxable.

    Max length1
    ApriAcctDescription
    string

    Accounting Description

    Max length500
    ApriChqHandleCode
    string

    Check Handle Code

    Max length8
    ApriTax4TaxableAmt
    number

    Tax 4 taxable amount

    Max length18
    ApriDiscAmt
    number

    Discount Amount

    💻 UI Fieldname: Discount Amount

    Max length18
    ApriTax2TaxableFlag
    string

    Flag to indicate that a tax code exists but the tax amount will be calculated as zero. Valid values are (Y)es - meaning taxable and (N)o - meaning non taxable.

    Max length1
    ApriHldbkPc
    number

    Retainage Percent

    💻 UI Fieldname: Retainage%

    Max length5
    ApriTax1Amt
    number

    Tax 1 Amount

    💻 UI Fieldname: Contract

    Max length18
    ApriIuUpdateDate
    string
    ApriEqpCode
    string

    Not Used

    Max length10
    ApriDiscPc
    number

    Discount Percent

    💻 UI Fieldname: Discount%

    Max length8
    ApriApprovedFlag
    string

    Approval Flag

    Max length1
    ApriOraseq
    number

    ORASEQ

    ApriNoncreditTaxAmt
    number

    Sum of all Non Credit Tax Amounts

    Max length18
    Apri1099Name
    string

    1099 Description

    Max length80
    ApriImgNetAmt
    number

    Column used only by Image Manager to store net invoice amount

    Max length18
    ApriOrigAmt
    number

    Original Invoice Amount

    Max length18
    ApriAdjustingInvCode
    string

    Invoice Number That Is Being Adjusted.

    Max length20
    ApriTax4Amt
    number

    Tax 4 Amount

    Max length18
    ApriInvSerCode
    string

    Invoice Series Code

    💻 UI Fieldname: Invoice Series

    Max length4
    ApriWoCode
    string

    Work Order Number or Code. Used only by Imaging and Workflow.

    Max length10
    ApriDrawNum
    number

    Draw Number, Populating From Imaging.

    Max length6
    ApriPartialApprovedAmt
    number

    The amount approved for payment when the invoice is only partially approved.

    Max length18
    ApriImageFilename
    string

    Not Used

    Max length255
    ApriDfltTaxableAmt
    number

    Default Taxable Amount

    Max length18
    ApriDiscCheckFlag
    string

    Discrete Check Flag Y/N

    💻 UI Fieldname: Discount Allocation Method

    Max length1
    ApriImgGrossAmt
    number

    Used to accumulate amount coming from distribution or detail tables

    Max length18
    ApriVenName
    string

    Vendor Name

    Max length50
    ApriJobName
    string

    Job Name

    Max length60
    ApriContCode
    string

    Subcontract code for this voucher

    💻 UI Fieldname: Contact

    Max length20
    ApriTax3TaxableAmt
    number

    Tax 3 Taxable Amount

    Max length18
    ApriPoNum
    string

    Not Used

    Max length11
    ApriOriginatingVouNum
    number

    The Original Voucher Against The Invoice That Is Being Adjusted.

    Max length11
    ApriTax3Amt
    number

    Tax 3 Amount

    Max length18
    ApriPoReleaseNum
    number

    Not Used

    Max length11
    ApriIuCreateDate
    string
    ApriAppr2
    string

    This columm is being used for to store workflow approver 2

    Max length30
    ApriAppr1
    string

    This columm is being used for to store workflow approver 1

    Max length30
    ApriRoutDept
    string

    Check for valid department

    Max length6
    ApriTax2Code
    string

    Tax 2 Code

    Max length11
    ApriEftFlag
    string

    AP Registry EFT flag defaulted from vendor eft flag but can be changed.

    💻 UI Fieldname: EFT Flag

    Max length1
    ApriEditHyperlink
    string

    Edit Link

    Max length4
    ApriDetExists
    string

    Not Used

    Max length1
    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