---
title: "Create a Business Partner"
slug: "create-a-business-partner"
updated: 2026-05-26T12:48:31Z
published: 2026-05-26T12:48:45Z
canonical: "developers.cmicglobal.com/create-a-business-partner"
---
> ## Documentation Index
> Fetch the complete documentation index at: https://developers.cmicglobal.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Create a Business Partner
Post/sys-rest-api/rest/1/businesspartner
## Create Business Partners
UI Location: Maintain Business Partners
###
SecurityHTTPType basic
Basic authentication
Header parametersContent-TypestringExampleapplication/vnd.oracle.adf.resourceitem+json
Body parametersobject Example{
"BpCode": "BP1111",
"BpName": "Bus Partner 1111",
"BpDispatchFlag": "Y",
"BpAbbrevCode": "BP1111",
"BpPrequalRequiredFlag": "N",
"BpVUuid": ""
}BpCodestring Required
Business Partner Code
Max length8
BpDispatchFlagstring Required
Checked: Business Partner Is Being Used In Dispatch As Subcontractor Hauler
Max length1
BpPrequalRequiredFlagstring Required
Prequalification is required
Max length1
BpAbbrevCodestring Required
Abbreviation BP code for a partner
💻 UI Fieldname: Abbreviation
Max length8
BpVUuidstring Required
Unique uuid of row
Max length64
BpNamestring Required
Business Partner Name
Max length50
BpRegistrationCodestring
Government Registration Code
💻 UI Fieldname: Tax Registration Code
Max length30
BpVatRegistrationNumstring
VAT Registration Number
Max length30
BpRegionCodestring
State/Region Code
💻 UI Fieldname: State/Province
Max length4
BpVendorStatusFlagstring
Business Partner is a Vendor - Read only
💻 UI Fieldname: Vendor
Max length1
BpFaxstring
Fax Number
💻 UI Fieldname: Fax
Max length20
BpClvValueCode4Promptstring Max length30
BpClvValueCode1Promptstring Max length30
BpWebSitestring
Web site of the business partner
💻 UI Fieldname: Web Site
Max length200
BpUeValidFlagstring Max length1
BpIuUpdateDatestring
BpClassNamestring
Partner Class Name - Read only
Max length30
BpRegionNamestring
State/Region Name - Read only
Max length30
Bp1099Namestring
Partner 1099 Name - Read only
Max length30
BpAdd3string
Address Line 3
💻 UI Fieldname: City
Max length40
BpContactNamestring
Contact Name
💻 UI Fieldname: Attention
Max length30
BpCountrystring
Country Name
💻 UI Fieldname: Country
Max length30
BpIuCreateDatestring
BpPhonestring
Phone Nume
💻 UI Fieldname: Phone
Max length20
BpOneTimeFlagstring
One-time business partner [Ex.: One-time vendor]
Max length1
BpModFlagstring
Not Used - Set to 1
Max length1
BpEmailstring
Email Address
💻 UI Fieldname: Email
Max length80
BpTypeCodestring
Leave blank
Max length1
BpCustBalAmtnumber
Not Currently Used
Max length18
BpClvValueCode3Promptstring Max length30
BpParentCodestring
Controlling Busness Partner
💻 UI Fieldname: Ctrl Business Partner
Max length8
BpAdd2string
Address Line 2
💻 UI Fieldname: Suite
Max length40
Bp1099Codestring
Partner 1099 Code
💻 UI Fieldname: 1099
Max length1
BpClvValueCode6Promptstring Max length30
BpAdd1string
Address Line 1
💻 UI Fieldname: Address
Max length40
BpLegalentTypeNamestring
Legal Entiry Type Name - Read only
Max length30
BpVatCountryCodestring
VAT Registration country code
Max length5
BpCreateDefaultCustCompstring Max length8
BpClassCodestring
Partner Class Code
💻 UI Fieldname: Class
Max length4
BpActiveFlagstring
Business Partner is Active
💻 UI Fieldname: Active
Max length1
BpClvValueCode1string Max length16
BpClvValueCode2string Max length16
BpClvValueCode2Promptstring Max length30
BpClvValueCode3string Max length16
BpClvValueCode4string Max length16
BpClvValueCode5string Max length16
BpClvValueCode6string Max length16
BpLegalNamestring
Business Partner Legal Name
💻 UI Fieldname: Legal Name
Max length255
BpPostalCodestring
Zip/Postal Code
💻 UI Fieldname: ZIP/Postal Code
Max length13
BpLegalentTypeCodestring
Legal Entiry Type
💻 UI Fieldname: Legal Entity Type
Max length5
BpOmOnlyFlagstring Max length1
BpSysBpAutoNumberFlagstring
System flag that indicates if BP code is autogenerated - Read Only
Max length1
BpCreateDefaultVendorCompstring Max length8
BpStartDatestring
Start date of Business Partner
💻 UI Fieldname: Start Date
BpSsnFlagstring
Checked:Business Owner SSN Was Previously Entered As Taxpayer Identification Number
Max length1
BpParentNamestring
Controlling Business Partner Name - Read Only
Max length50
BpCustomerStatusFlagstring
💻 UI Fieldname: Customer
Max length1
BpLastUpdateDatestring
Date record was last updated
BpAkaNamestring
Also Known As Name
💻 UI Fieldname: Also Known As
Max length50
BpShortNamestring
Business Partner Short Name
Max length15
BpClvValueCode5Promptstring Max length30
Responses201
Created
HeadersContent-TypestringExampleapplication/vnd.oracle.adf.resourceitem+json
```json
{
"Bp1099Code": null,
"Bp1099Name": null,
"BpAbbrevCode": "BP1111",
"BpActiveFlag": null,
"BpAdd1": null,
"BpAdd2": null,
"BpAdd3": null,
"BpAkaName": null,
"BpClassCode": null,
"BpClassName": null,
"BpClvValueCode1": null,
"BpClvValueCode1Prompt": null,
"BpClvValueCode2": null,
"BpClvValueCode2Prompt": null,
"BpClvValueCode3": null,
"BpClvValueCode3Prompt": null,
"BpClvValueCode4": null,
"BpClvValueCode4Prompt": null,
"BpClvValueCode5": null,
"BpClvValueCode5Prompt": null,
"BpClvValueCode6": null,
"BpClvValueCode6Prompt": null,
"BpCode": "BP1111",
"BpContactName": null,
"BpCountry": null,
"BpCreateDefaultCustComp": null,
"BpCreateDefaultVendorComp": null,
"BpCustBalAmt": null,
"BpCustomerStatusFlag": null,
"BpDispatchFlag": "Y",
"BpEmail": null,
"BpFax": null,
"BpLegalName": null,
"BpLegalentTypeCode": null,
"BpLegalentTypeName": null,
"BpModFlag": null,
"BpName": "Bus Partner 1111",
"BpOmOnlyFlag": null,
"BpOneTimeFlag": null,
"BpParentCode": null,
"BpParentName": null,
"BpPhone": null,
"BpPostalCode": null,
"BpPrequalRequiredFlag": "N",
"BpRegionCode": null,
"BpRegionName": null,
"BpRegistrationCode": null,
"BpShortName": null,
"BpSsnFlag": null,
"BpStartDate": null,
"BpSysBpAutoNumberFlag": null,
"BpTypeCode": null,
"BpUeValidFlag": null,
"BpVUuid": "EFA62A1B15EA6F91E05316821FAC31E5",
"BpVatCountryCode": null,
"BpVatRegistrationNum": null,
"BpVendorStatusFlag": null,
"BpWebSite": null,
"BpIuCreateDate": null,
"BpIuUpdateDate": null,
"links": [
{
"rel": "self",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestupg/sys-rest-api/rest/1/businesspartner/EFA62A1B15EA6F91E05316821FAC31E5",
"name": "businesspartner",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestupg/sys-rest-api/rest/1/businesspartner/EFA62A1B15EA6F91E05316821FAC31E5",
"name": "businesspartner",
"kind": "item"
}
]
}
```
object