API Catalog

Retrieve Outstanding Invoice By Code

04 Dec 2024
3 Minutes to read

Print
Dark
Light

Retrieve Outstanding Invoice By Code

Updated on 04 Dec 2024
3 Minutes to read

Print
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/ap-rest-api/rest/1/apinvoutstanding

Query Standards

Finder

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

selectInvoices
selectByDate
By UUID

Select Invoices

Recommended finder parameters. Refer to Query Parameters for example.

Parameters

Parameter	Description	Example
FromInvoiceDateVar	From Date	2022-02-19
ToInvoiceDateVar	To Date	2022-09-10
InvCodeVar	Invoice Code	YFKUJYHF-01
VendorCodeVar	Vendor Code	HOLMES
CompanyCodeVar	Company Code	001

Select by Audit Date

This is an optional finder for querying Outstanding Invoices by 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 Outstanding Invoice by row ID.

Parameter	Description	Sample
/VUUID	The VUuid attribute is the Unique row ID	/ap-rest-api/rest/1/apinvoutstanding/:83166994

Security

HTTP

Type basic

Basic authentication

Query parameters

finder

string

ExampleselectInvoices; FromInvoiceDateVar= 2022-02-19, ToInvoiceDateVar=2022-09-10, InvCodeVar=YFKUJYHF-01, VendorCodeVar=HOLMES, CompanyCodeVar=001

limit

integer

Example500

offset

integer

Example0

totalResults

boolean

ExampleTrue

orderBy

string

ExampleInvoiceCode:desc

Responses

200

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourcecollection+json

example-0

Successful Response - Finder - selectByDate

{
  "items": [
    {
      "CompanyCode": "001",
      "VendorCode": "HOLMES",
      "InvoiceCode": "001",
      "InvoiceVoucherNum": 82637199,
      "InvoiceDate": "2019-02-05",
      "DueDate": "2019-03-07",
      "PostedDate": "2020-09-22",
      "OutstandingAmount": 201814.44,
      "OutstandingBucketName": "Over 120 days",
      "OutstandingBucketName4": "Over 90 days",
      "OutstandingBucketLabel": "Over 120",
      "OutstandingBucketLabel4": "Over 90",
      "OutstandingAmountCurrent": null,
      "OutstandingAmount31To60": null,
      "OutstandingAmount61To90": null,
      "OutstandingAmountOver90": 201814.44,
      "OutstandingAmount91To120": null,
      "OutstandingAmountOver120": 201814.44,
      "AmountOverDue": 201814.44,
      "AmountOverDueOver30Days": 201814.44,
      "AmountOverDue15To30Days": null,
      "AmountOverDue8To14Days": null,
      "AmountOverDue1To7Days": null,
      "AmountDueToday": null,
      "AmountDue1To7Days": null,
      "AmountDue8To14Days": null,
      "AmountDue15To30Days": null,
      "AmountDue31To60Days": null,
      "AmountDue61To90Days": null,
      "AmountDueOver90Days": null,
      "LastUpdatedDate": "2023-02-07T02:51:07Z",
      "LastUpdatedUser": "GCPAY",
      "RecordCreatedDate": "2019-02-05T04:06:30Z",
      "RecordCreatedUser": "CHET",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/apinvoutstanding/82637199",
          "name": "apinvoutstanding",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/apinvoutstanding/82637199",
          "name": "apinvoutstanding",
          "kind": "item"
        }
      ]
    },
    {
      "CompanyCode": "001",
      "VendorCode": "HOLMES",
      "InvoiceCode": "YFKUJYHF-01",
      "InvoiceVoucherNum": 2021262722,
      "InvoiceDate": "2022-08-24",
      "DueDate": "2022-08-24",
      "PostedDate": "2022-08-24",
      "OutstandingAmount": 45000,
      "OutstandingBucketName": "Over 120 days",
      "OutstandingBucketName4": "Over 90 days",
      "OutstandingBucketLabel": "Over 120",
      "OutstandingBucketLabel4": "Over 90",
      "OutstandingAmountCurrent": null,
      "OutstandingAmount31To60": null,
      "OutstandingAmount61To90": null,
      "OutstandingAmountOver90": 45000,
      "OutstandingAmount91To120": null,
      "OutstandingAmountOver120": 45000,
      "AmountOverDue": 45000,
      "AmountOverDueOver30Days": 45000,
      "AmountOverDue15To30Days": null,
      "AmountOverDue8To14Days": null,
      "AmountOverDue1To7Days": null,
      "AmountDueToday": null,
      "AmountDue1To7Days": null,
      "AmountDue8To14Days": null,
      "AmountDue15To30Days": null,
      "AmountDue31To60Days": null,
      "AmountDue61To90Days": null,
      "AmountDueOver90Days": null,
      "LastUpdatedDate": "2023-02-07T02:51:07Z",
      "LastUpdatedUser": "GCPAY",
      "RecordCreatedDate": "2022-08-25T01:19:57Z",
      "RecordCreatedUser": "RYVIT",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/apinvoutstanding/2021262722",
          "name": "apinvoutstanding",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/apinvoutstanding/2021262722",
          "name": "apinvoutstanding",
          "kind": "item"
        }
      ]
    },
    {
      "CompanyCode": "001",
      "VendorCode": "HOLMES",
      "InvoiceCode": "TEST",
      "InvoiceVoucherNum": 2021262298,
      "InvoiceDate": "2021-06-17",
      "DueDate": "2021-07-17",
      "PostedDate": "2022-12-09",
      "OutstandingAmount": 13,
      "OutstandingBucketName": "Over 120 days",
      "OutstandingBucketName4": "Over 90 days",
      "OutstandingBucketLabel": "Over 120",
      "OutstandingBucketLabel4": "Over 90",
      "OutstandingAmountCurrent": null,
      "OutstandingAmount31To60": null,
      "OutstandingAmount61To90": null,
      "OutstandingAmountOver90": 13,
      "OutstandingAmount91To120": null,
      "OutstandingAmountOver120": 13,
      "AmountOverDue": 13,
      "AmountOverDueOver30Days": 13,
      "AmountOverDue15To30Days": null,
      "AmountOverDue8To14Days": null,
      "AmountOverDue1To7Days": null,
      "AmountDueToday": null,
      "AmountDue1To7Days": null,
      "AmountDue8To14Days": null,
      "AmountDue15To30Days": null,
      "AmountDue31To60Days": null,
      "AmountDue61To90Days": null,
      "AmountDueOver90Days": null,
      "LastUpdatedDate": "2022-12-09T07:38:56Z",
      "LastUpdatedUser": "GCPAY",
      "RecordCreatedDate": "2021-06-18T04:26:37Z",
      "RecordCreatedUser": "FLASHTRACTUSER",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/apinvoutstanding/2021262298",
          "name": "apinvoutstanding",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/apinvoutstanding/2021262298",
          "name": "apinvoutstanding",
          "kind": "item"
        }
      ]
    },
    {
      "CompanyCode": "001",
      "VendorCode": "HOLMES",
      "InvoiceCode": "0345.001-1",
      "InvoiceVoucherNum": 2021262945,
      "InvoiceDate": "2022-12-31",
      "DueDate": "2022-12-23",
      "PostedDate": "2022-12-09",
      "OutstandingAmount": 1049.75,
      "OutstandingBucketName": "Over 120 days",
      "OutstandingBucketName4": "Over 90 days",
      "OutstandingBucketLabel": "Over 120",
      "OutstandingBucketLabel4": "Over 90",
      "OutstandingAmountCurrent": null,
      "OutstandingAmount31To60": null,
      "OutstandingAmount61To90": null,
      "OutstandingAmountOver90": 1049.75,
      "OutstandingAmount91To120": null,
      "OutstandingAmountOver120": 1049.75,
      "AmountOverDue": 1049.75,
      "AmountOverDueOver30Days": 1049.75,
      "AmountOverDue15To30Days": null,
      "AmountOverDue8To14Days": null,
      "AmountOverDue1To7Days": null,
      "AmountDueToday": null,
      "AmountDue1To7Days": null,
      "AmountDue8To14Days": null,
      "AmountDue15To30Days": null,
      "AmountDue31To60Days": null,
      "AmountDue61To90Days": null,
      "AmountDueOver90Days": null,
      "LastUpdatedDate": "2023-02-07T02:51:07Z",
      "LastUpdatedUser": "GCPAY",
      "RecordCreatedDate": "2022-12-09T07:02:28Z",
      "RecordCreatedUser": "GCPAY",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/apinvoutstanding/2021262945",
          "name": "apinvoutstanding",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/apinvoutstanding/2021262945",
          "name": "apinvoutstanding",
          "kind": "item"
        }
      ]
    },
    {
      "CompanyCode": "001",
      "VendorCode": "90223",
      "InvoiceCode": "20200805",
      "InvoiceVoucherNum": 200797915,
      "InvoiceDate": "2020-08-05",
      "DueDate": "2020-09-04",
      "PostedDate": "2022-12-09",
      "OutstandingAmount": 9000,
      "OutstandingBucketName": "Over 120 days",
      "OutstandingBucketName4": "Over 90 days",
      "OutstandingBucketLabel": "Over 120",
      "OutstandingBucketLabel4": "Over 90",
      "OutstandingAmountCurrent": null,
      "OutstandingAmount31To60": null,
      "OutstandingAmount61To90": null,
      "OutstandingAmountOver90": 9000,
      "OutstandingAmount91To120": null,
      "OutstandingAmountOver120": 9000,
      "AmountOverDue": 9000,
      "AmountOverDueOver30Days": 9000,
      "AmountOverDue15To30Days": null,
      "AmountOverDue8To14Days": null,
      "AmountOverDue1To7Days": null,
      "AmountDueToday": null,
      "AmountDue1To7Days": null,
      "AmountDue8To14Days": null,
      "AmountDue15To30Days": null,
      "AmountDue31To60Days": null,
      "AmountDue61To90Days": null,
      "AmountDueOver90Days": null,
      "LastUpdatedDate": "2022-12-09T07:38:56Z",
      "LastUpdatedUser": "GCPAY",
      "RecordCreatedDate": "2020-08-05T01:15:29Z",
      "RecordCreatedUser": "BILL",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/apinvoutstanding/200797915",
          "name": "apinvoutstanding",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/apinvoutstanding/200797915",
          "name": "apinvoutstanding",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 5,
  "hasMore": true,
  "limit": 5,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/apinvoutstanding",
      "name": "apinvoutstanding",
      "kind": "collection"
    }
  ]
}

example-1

Successful Response - Finder - selectInvoices

{
  "items": [
    {
      "CompanyCode": "001",
      "VendorCode": "HOLMES",
      "InvoiceCode": "YFKUJYHF-01",
      "InvoiceVoucherNum": 2021262722,
      "InvoiceDate": "2022-08-24",
      "DueDate": "2022-08-24",
      "PostedDate": "2022-08-24",
      "OutstandingAmount": 45000,
      "OutstandingBucketName": "Over 120 days",
      "OutstandingBucketName4": "Over 90 days",
      "OutstandingBucketLabel": "Over 120",
      "OutstandingBucketLabel4": "Over 90",
      "OutstandingAmountCurrent": null,
      "OutstandingAmount31To60": null,
      "OutstandingAmount61To90": null,
      "OutstandingAmountOver90": 45000,
      "OutstandingAmount91To120": null,
      "OutstandingAmountOver120": 45000,
      "AmountOverDue": 45000,
      "AmountOverDueOver30Days": 45000,
      "AmountOverDue15To30Days": null,
      "AmountOverDue8To14Days": null,
      "AmountOverDue1To7Days": null,
      "AmountDueToday": null,
      "AmountDue1To7Days": null,
      "AmountDue8To14Days": null,
      "AmountDue15To30Days": null,
      "AmountDue31To60Days": null,
      "AmountDue61To90Days": null,
      "AmountDueOver90Days": null,
      "LastUpdatedDate": "2023-02-07T02:51:07Z",
      "LastUpdatedUser": "GCPAY",
      "RecordCreatedDate": "2022-08-25T01:19:57Z",
      "RecordCreatedUser": "RYVIT",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/apinvoutstanding/2021262722",
          "name": "apinvoutstanding",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/apinvoutstanding/2021262722",
          "name": "apinvoutstanding",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 5,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/apinvoutstanding",
      "name": "apinvoutstanding",
      "kind": "collection"
    }
  ]
}

object

What's Next

Retrieve a Specific AP Insurance By VUUID

Retrieve Outstanding Invoice By Code

Query Standards

Finder

Select Invoices

Parameters

Select by Audit Date

By UUID

What's Next

Contact Us