Create a BP Address
- 13 Jun 2025
- 5 Minutes to read
- Print
- DarkLight
Create a BP Address
- Updated on 13 Jun 2025
- 5 Minutes to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Post
/sys-rest-api/rest/1/bpaddresses
Overview
This endpoint contains the address details for business partners in CMiC. The term 'business partner' encompasses Vendors, Customers, and other relevant entities.
UI Navigation
Financials > Accounts Payable > Setup > Maintain Business Partners
Knowledge Base Article
Commonly Used Body Parameters
| CMiC UI Fieldname | Object | Name | Description | Type | Data Length | Example | Required |
|---|---|---|---|---|---|---|---|
| Primary Address (Checkbox) | bpaddresses | BpadAddPrimaryFlag | Indicates whether the address is designated as the primary address for the business partner. Set to "Y" for Yes (primary) and "N" for No (not primary). | string | 1 | Y | Yes |
| Address Code | bpaddresses | BpadAddTypeCode | Assigns a unique code identifying each address record within the bpaddresses object, enabling differentiation between various addresses of a given business partner. It corresponds to the Address Code field in the Business Partner Maintenance screen. This code will automatically be converted to uppercase on insert. | string | 5 | MAIN | Yes |
| Business Partner Code | bpaddresses | BpadBpCode | Represents the unique code pre-assigned to a business partner within the CMiC system. This field serves as Key Value 1 in the Business Partner Maintenance screen, ensuring each business entity is distinctly identifiable within the system. | string | 8 | 001ST | Yes |
| Address Line 1 | bpaddresses | BpadAdd1 | Contains the first line of the business partner's address. This typically includes the street address or PO Box number. | string | 40 | 4800 keele st | No |
| VUUID | bpaddresses | BpadVUuid | A UUID (Unique Universal Identifier). A 128-bit unique identifier used to identify a business partner address row. Can we used to query a previously created business partner record. | string | 64 | B46794D108F9CF54E0530100007F8E27 | No |
Other (Optional) Body Parameters
| CMiC UI Fieldname | Object | Name | Description | Type | Data Length | Example | Required |
|---|---|---|---|---|---|---|---|
| Active (checkbox) | bpaddresses | BpadActiveFlag | Indicates the current status of the address record. Check this box if the address is active or current. Set to "Y" to mark the address as active. Set to "N" to mark the address as inactive. | string | 1 | Y | No |
| Address Line 2 | bpaddresses | BpadAdd2 | Address line 2 contains additional address information. Typically used for suite or apartment numbers. | string | 40 | 100 | No |
| Address Line 3 | bpaddresses | BpadAdd3 | Address line 3 contains additional address line informaiton. Typically used for the city or township of the address | string | 40 | Chicago | No |
| Add Email | bpaddresses | BpadAddEmail | Stores the email address of the main contanct associated with the business partner address. | string | 80 | ADD2@BPaddress.ca | No |
| Fax | bpaddresses | BpadAddFax | Stores the fax number for the business partner address record. | string | 20 | (239) 555-5000 | No |
| Address Name | bpaddresses | BpadAddName | Provides a descriptive name or label for the address, aiding in easy identification of the address among multiple addresses associated with a business partner. Example names include "Secondary BP Address Info". | string | 30 | Shipping Address | No |
| Phone | bpaddresses | BpadAddPhone | Stores the primary phone number for the a given address. | string | 20 | 323-418-3559 | No |
| Phone 2 | bpaddresses | BpadAddPhone2 | Contains an alternate phone number for the business partner's address, providing an additional contact option if needed. | string | 20 | (239) 555-3333 | No |
| Bill To (checkbox) | bpaddresses | BpadBillToFlag | Indicates whether items are billed to the address for the business partner. Set to "Y" to indicate that items are billed to the billing address. | string | 1 | Y | No |
| Business Partner Name | bpaddresses | BpadBpName | The name of the business partner specified under BpadBPCode | string | 50 | null | No |
| Business Parner Vendor Name | bpaddresses | BpadBpVenName | Enter the Business Partner AP Vendor Name. This name is the name used throughout the system, wherever business partner (vendor or customer) objects are available. This field is next to the Business Partner Code and serves as Key Value 2 in the Business Partner Maintenance screen. | string | 50 | Aetna Insurance | No |
| Company Code | bpaddresses | BpadCompCode | The company code of the business partner assigned in the system this address belongs to. | string | 8 | ZZ | No |
| Company Name | bpaddresses | BpadCompName | The Name of the company specified under BpadCompCode | string | 30 | Supreme Utilitarian Selections | No |
| Attention (ie. Contact Name) | bpaddresses | BpadContactName | The name of the primary contact associated with the business partner's address. | string | 50 | Rob Cementer | No |
| Country | bpaddresses | BpadCountry | The country where the business partner's address is located. | string | 30 | USA | No |
| Create Date | bpaddresses | BpadIuCreateDate | Create Date - The timestamp indicating when the address record was created for the cost code in a job through an update. | datetime | 2016-10-19T11:12:32-04:00 | No | |
| Create User | bpaddresses | BpadIuCreateUser | The username of the individual who created the address record. This field aids in auditing and tracking changes within the system. | string | 30 | LORIGIB | No |
| Update Date | bpaddresses | BpadIuUpdateDate | Update Date - The timestamp indicating the last time the address record was updated. An example of an Integration Update is "2024-10-23T10:49:35-04:00" which shows the last update times. | datetime | 2024-01-24T06:58:29-05:00 | No | |
| Update User | bpaddresses | BpadIuUpdateUser | The username of the individual who last updated the address record. Essential for auditing and understanding who made recent changes to the record. | string | 30 | SHAMROCK | No |
| OM Only (checkbox) | bpaddresses | BpadOmOnlyFlag | Signifies if this address should only be used within the opportunity module. Set to "Y" for Yes, meaning this address is only available in Opportunity Management only. | string | 1 | N | No |
| Order From (Checkbox) | bpaddresses | BpadOrderFromFlag | Specifies whether orders can be placed from this address. Set to "Y" to enable order placement, or "N" to disable. | string | 1 | Y | No |
| Postal Code | bpaddresses | BpadPostalCode | The postal or ZIP code corresponding to the business partner's address. | string | 12 | 10025 | No |
| Region Code | bpaddresses | BpadRegionCode | The regional code (state or province) that corresponds to the business partner's address,. | string | 3 | IL | No |
| Remit To (checkbox) | bpaddresses | BpadRemitToFlag | Indicates whether payments should be remitted to this address. Set to "Y" for Yes, meaning this address is used for remittance purposes, or "N" for No. | string | 1 | N | No |
| Ship To (checkbox) | bpaddresses | BpadShipToFlag | Specifies whether shipments should be sent to this address. Set to "Y" for Yes, meaning this address is used for shipping purposes, or "N" for No. | string | 1 | Y | No |
| VUUID | bpaddresses | BpadVUuid | A UUID (Unique Universal Identifier). A 128-bit unique identifier used to identify a business partner address row. Can we used to query a previously created business partner record. | string | 64 | B46794D108F9CF54E0530100007F8E27 | No |
Security
HTTP
Type basic
Basic authentication
Header parameters
Content-Type
string
Exampleapplication/vnd.oracle.adf.resourceItem+json
Body parameters
object
Example{ "BpadAddTypeCode": "ON", "BpadAddPrimaryFlag": "N", "BpadBpCode": "CAD", "BpadAdd1": "4800 keele st", "BpadVUuid": "" }
Responses
201
Created
Headers
Content-Type
string
Exampleapplication/vnd.oracle.adf.resourceitem+json
{
"BpadActiveFlag": null,
"BpadAdd1": "4800 keele st",
"BpadAdd2": null,
"BpadAdd3": null,
"BpadAddEmail": null,
"BpadAddFax": null,
"BpadAddName": null,
"BpadAddPhone": null,
"BpadAddPhone2": null,
"BpadAddPrimaryFlag": "N",
"BpadAddTypeCode": "ON",
"BpadBillToFlag": null,
"BpadBpCode": "CAD",
"BpadBpName": null,
"BpadBpVenName": null,
"BpadCompCode": null,
"BpadCompName": null,
"BpadContactName": null,
"BpadCountry": null,
"BpadIuCreateDate": null,
"BpadIuCreateUser": null,
"BpadIuUpdateDate": null,
"BpadIuUpdateUser": null,
"BpadName2": null,
"BpadName3": null,
"BpadName4": null,
"BpadOmOnlyFlag": null,
"BpadOrderFromFlag": null,
"BpadPostalCode": null,
"BpadRegionCode": null,
"BpadRemitToFlag": null,
"BpadShipToFlag": null,
"BpadVUuid": "F26706F8360652F4E05316821FACACA4",
"links": [
{
"rel": "self",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/F26706F8360652F4E05316821FACACA4",
"name": "bpaddresses",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/F26706F8360652F4E05316821FACACA4",
"name": "bpaddresses",
"kind": "item"
}
]
}object