Create a AP Vendor

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!

Post

/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

apvendor Attributes (required)

CMiC UI Fieldname	Object	Name	Description	Type	Data Length	Example
Vendor Company Code	apvendor	BpvenCompCode	This is the company the vendor belongs. This must be a VALID CMiC Company Code that has already be setup in Accounts Payable.	string	8	001
Business Partner Code	apvendor	BpvenBpCode	This is the Business Partner the vendor was created from. This must be a VALID CMiC Business Partner, and pre-exist before creating the vendor record.	string	8	BNSRIG
Vendor Terms Code	apvendor	BpvenTermCode	Payment terms determine the default due date, discount date, percent, and retainage percent used during invoice entry. This field defaults from the AP Control file, but can be changed as required. This must be a VALID CMiC payment Terms Code for the company entered in ‘BpvenCompCode’.	string	6	NET30
Vendor Special Terms and Conditions	apvendor	BpvenSpecialTermsFlag	Check this box to indicate that special contract terms and conditions are associated with the vendor.	string	1	Y/N
Vendor Currency Code	apvendor	BpvenCurrCode	This is the vendor currency code. When a vendor is created, the system creates the vendor with the same currency as the company. If the currency is changed, the system will verify that the cash account matches the currency code. When the accounts do not match, the currency of the cash account will have to be changed.	string	3	USD
Vendor Check Merge Flag	apvendor	BpvenCheckMergeFlag	This flag allows this vendor to merge payments with another company. It is the same vendor for check printing	string	1	Y/N
Vendor Department Code	apvendor	BpvenApDeptCode	Enter the department and account number to be used by the Accounts Payable system for automatic General Ledger distributions for this vendor.	string	6	00
Vendor Account Code	apvendor	BpvenApAccCode	Enter the department and account number to be used by the Accounts Payable system for automatic General Ledger distributions for this vendor.	string	16	21011
Vendor Cash Department Code	apvendor	BpvenCashDeptCode	Enter the department and account number to be used by the Accounts Payable system for automatic General Ledger distributions affecting the cash account for this vendor. This is the bank account from which payments to the vendor will be made.	string	6	00
Vendor Cash Account Code	apvendor	BpvenCashAccCode	Enter the department and account number to be used by the Accounts Payable system for automatic General Ledger distributions affecting the cash account for this vendor. This is the bank account from which payments to the vendor will be made.	string	16	10001
Vendor Expense Department Code	apvendor	BpvenExpDeptCode	This is the default department for vouchers charged directly to the GL for this vendor. This must be a VALID CMiC department code.	string	6	00
Vendor Expense Account Code	apvendor	BpvenExpAccCode	This is the default expense account for this vendor that will be used by the system if the voucher being entered is a direct GL expense type of voucher. This must be a VALID CMiC account.	string	16	79010
Vendor Prepaid expenses Department Code	apvendor	BpvenPpeDeptCode	Enter the department and account number to be used by the Accounts Payable system for automatic General Ledger distributions that affect the expense for this vendor.	string	6	00
Vendor Prepaid expenses Account Code	apvendor	BpvenPpeAccCode	Enter the department and account number to be used by the Accounts Payable system for automatic General Ledger distributions that affect the expense for this vendor.	string	16	21013
Vendor Discount Department Code	apvendor	BpvenDiscDeptCode	This is the department code that any discounts taken with this vendor will be captured. This must be a VALID CMiC department code. The department and account number are used by the Accounts Payable system for automatic General Ledger distributions of discounts for this vendor.	string	6	00
Vendor Discount Account Code	apvendor	BpvenDiscAccCode	This is the account where discounts taken with this vendor will be recorded. This must be a VALID CMiC account. The department and account number are used by the Accounts Payable system for automatic General Ledger distributions of discounts for this vendor.	string	16	79020
Vendor Retainage Department Code	apvendor	BpvenHldbkDeptCode	This is the default department that will be used to record retainage held for the vendor. This must be a VALID CMiC department code. The department and account number to be used by the Accounts Payable module for automatic General Ledger distributions of retainage for this vendor.	string	6	00
Vendor Retainage Account Code	apvendor	BpvenHldbkAccCode	This is the account that will be used to record retainage held by this vendor. This must be a VALID CMiC Account. The department and account number to be used by the Accounts Payable module for automatic General Ledger distributions of retainage for this vendor.	string	16	21012

Security

HTTP

Type basic

Basic authentication

Header parameters

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourceitem+json

Body parameters

object

Example{ "BpvenCompCode": "MAIC", "BpvenBpCode": "BP0022", "BpvenCheckMergeFlag": "N", "BpvenSpecialTermsFlag": "N", "BpvenTermCode": "NET30", "BpvenCurrCode": "CAD", "BpvenApDeptCode": "00", "BpvenApAccCode": "21015", "BpvenCashDeptCode": "00", "BpvenCashAccCode": "10101", "BpvenExpDeptCode": "00", "BpvenExpAccCode": "50050", "BpvenPpeDeptCode": "00", "BpvenPpeAccCode": "21018", "BpvenDiscDeptCode": "00", "BpvenDiscAccCode": "79020", "BpvenHldbkDeptCode": "00", "BpvenHldbkAccCode": "21017", "BpvenVUuid": "" }

Responses

201

Created

Headers