API Catalog

Retrieve AP Vendor by Code

06 Jan 2026
5 Minutes to read

Print
Dark
Light

Retrieve AP Vendor by Code

Updated on 06 Jan 2026
5 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

Overview

A vendor is an entity a company purchases products or services from, resulting in invoices and payments. In CMiC, vendors are managed under a Business Partner record, which can represent either a vendor or a customer. A vendor record is typically created alongside the Business Partner to store vendor-specific details.This endpoint allows you to create, update, and query vendor records in CMiC.

Notes

Before creating a vendor using apvendor, a Business Partner record must already exist in CMiC. To create one, use the Business Partners API.

Financials > Accounts Payable > Setup > Maintain Vendors

Reference Article

Maintain Business Partners

Maintain Vendors

Path Parameters

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

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

apvendor Finders

Finder	Parameter	Data Type	Data Length	Description	Example
ApVendorFinder	BpCode	string	8	This finder parameter queries vendors by Vendor Code. Can be combined with optional parameters ‘CompCode’.	/ap-rest-api/rest/1/apvendor?finder=ApVendorFinder;BpCode=0503
ApVendorFinder	CompCode	string	8	This finder parameter queries vendors by Company Code. Can be combined with optional parameters ‘BpCode’.	/ap-rest-api/rest/1/apvendor?finder=ApVendorFinder;CompCode=001
PrimaryKey	BpvenVUuid	string	64	This finder parameter queries a single vendor record by Vuuid.	/ap-rest-api/rest/1/apvendor?finder=PrimaryKey;BpvenVUuid=DAE791A7EDD23B74E053B08610AC6559
findByCompany	auditDate	datetime	YYYY-MM-DD	This finder parameter queries vendors 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 vendor data pull. Can be combined with optional parameter ‘companyCode’.	/ap-rest-api/rest/1/apvendor?finder=findByCompany;auditDate=2022-03-23
findByCompany	companyCode	string	8	This finder parameter queries vendors by Company Code. Can be combined with optional parameters ‘auditDate’.	/ap-rest-api/rest/1/apvendor?finder=findByCompany;companyCode=001
findByDate	auditDate	datetime	YYYY-MM-DD	This finder parameter queries vendors 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 vendor data pull. Can be combined with optional parameter ‘companyCode’.	ap-rest-api/rest/1/apvendor?finder=findByDate;auditDate=2022-08-09
findByDate	companyCode	string	8	This finder parameter queries vendors by Company Code. Can be combined with optional parameters ‘auditDate’.	/ap-rest-api/rest/1/apvendor?finder=findByDate;companyCode=001
selectByDate	auditDate	datetime	YYYY-MM-DD	This finder parameter queries vendors 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 vendor data pull. Can be combined with optional parameter ‘companyCode’.	/ap-rest-api/rest/1/apvendor?finder=selectByDate;auditDate=2022-08-09
selectByDate	companyCode	string	8	This finder parameter queries vendors by Company Code. Must be combined with parameters ‘auditDate’.	/ap-rest-api/rest/1/apvendor?finder=selectByDate;auditDate=2022-08-09,companyCode=001

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-23T19:13:46Z",
      "BpvenIuUpdateDate": "2022-08-23T21: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-23T19:13:46Z",
      "BpvenIuUpdateDate": "2023-08-04T02:32:23Z",
      "BpIuCreateDate": "2015-04-08T19:11:56Z",
      "BpIuUpdateDate": "2015-05-04T15: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

Overview

Notes

UI Navigation

Reference Article

Path Parameters

Query Standards

apvendor Finders

What's Next

Contact Us