API Catalog

Retrieve AP Vendor by Code

25 Sep 2024
3 Minutes to read

Print
Dark
Light

Retrieve AP Vendor by Code

Updated on 25 Sep 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/apvendor

Query Standards

Finder

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

ApVendorFinder
SelectByDate
By UUID

Select By ApVendorFinder

Recommended finder parameters. Refer to Query Parameters for example.

Parameter	Description	Sample
compCode	Company Code	001
bpCode	Business Partner Code	1031006

Select By Date

This is an optional finder for querying Vendors by Company Code and Audit Date.

Parameter	Description	Sample
companyCode	Company Code	001
AuditDate	Create or Update Date Time Filter	2022-12-20

By UUID

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

Parameter	Description	Sample
/VUUID	The VUuid attribute is the Unique row ID	/ap-rest-api/rest/1/apvendor/BD8E1726C30E2691E05316821FAC4947

Security

HTTP

Type basic

Basic authentication

Query parameters

finder

string

ExampleApVendorFinder;CompCode=001,BpCode=1031006

limit

integer

Example500

offset

integer

Example0

totalResults

boolean

Exampletrue

orderBy

string

ExampleBpvenBpCode:desc

Responses

200

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourcecollection+json

example-0

Successful Response - Finder - ApVendorFinder

{
  "items": [
    {
      "BpvenCompCode": "001",
      "BpvenCompName": "CMiC Construction Inc",
      "BpvenBpCode": "1031006",
      "BpvenBpName": "TMM Mechanical",
      "BpvenPayAdd1": "455 Northshore Blvd.",
      "BpvenPayAdd2": null,
      "BpvenPayAdd3": "Seattle",
      "BpvenPayRegionCode": "WA",
      "BpvenPayRegionName": null,
      "BpvenPayCountry": "USA",
      "BpvenPayPostalCode": "89209",
      "BpvenPayContactName": null,
      "BpvenPayPhone": "604-555-1212",
      "BpvenPayFax": "604-555-9999",
      "BpvenPayEmail": "AR@tmm.com",
      "BpvenWebSite": null,
      "BpvenBuyCode": null,
      "BpvenClassCode": "SUB",
      "BpvenClassName": "Subcontractor",
      "BpvenStatusCode": "T",
      "BpvenPrefCode": null,
      "BpvenPrefName": null,
      "BpvenTermCode": "NET30",
      "BpvenTermName": "Net 30",
      "Bpven1099Code": "X",
      "Bpven1099Name": "Exempt",
      "BpvenAltAddCode": null,
      "BpvenAltAddName": null,
      "BpvenShpinstDesc": null,
      "BpvenActiveFlag": "1",
      "Bpven5018RepFlag": "Y",
      "BpvenOneTimeFlag": "N",
      "BpvenUseApctrlComplFlag": null,
      "BpvenSpecialTermsFlag": "N",
      "BpvenOrdAdd1": "455 Northshore Blvd.",
      "BpvenOrdAdd2": null,
      "BpvenOrdAdd3": "Vancouver",
      "BpvenOrdRegionCode": "BC",
      "BpvenOrdCountry": "Canada",
      "BpvenOrdPostalCode": "V5K 0A1",
      "BpvenOrdContactName": null,
      "BpvenOrdPhone": "604-555-1212",
      "BpvenOrdFax": "604-555-9999",
      "BpvenOrdEmail": "AR@tmm.com",
      "BpvenCurrCode": "USD",
      "BpvenInvSerCode": null,
      "BpvenDistTypeCode": "J",
      "BpvenHldbkPc": 10,
      "BpvenAllowTranFlag": "1",
      "BpvenCheckMergeFlag": "N",
      "BpvenDiscreteChqFlag": "N",
      "BpvenPrenoteFlag": null,
      "BpvenTppayCode": null,
      "BpvenDefaultPayCode": "N",
      "BpvenEftFlag": "N",
      "BpvenEftEmail": null,
      "BpvenPrefContactMth": "E",
      "BpvenEmpNo": null,
      "BpvenBankCode": null,
      "BpvenBankAccNum1": null,
      "BpvenBankAccNum2": null,
      "BpvenBankAccNum3": null,
      "BpvenPaymodeId": null,
      "BpvenIbanNum": null,
      "BpvenSwiftBicCode": null,
      "BpvenApDeptCode": "00",
      "BpvenApAccCode": "21011",
      "BpvenCashDeptCode": "00",
      "BpvenCashAccCode": "10001",
      "BpvenExpDeptCode": "00",
      "BpvenExpAccCode": "50050",
      "BpvenPpeDeptCode": "00",
      "BpvenPpeAccCode": "21013",
      "BpvenDiscDeptCode": "00",
      "BpvenDiscAccCode": "79020",
      "BpvenHldbkDeptCode": "00",
      "BpvenHldbkAccCode": "21012",
      "BpvenTax1Code": null,
      "BpvenTaxlic1": null,
      "BpvenTax2Code": null,
      "BpvenTaxlic2": null,
      "BpvenTax3Code": null,
      "BpvenTaxlic3": null,
      "BpvenTax4Code": null,
      "BpvenTaxlic4": null,
      "BpvenTax5Code": null,
      "BpvenTaxlic5": null,
      "BpvenVUuid": "BD8E1726C9D82691E05316821FAC4947",
      "BpvenIuCreateDate": "2015-04-23T07:13:46Z",
      "BpvenIuUpdateDate": "2022-08-23T09:49:52Z",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/apvendor/BD8E1726C9D82691E05316821FAC4947",
          "name": "apvendor",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/apvendor/BD8E1726C9D82691E05316821FAC4947",
          "name": "apvendor",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/apvendor",
      "name": "apvendor",
      "kind": "collection"
    }
  ]
}

example-1

Successful Response - Finder - findByDate

{
  "items": [
    {
      "BpvenCompCode": "001",
      "BpvenCompName": "CMiC Construction Inc",
      "BpvenBpCode": "1031006",
      "BpvenBpName": "TMM Mechanical",
      "BpvenPayAdd1": "455 Northshore Blvd.",
      "BpvenPayAdd2": null,
      "BpvenPayAdd3": "Seattle",
      "BpvenPayRegionCode": "WA",
      "BpvenPayRegionName": null,
      "BpvenPayCountry": "USA",
      "BpvenPayPostalCode": "89209",
      "BpvenPayContactName": null,
      "BpvenPayPhone": "604-555-1212",
      "BpvenPayFax": "604-555-9999",
      "BpvenPayEmail": "AR@tmm.com",
      "BpvenWebSite": null,
      "BpvenBuyCode": null,
      "BpvenClassCode": "SUB",
      "BpvenClassName": "Subcontractor",
      "BpvenStatusCode": "T",
      "BpvenPrefCode": null,
      "BpvenPrefName": null,
      "BpvenTermCode": "NET30",
      "BpvenTermName": "Net 30",
      "Bpven1099Code": "X",
      "Bpven1099Name": "Exempt",
      "BpvenAltAddCode": null,
      "BpvenAltAddName": null,
      "BpvenShpinstDesc": null,
      "BpvenActiveFlag": "1",
      "Bpven5018RepFlag": "Y",
      "BpvenOneTimeFlag": "N",
      "BpvenUseApctrlComplFlag": null,
      "BpvenSpecialTermsFlag": "N",
      "BpvenOrdAdd1": "455 Northshore Blvd.",
      "BpvenOrdAdd2": null,
      "BpvenOrdAdd3": "Vancouver",
      "BpvenOrdRegionCode": "BC",
      "BpvenOrdCountry": "Canada",
      "BpvenOrdPostalCode": "V5K 0A1",
      "BpvenOrdContactName": null,
      "BpvenOrdPhone": "604-555-1212",
      "BpvenOrdFax": "604-555-9999",
      "BpvenOrdEmail": "AR@tmm.com",
      "BpvenCurrCode": "USD",
      "BpvenInvSerCode": null,
      "BpvenDistTypeCode": "J",
      "BpvenHldbkPc": 10,
      "BpvenAllowTranFlag": "1",
      "BpvenCheckMergeFlag": "N",
      "BpvenDiscreteChqFlag": "N",
      "BpvenPrenoteFlag": null,
      "BpvenTppayCode": null,
      "BpvenDefaultPayCode": "N",
      "BpvenEftFlag": "N",
      "BpvenEftEmail": null,
      "BpvenPrefContactMth": "E",
      "BpvenEmpNo": null,
      "BpvenBankCode": null,
      "BpvenBankAccNum1": null,
      "BpvenBankAccNum2": null,
      "BpvenBankAccNum3": null,
      "BpvenPaymodeId": null,
      "BpvenIbanNum": null,
      "BpvenSwiftBicCode": null,
      "BpvenApDeptCode": "00",
      "BpvenApAccCode": "21011",
      "BpvenCashDeptCode": "00",
      "BpvenCashAccCode": "10001",
      "BpvenExpDeptCode": "00",
      "BpvenExpAccCode": "50050",
      "BpvenPpeDeptCode": "00",
      "BpvenPpeAccCode": "21013",
      "BpvenDiscDeptCode": "00",
      "BpvenDiscAccCode": "79020",
      "BpvenHldbkDeptCode": "00",
      "BpvenHldbkAccCode": "21012",
      "BpvenTax1Code": null,
      "BpvenTaxlic1": null,
      "BpvenTax2Code": null,
      "BpvenTaxlic2": null,
      "BpvenTax3Code": null,
      "BpvenTaxlic3": null,
      "BpvenTax4Code": null,
      "BpvenTaxlic4": null,
      "BpvenTax5Code": null,
      "BpvenTaxlic5": null,
      "BpvenVUuid": "BD8E1726C9D82691E05316821FAC4947",
      "BpvenIuCreateDate": "2015-04-23T07:13:46Z",
      "BpvenIuUpdateDate": "2023-08-04T02:32:23Z",
      "BpIuCreateDate": "2015-04-08T07:11:56Z",
      "BpIuUpdateDate": "2015-05-04T03:51:56Z",
      "BpvenEftPaymentType": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/apvendor/BD8E1726C9D82691E05316821FAC4947",
          "name": "apvendor",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/apvendor/BD8E1726C9D82691E05316821FAC4947",
          "name": "apvendor",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ap-rest-api/rest/1/apvendor",
      "name": "apvendor",
      "kind": "collection"
    }
  ]
}

object

What's Next

Create an AP Registered Invoice

Retrieve AP Vendor by Code

Query Standards

Finder

Select By ApVendorFinder

Select By Date

By UUID

What's Next

Contact Us