API Catalog

Retrieve Specific AR Invoice by Code

06 Jan 2025
4 Minutes to read

Print
Dark
Light

Retrieve Specific AR Invoice by Code

Updated on 06 Jan 2025
4 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

Query Standards

Finder

Following row finders are available for data filtering and optimizing request performance.

AR Invoice Finder
Select By Date
By UUID

AR Invoice Finder

Recommended finder parameters. Refer to Query Parameters for example.

Parameter	Description	Sample
CompCodeVar	Company Code	001
CustCodeVar	Customer Code	1020
InvNumVar	Invoice Number	06201.0001

Find By Date

This is the recommended finder for querying Customers by Company Code and Audit Date.

Parameter	Description	Sample
AuditDate	Create or Update Date Time Filter	2022-12-20

By UUID

This is an optional finder for querying a specific Customer by row ID.

Parameter	Description	Sample
/VUUID	The VUuid attribute is the Unique row ID	ar-rest-api/rest/1/arinvoice/B41F55417F65A908E053B08610AC2C73

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

Query Standards

Finder

AR Invoice Finder

Find By Date

By UUID

What's Next

Contact Us