API Catalog

Retrieve Specific AR Invoice by Code

04 Nov 2025
5 Minutes to read

Print
Dark
Light

Retrieve Specific AR Invoice by Code

Updated on 04 Nov 2025
5 Minutes to read

Print
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback!

Get

/ar-rest-api/rest/1/arinvoice

Overview

Accounts Receivable invoices are created in CMiC for payment to customers. The AR Invoice API can be used to create, update, delete and query invoice details in CMiC.

Notes

This endpoint is typically used for miscellaneous invoices.

Financials > Accounts Receivable > Enter Invoices

Reference Article

Accounts Receivable – Entering Invoices

Path Parameters

Parameter	Description	Example
/VUUID	The VUuid attribute is the Unique row ID	CB078258F7013771E053B08610ACDD0E

Query Standards

Key	Recommended	Description
finder	Yes	Filters data based on attributes. See finder details below. Finders can be combined using a comma delimiter between parameters that implies an "and" statement. For more information on using the finder functionality please see Best Practice	Data Filtering requirements
limit	Yes	A limit restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count, then the framework will return all available resources. For additional information on using the limit functionality please visit Best Practice	Data Filtering requirements
offset	Yes	The offset skips a specified number of items in a data list before it starts showing results. For example, if you set an offset of 10, it skips the first 10 items and begins showing from the 11th item. For additional information on using Offset functionality please visit Best Practice	Data Filtering requirements
orderBy	Yes	The orderBy attribute retrieves rows using an order ensuring the response payload displays data in the order supplied in the URL parameter using the GET method. For more information on using orderBy functionality please visit Best Practice	Data Filtering requirements

arinvoice Finders

Finder	Parameter	Data Type	Data Length	Description	Example
ArInvoiceFinder	CompCodeVar	string		This finder parameter queries invoices by Company Code. Can be combined with optional parameters ‘CustCodeVar’ and ‘InvNumVar’.	/ar-rest-api/rest/1/arinvoice?finder=ArInvoiceFinder;CompCodeVar=001
ArInvoiceFinder	CustCodeVar	string		This finder parameter queries invoices by Customer Code. Can be combined with optional parameters ‘CompCodeVar’ and ‘InvNumVar’.	/ar-rest-api/rest/1/arinvoice?finder=ArInvoiceFinder;CustCodeVar=IRV
ArInvoiceFinder	InvNumVar	string		This finder parameter queries invoices by Invoice Number. Can be combined with optional parameters ‘CustCodeVar’ and ‘CompCodeVar’.	/ar-rest-api/rest/1/arinvoice?finder=ArInvoiceFinder;InvNumVar=034502
PrimaryKey	InvVUuid	string	64	This finder parameter is used to query specific invoices by unique identifier Vuuid.	/ar-rest-api/rest/1/arinvoice?finder=PrimaryKey;InvVUuid=CB078258F7013771E053B08610ACDD0E
selectByDate	AuditDate	datetime		This finder parameter queries invoices based on the combined uICreate and uIUpdate dates. Supplying a date will return all records created or updated after that date, making it useful for retrieving only changes since the last invoice data pull.	/ar-rest-api/rest/1/arinvoice?finder=selectByDate;AuditDate=2021-09-02

Security

HTTP

Type basic

Basic authentication

Query parameters

finder

string

ExampleArInvoiceFinder;CompCodeVar=001,CustCodeVar=1020,InvNumVar=06201.0001

limit

integer

Example500

offset

integer

Example0

totalResults

boolean

Exampletrue

orderBy

string

ExampleInvNum:desc

Responses

200

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourcecollection+json

example-0

Successful Response - Finder - ArInvoiceFinder

{
  "items": [
    {
      "InvAcctDescription": null,
      "InvAddTypeCode": null,
      "InvAllowAmt": 0,
      "InvAmt": 46177.36,
      "InvApprovedDate": null,
      "InvArAmt": 46177.36,
      "InvArLessHldbkAmt": 41559.6,
      "InvAverageDaysToPay": 14,
      "InvBchNum": 358947,
      "InvBchPstFlag": null,
      "InvCRlsAmt": null,
      "InvCRlsTaxAmt": null,
      "InvCashAccCode": "10001",
      "InvCatCode": null,
      "InvChargeCode": "NA",
      "InvCollCode": "ACCT",
      "InvCompCode": "001",
      "InvContCode": "062016",
      "InvCostCode": null,
      "InvCreditAmt": null,
      "InvCreditHldbkAmt": null,
      "InvCreditTax1HldbkAmt": null,
      "InvCurFactorNum": 1,
      "InvCurrCode": "USD",
      "InvCustCode": "1020",
      "InvDate": "2016-09-01",
      "InvDelinqCode": null,
      "InvDeptCode": "00",
      "InvDesc1": "JB Draw 1 - ",
      "InvDesc2": null,
      "InvDetTaxAmt": null,
      "InvDetailsExistFlag": "N",
      "InvDiscAmt": 0,
      "InvDiscAmtUpd": 0,
      "InvDiscDate": "2016-09-01",
      "InvDiscDateUpd": "2016-09-01",
      "InvDiscDays": 0,
      "InvDiscTakenAmt": 0,
      "InvDisputedFlag": null,
      "InvDistributionExistFlag": "Y",
      "InvDrawNum": 1,
      "InvDueDate": "2016-10-01",
      "InvDueDateUpd": "2016-10-01",
      "InvDueDays": 30,
      "InvFinAmt": null,
      "InvFrtAmt": null,
      "InvFrtDiscCode": "N",
      "InvHldbkAmt": 4617.76,
      "InvHldbkAmtUpd": 4617.76,
      "InvHldbkPaidAmt": null,
      "InvHldbkPc": 0,
      "InvHldbkPcUpd": 0,
      "InvImageFilename": null,
      "InvInsAmt": null,
      "InvInsDiscCode": "N",
      "InvInvoiceNewFlag": "N",
      "InvIuCreateDate": "2016-09-29T21:43:52Z",
      "InvIuCreateUser": "CANDICE",
      "InvIuUpdateDate": "2016-09-30T13:00:56Z",
      "InvIuUpdateUser": "CANDICE",
      "InvJobCode": "062016",
      "InvLastPayAmt": 41559.6,
      "InvMiscAmt": null,
      "InvMiscDiscCode": "N",
      "InvNetAmt": 41559.6,
      "InvNetAmtUpd": 41559.6,
      "InvNodiscAmt": 4617.76,
      "InvNum": "06201.0001",
      "InvObjectOraseq": 52492453,
      "InvOePrtCode": "P",
      "InvOrdNum": "062016",
      "InvOrigHldbkAmt": 4617.76,
      "InvOrigTax1HldbkAmt": 0,
      "InvOriginalDesc1": null,
      "InvOriginalDesc1UpdDate": null,
      "InvOriginalDesc1UpdUser": null,
      "InvOriginalDueDate": null,
      "InvOriginalDueDateUpdDate": null,
      "InvOriginalDueDateUpdUser": null,
      "InvOtherTaxes": 0,
      "InvOutstandAmt": 0,
      "InvPaidAmt": 41559.6,
      "InvPlantCode": null,
      "InvPostDate": "2016-09-29",
      "InvReasonDueDateChange": null,
      "InvRevBchNum": null,
      "InvRevDate": null,
      "InvRlsAmt": null,
      "InvRlsAmtUpd": null,
      "InvRlsBchNum": null,
      "InvRlsDate": null,
      "InvRlsInvNum": null,
      "InvRlsTax1Amt": 0,
      "InvRlsTax1AmtUpd": 0,
      "InvRlsTaxAmt": null,
      "InvRlsWAmt": null,
      "InvSalesAmt": 46177.36,
      "InvSdiscAmt": 0,
      "InvSdiscPercent": 0,
      "InvSeparateBillingRefCode": null,
      "InvSerCode": "SELF",
      "InvSman1Code": null,
      "InvSman1CommAmt": null,
      "InvSman1CommPc": null,
      "InvSman2Code": null,
      "InvSman2CommAmt": null,
      "InvSman2CommPc": null,
      "InvSman3Code": null,
      "InvSman3CommAmt": null,
      "InvSman3CommPc": null,
      "InvSourceCode": "R",
      "InvStatusCode": "C",
      "InvStmtDate": null,
      "InvTax1Amt": 0,
      "InvTax1Code": null,
      "InvTax1HldbkAmt": 0,
      "InvTax1HldbkAmtUpd": 0,
      "InvTax1Name": null,
      "InvTax1TaxableAmt": null,
      "InvTax1TaxableFlag": "Y",
      "InvTax2Amt": 0,
      "InvTax2Code": null,
      "InvTax2Name": null,
      "InvTax2TaxableAmt": null,
      "InvTax2TaxableFlag": "Y",
      "InvTax3Amt": 0,
      "InvTax3Code": null,
      "InvTax3Name": null,
      "InvTax3TaxableAmt": null,
      "InvTax3TaxableFlag": "Y",
      "InvTaxDiscCode": "Y",
      "InvTaxes": 0,
      "InvTermCode": "NET30",
      "InvTermPc": 0,
      "InvTermPcUpd": 0,
      "InvTotalRlsTaxAmt": null,
      "InvTranCode": "I",
      "InvVUuid": "B41F55417F65A908E053B08610AC2C73",
      "InvWoAmt": 0,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ar-rest-api/rest/1/arinvoice/B41F55417F65A908E053B08610AC2C73",
          "name": "arinvoice",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ar-rest-api/rest/1/arinvoice/B41F55417F65A908E053B08610AC2C73",
          "name": "arinvoice",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 50,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ar-rest-api/rest/1/arinvoice",
      "name": "arinvoice",
      "kind": "collection"
    }
  ]
}

example-1

Successful Response - Finder - selectByDate

{
  "items": [
    {
      "InvAcctDescription": null,
      "InvAddTypeCode": null,
      "InvAllowAmt": 0,
      "InvAmt": 99999.99,
      "InvApprovedDate": null,
      "InvArAmt": 46177.36,
      "InvArLessHldbkAmt": 95382.23,
      "InvAverageDaysToPay": 14,
      "InvBchNum": 358947,
      "InvBchPstFlag": null,
      "InvCRlsAmt": null,
      "InvCRlsTaxAmt": null,
      "InvCashAccCode": "10001",
      "InvCatCode": null,
      "InvChargeCode": "NA",
      "InvCollCode": "ACCT",
      "InvCompCode": "001",
      "InvContCode": "062016",
      "InvCostCode": null,
      "InvCreditAmt": null,
      "InvCreditHldbkAmt": null,
      "InvCreditTax1HldbkAmt": null,
      "InvCurFactorNum": 1,
      "InvCurrCode": "USD",
      "InvCustCode": "1020",
      "InvDate": "2016-09-01",
      "InvDelinqCode": null,
      "InvDeptCode": "00",
      "InvDesc1": "JB Draw 1 - ",
      "InvDesc2": null,
      "InvDetTaxAmt": null,
      "InvDetailsExistFlag": "N",
      "InvDiscAmt": 0,
      "InvDiscAmtUpd": 0,
      "InvDiscDate": "2016-09-01",
      "InvDiscDateUpd": "2016-09-01",
      "InvDiscDays": 0,
      "InvDiscTakenAmt": 0,
      "InvDisputedFlag": null,
      "InvDistributionExistFlag": "Y",
      "InvDrawNum": 1,
      "InvDueDate": "2016-10-01",
      "InvDueDateUpd": "2016-10-01",
      "InvDueDays": 30,
      "InvFinAmt": null,
      "InvFrtAmt": null,
      "InvFrtDiscCode": "N",
      "InvHldbkAmt": 4617.76,
      "InvHldbkAmtUpd": 4617.76,
      "InvHldbkPaidAmt": null,
      "InvHldbkPc": 0,
      "InvHldbkPcUpd": 0,
      "InvImageFilename": null,
      "InvInsAmt": null,
      "InvInsDiscCode": "N",
      "InvInvoiceNewFlag": "N",
      "InvIuCreateDate": "2016-09-29T21:43:52Z",
      "InvIuCreateUser": "CANDICE",
      "InvIuUpdateDate": "2023-01-13T20:28:20Z",
      "InvIuUpdateUser": "CMICUSER",
      "InvJobCode": "062016",
      "InvLastPayAmt": 41559.6,
      "InvMiscAmt": null,
      "InvMiscDiscCode": "N",
      "InvNetAmt": 95382.23,
      "InvNetAmtUpd": 95382.23,
      "InvNodiscAmt": 4617.76,
      "InvNum": "06201.0001",
      "InvObjectOraseq": 52492453,
      "InvOePrtCode": "P",
      "InvOrdNum": "062016",
      "InvOrigHldbkAmt": 4617.76,
      "InvOrigTax1HldbkAmt": 0,
      "InvOriginalDesc1": null,
      "InvOriginalDesc1UpdDate": null,
      "InvOriginalDesc1UpdUser": null,
      "InvOriginalDueDate": null,
      "InvOriginalDueDateUpdDate": null,
      "InvOriginalDueDateUpdUser": null,
      "InvOtherTaxes": 0,
      "InvOutstandAmt": 0,
      "InvPaidAmt": 41559.6,
      "InvPlantCode": null,
      "InvPostDate": "2016-09-29",
      "InvReasonDueDateChange": null,
      "InvRevBchNum": null,
      "InvRevDate": null,
      "InvRlsAmt": null,
      "InvRlsAmtUpd": null,
      "InvRlsBchNum": null,
      "InvRlsDate": null,
      "InvRlsInvNum": null,
      "InvRlsTax1Amt": 0,
      "InvRlsTax1AmtUpd": 0,
      "InvRlsTaxAmt": null,
      "InvRlsWAmt": null,
      "InvSalesAmt": 46177.36,
      "InvSdiscAmt": 0,
      "InvSdiscPercent": 0,
      "InvSeparateBillingRefCode": null,
      "InvSerCode": "SELF",
      "InvSman1Code": null,
      "InvSman1CommAmt": null,
      "InvSman1CommPc": null,
      "InvSman2Code": null,
      "InvSman2CommAmt": null,
      "InvSman2CommPc": null,
      "InvSman3Code": null,
      "InvSman3CommAmt": null,
      "InvSman3CommPc": null,
      "InvSourceCode": "R",
      "InvStatusCode": "C",
      "InvStmtDate": null,
      "InvTax1Amt": 0,
      "InvTax1Code": null,
      "InvTax1HldbkAmt": 0,
      "InvTax1HldbkAmtUpd": 0,
      "InvTax1Name": null,
      "InvTax1TaxableAmt": null,
      "InvTax1TaxableFlag": "Y",
      "InvTax2Amt": 0,
      "InvTax2Code": null,
      "InvTax2Name": null,
      "InvTax2TaxableAmt": null,
      "InvTax2TaxableFlag": "Y",
      "InvTax3Amt": 0,
      "InvTax3Code": null,
      "InvTax3Name": null,
      "InvTax3TaxableAmt": null,
      "InvTax3TaxableFlag": "Y",
      "InvTaxDiscCode": "Y",
      "InvTaxes": 0,
      "InvTermCode": "NET30",
      "InvTermPc": 0,
      "InvTermPcUpd": 0,
      "InvTotalRlsTaxAmt": null,
      "InvTranCode": "I",
      "InvVUuid": "B41F55417F65A908E053B08610AC2C73",
      "InvWoAmt": 0,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ar-rest-api/rest/1/arinvoice/B41F55417F65A908E053B08610AC2C73",
          "name": "arinvoice",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ar-rest-api/rest/1/arinvoice/B41F55417F65A908E053B08610AC2C73",
          "name": "arinvoice",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 50,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ar-rest-api/rest/1/arinvoice",
      "name": "arinvoice",
      "kind": "collection"
    }
  ]
}

object

What's Next

Create a AR Tax Item

Retrieve Specific AR Invoice by Code

Overview

Notes

UI Navigation

Reference Article

Path Parameters

Query Standards

arinvoice Finders

What's Next

Contact Us