> ## 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. # Retrieve BP Address By Code > ## 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 ## Reference Article ## Path Parameters | Parameter | Description | Example | | --- | --- | --- | | /VUUID | The VUuid attribute is the Unique row ID | /sys-rest-api/rest/1/bpaddresses/BF1E63D248F2569AE053B08610AC1750 | ## 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](https://developers.cmicglobal.com/v1/docs/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](https://developers.cmicglobal.com/v1/docs/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](https://developers.cmicglobal.com/v1/docs/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](https://developers.cmicglobal.com/v1/docs/best-practice-data-filtering-requirements) | ## bpaddresses Finders | Finder | Parameter | Data Type | Data Length | Description | Example | | --- | --- | --- | --- | --- | --- | | PrimaryKey | BpadVUuid | string | 64 | This is an optional finder for querying a specific equipment rate by row ID. | /sys-rest-api/rest/1/bpaddresses/BF1E63D248F2569AE053B08610AC1750 | | selectByBPCode | businessPartner | string | | This finder allows you to filter results based on the Business Partner code (BpadBpCode). | selectByBPCode; businessPartner=ZZ-ACME | | selectByBPCodeAddress | Partner Code, addressType | string | | This finder allows you to filter results based on both the Business Partner Code (BpadBpCode) and the addressType (BpadAddTypeCode) | /sys-rest-api/rest/1/bpaddresses?finder=selectByBPCodeAddress; businessPartner=ZZ-ACME, addressType=TOR | | selectByBPDate | Bpdate | datetime | | This finder is designed to help you locate business partners by specifying the last update date (BpadIuUpdateDate). When you use this finder, it will display results for business partners whose details have been updated from the entered date onwards. | /sys-rest-api/rest/1/bpaddresses?finder=selectByBPDate; Bpdate=2019-12-20 | ## bpaddresses Attributes | CMiC UI Fieldname | Object | Name | Description | Type | Data Length | Example | | --- | --- | --- | --- | --- | --- | --- | | 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 | | 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 | | 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 | | 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 | | 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 | | Address Line 2 | bpaddresses | BpadAdd2 | Address line 2 contains additional address information. Typically used for suite or apartment numbers. | string | 40 | 100 | | 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 | | Add Email | bpaddresses | BpadAddEmail | Stores the email address of the main contanct associated with the business partner address. | string | 80 | | | Fax | bpaddresses | BpadAddFax | Stores the fax number for the business partner address record. | string | 20 | (239) 555-5000 | | 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 | | Phone | bpaddresses | BpadAddPhone | Stores the primary phone number for the a given address. | string | 20 | 323-418-3559 | | 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 | | 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 | | Business Partner Name | bpaddresses | BpadBpName | The name of the business partner specified under BpadBPCode | string | 50 | null | | 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 | | Company Code | bpaddresses | BpadCompCode | The company code of the business partner assigned in the system this address belongs to. | string | 8 | ZZ | | Company Name | bpaddresses | BpadCompName | The Name of the company specified under BpadCompCode | string | 30 | Supreme Utilitarian Selections | | Attention (ie. Contact Name) | bpaddresses | BpadContactName | The name of the primary contact associated with the business partner's address. | string | 50 | Rob Cementer | | Country | bpaddresses | BpadCountry | The country where the business partner's address is located. | string | 30 | USA | | 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 | | 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 | | 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 | | 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 | | 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 | | 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 | | Postal Code | bpaddresses | BpadPostalCode | The postal or ZIP code corresponding to the business partner's address. | string | 12 | 10025 | | Region Code | bpaddresses | BpadRegionCode | The regional code (state or province) that corresponds to the business partner's address,. | string | 3 | IL | | 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 | | 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 | | 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 | | 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 | | 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 | | Business Parner 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 | ## OpenAPI ````json GET /sys-rest-api/rest/1/bpaddresses { "openapi": "3.0.0", "info": { "title": "API Catalog", "description": "", "version": "1.0.0" }, "servers": [ { "url": "https://mobtest.cmiccloudr12.com/cmictestrti", "description": "CMIC API Server" } ], "security": [ { "cmicBasicAuth": [] } ], "tags": [ { "name": "Highlights" }, { "name": "Asset Management | Equipment" }, { "name": "Asset Management | Fixed Assets" }, { "name": "Asset Management | Purchase Order" }, { "name": "Asset Management | Inventory" }, { "name": "Asset Management | Requisition" }, { "name": "Asset Management | Purchase Change Order" }, { "name": "Bim Model" }, { "name": "Bim Model Revision" }, { "name": "Bim Tag Model" }, { "name": "Bim Tags" }, { "name": "Bim FileUpload Jersey" }, { "name": "Core System | Business Partners" }, { "name": "Core System | Business Partner Addresses" }, { "name": "Core System | Bank" }, { "name": "Core System | Currency" }, { "name": "Core System | Exchange Rates" }, { "name": "Core System | Global Table Text Codes" }, { "name": "Core System | Global Table Regions" }, { "name": "Core System | Terms" }, { "name": "Core System | System Contact" }, { "name": "Core System | Weight Measures" }, { "name": "Core System | Field User Defined Classifiers" }, { "name": "Core System | User Defined Classifiers by Object" }, { "name": "Core System | User Extension Definitions by Object" }, { "name": "Core System | User Extention Field Data Value" }, { "name": "Core System | User Extension Values by Object" }, { "name": "Core System | User System Role" }, { "name": "Core System | User Project Role" }, { "name": "Core System | Documents by Object" }, { "name": "Core System | Audit Status Log by Object" }, { "name": "Core System | Licensed Users" }, { "name": "Core System | Company Access" }, { "name": "Core System | Copy User Settings" }, { "name": "Core System | User Maintenance" }, { "name": "Core System | User Roles" }, { "name": "Core System | Security Groups" }, { "name": "Core System | Job/Project Security" }, { "name": "Core System | Weight Measure with Conversions Code" }, { "name": "Core System | Weight Measure Conversions Code" }, { "name": "Core System | User-defined-fields" }, { "name": "Core System | User-extension" }, { "name": "ECM and Workflow | Image Manager" }, { "name": "Financials | General Ledger" }, { "name": "Financials | Accounts Payable" }, { "name": "Financials | Accounts Receivable" }, { "name": "Preventative Maintenance | Issue Work Orders" }, { "name": "Preventative Maintenance | Issue Work Items" }, { "name": "Preventative Maintenance | Issue Work Budgets" }, { "name": "Preventative Maintenance | Issue Priorities" }, { "name": "Preventative Maintenance | Issue Status" }, { "name": "Preventative Maintenance | Issue Types" }, { "name": "Preventative Maintenance | Accumulative Equipment" }, { "name": "Preventative Maintenance | Work Orders" }, { "name": "Preventative Maintenance | Work Items" }, { "name": "Preventative Maintenance | Work Budgets" }, { "name": "Preventative Maintenance | Priorities" }, { "name": "Preventative Maintenance | Tasks" }, { "name": "HCM | UKG Pay Deductions" }, { "name": "HCM | UKG Pay Earnings" }, { "name": "HCM | UKG Pay Headers" }, { "name": "HCM | UKG Pay Taxes" }, { "name": "HCM | Payroll Geographical States" }, { "name": "HCM | Payroll Trades" }, { "name": "HCM | Payroll Union" }, { "name": "HCM | Payroll Pay Runs" }, { "name": "HCM | Payroll Pay Groups" }, { "name": "HCM | Payroll Tax" }, { "name": "HCM | Payroll Worker Compensation" }, { "name": "HCM | Payroll Work Locations" }, { "name": "HCM | Payroll Trade Pay Rates" }, { "name": "HCM | Payroll Union Pay Rates" }, { "name": "HCM | Payroll Job Pay Rates" }, { "name": "HCM | Payroll Master Benefits" }, { "name": "HCM | Payroll Master Deductions" }, { "name": "HCM | Payroll Ben/Ded/Leave Base Codes" }, { "name": "HCM | Payroll Ben/Ded Plans" }, { "name": "HCM | Payroll Ben/Ded Plan Options" }, { "name": "HCM | Payroll Company Benefits" }, { "name": "HCM | Payroll Company Deductions" }, { "name": "HCM | Payroll Vertex Geographic Locations" }, { "name": "HCM | Payroll Checks" }, { "name": "HCM | Payroll Timesheets" }, { "name": "HCM | Employee" }, { "name": "HCM | Employee (Minimum payload)" }, { "name": "HCM | Employee History" }, { "name": "HCM | Tax Exemptions" }, { "name": "HCM | Employee Tax Overrides" }, { "name": "HCM | Employee Pay Splits" }, { "name": "HCM | Employee Benefits" }, { "name": "HCM | Employee Clock In and Out" }, { "name": "HCM | Employee Deductions" }, { "name": "HCM | Employee Leaves" }, { "name": "HCM | Employee Leave History" }, { "name": "HCM | Employee Hour Types" }, { "name": "HCM | Employee Pay History" }, { "name": "HCM | Employee Work Statuses" }, { "name": "HCM | Employee Security Group" }, { "name": "HCM | Crewtime Crew" }, { "name": "HCM | Crewtime Employee Timesheet" }, { "name": "HCM | Crewtime Equipment Timesheet" }, { "name": "HCM | Crew Maintenance Activity Assignment" }, { "name": "HCM | Crew Maintenance Member Assignment" }, { "name": "HCM | Crew Maintenance Member Trade and Union Assignment" }, { "name": "HCM | Crew Maintenance Equipment Assignment" }, { "name": "HCM | Crew Maintenance Equipment Detail Assignment" }, { "name": "HCM | HR Requisitions" }, { "name": "HCM | HR Relations" }, { "name": "HCM | HR Employee Skills" }, { "name": "HCM | HR Incident" }, { "name": "HCM | HR Employee Relatives / Dependents" }, { "name": "HCM | HR Employee Positions" }, { "name": "HCM | HR Applicants" }, { "name": "HCM | HR Applications" }, { "name": "HCM | Vertex Location City" }, { "name": "HCM | HR Application History" }, { "name": "HCM | HR Dependent Benefits" }, { "name": "HCM | HR Dependent Deductions" }, { "name": "HCM | HR Employee Elected Plans" }, { "name": "HCM | HR Employee Training Certifications" }, { "name": "HCM | HR Trainings" }, { "name": "HCM | E-Timesheets" }, { "name": "HCM | System Contacts" }, { "name": "HCM | System User Payroll Security Group" }, { "name": "HCM | Payroll Timesheet Posting" }, { "name": "HCM | CrewTimesheet Posting" }, { "name": "HCM | HR Positions Master" }, { "name": "HCM | Payroll Pay Periods" }, { "name": "HCM | Payroll Rate Codes" }, { "name": "HCM | Payroll Overhead Codes and Rates" }, { "name": "HCM | Payroll Assigned Overhead to Jobs" }, { "name": "Materials Management | Material Sale Orders" }, { "name": "Materials Management | Material Sale Orders Details" }, { "name": "Materials Management | Truck Rate Detail" }, { "name": "Opportunity Management | Competitors" }, { "name": "Opportunity Management | Opportunities" }, { "name": "Opportunity Management | Revenue Details" }, { "name": "Opportunity Management | Opportunity History" }, { "name": "Opportunity Management | Organization" }, { "name": "Project Controls | Job Billing" }, { "name": "Project Controls | Job Cost" }, { "name": "Project Controls | PCI Details" }, { "name": "Project Controls | Unposted PCI Details" }, { "name": "Project Controls | PCI Headers" }, { "name": "Project Controls | Owner Change Orders" }, { "name": "Project Controls | CM Statuses" }, { "name": "Project Controls | CM Types" }, { "name": "Project Controls | CM Vendor Details" }, { "name": "Project Controls | Post PCI" }, { "name": "Project Management | Uploading Documents" }, { "name": "Project Management | Downloading Documents" }, { "name": "Project Management | Foreign Bid Item Imports" }, { "name": "Project Management | Communications" }, { "name": "Project Management | Daily Journals" }, { "name": "Project Management | Communications Types" }, { "name": "Project Management | Daily Journal Daily Work Plans" }, { "name": "Project Management | Daily Journal Field Forces" }, { "name": "Project Management | Daily Journal Labour" }, { "name": "Project Management | Daily Journal Materials" }, { "name": "Project Management | Daily Journal Owner Equipment" }, { "name": "Project Management | Daily Journal Quality Control" }, { "name": "Project Management | Daily Journal Tasks" }, { "name": "Project Management | Daily Journal Trade Equipment" }, { "name": "Project Management | Daily Journal Transactions" }, { "name": "Project Management | Daily Journal User Defined Data" }, { "name": "Project Management | Daily Journal Visitors" }, { "name": "Project Management | Daily Journal Bill Details" }, { "name": "Project Management | Field Work Directives" }, { "name": "Project Management | Contract Types" }, { "name": "Project Management | Company Contacts" }, { "name": "Project Management | Distribution BCC" }, { "name": "Project Management | Distribution CC" }, { "name": "Project Management | Field Work Directive Statuses" }, { "name": "Project Management | Issues" }, { "name": "Project Management | Key Players" }, { "name": "Project Management | Meetings" }, { "name": "Project Management | Meeting Attendees" }, { "name": "Project Management | Meeting Item Statuses" }, { "name": "Project Management | Meeting Tracks" }, { "name": "Project Management | Notes" }, { "name": "Project Management | Projects" }, { "name": "Project Management | Project Items" }, { "name": "Project Management | Project Item Phase Segment Sums" }, { "name": "Project Management | Project Partners" }, { "name": "Project Management | Notices" }, { "name": "Project Management | Notice Statuses" }, { "name": "Project Management | Owner JS Query" }, { "name": "Project Management | PCI Real Locations" }, { "name": "Project Management | Project Contacts" }, { "name": "Project Management | RFIs (Requests for Information)" }, { "name": "Project Management | RFI Statuses" }, { "name": "Project Management | Submittal Packages" }, { "name": "Project Management | Submittal Package Details" }, { "name": "Project Management | Submittal Package Status" }, { "name": "Project Management | Submittals" }, { "name": "Project Management | Submittal Status" }, { "name": "Project Management | Transmittals" }, { "name": "Project Management | Subcontract Headers" }, { "name": "Project Management | Subcontract Schedules" }, { "name": "Project Management | Subcontract Sechedule Phase Segment Sums" }, { "name": "Project Management | User Roles" }, { "name": "Project Management | Punchlists" }, { "name": "Project Management | Punchlist Details" }, { "name": "Project Management | Punchlist Statuses" }, { "name": "Project Management | Meeting Items" }, { "name": "Project Management | Self Perform Vendor" }, { "name": "Project Management | Submittal Types" }, { "name": "Project Management | Assign contact and partner to project" }, { "name": "Project Management | Subcontract Prequal" }, { "name": "Project Management | Bid Item Package" } ], "paths": { "/sys-rest-api/rest/1/bpaddresses": { "get": { "tags": [ "Core System | Business Partner Addresses" ], "summary": "Retrieve BP Address By Code", "description": "## Overview\n\nThis endpoint contains the address details for business partners in CMiC. The term 'business partner' encompasses Vendors, Customers, and other relevant entities.\n\n## UI Navigation\n\nFinancials > Accounts Payable > Setup > Maintain Business Partners \n\n## Reference Article\n\n\n\n## Path Parameters\n\n| Parameter | Description | Example |\n| --- | --- | --- |\n| /VUUID | The VUuid attribute is the Unique row ID | /sys-rest-api/rest/1/bpaddresses/BF1E63D248F2569AE053B08610AC1750 |\n\n## Query Standards\n\n| Key | Recommended | Description |\n| --- | --- | --- |\n| 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](https://developers.cmicglobal.com/v1/docs/best-practice-data-filtering-requirements) |\n| 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](https://developers.cmicglobal.com/v1/docs/best-practice-data-filtering-requirements) |\n| 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](https://developers.cmicglobal.com/v1/docs/best-practice-data-filtering-requirements) |\n| 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](https://developers.cmicglobal.com/v1/docs/best-practice-data-filtering-requirements) |\n\n## bpaddresses Finders\n\n| Finder | Parameter | Data Type | Data Length | Description | Example |\n| --- | --- | --- | --- | --- | --- |\n| PrimaryKey | BpadVUuid | string | 64 | This is an optional finder for querying a specific equipment rate by row ID. | /sys-rest-api/rest/1/bpaddresses/BF1E63D248F2569AE053B08610AC1750 |\n| selectByBPCode | businessPartner | string | | This finder allows you to filter results based on the Business Partner code (BpadBpCode). | selectByBPCode; businessPartner=ZZ-ACME |\n| selectByBPCodeAddress | Partner Code, addressType | string | | This finder allows you to filter results based on both the Business Partner Code (BpadBpCode) and the addressType (BpadAddTypeCode) | /sys-rest-api/rest/1/bpaddresses?finder=selectByBPCodeAddress; businessPartner=ZZ-ACME, addressType=TOR |\n| selectByBPDate | Bpdate | datetime | | This finder is designed to help you locate business partners by specifying the last update date (BpadIuUpdateDate). When you use this finder, it will display results for business partners whose details have been updated from the entered date onwards. | /sys-rest-api/rest/1/bpaddresses?finder=selectByBPDate; Bpdate=2019-12-20 |\n\n## bpaddresses Attributes\n\n| CMiC UI Fieldname | Object | Name | Description | Type | Data Length | Example |\n| --- | --- | --- | --- | --- | --- | --- |\n| 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 |\n| 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 |\n| 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 |\n| 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 |\n| 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 |\n| Address Line 2 | bpaddresses | BpadAdd2 | Address line 2 contains additional address information. Typically used for suite or apartment numbers. | string | 40 | 100 |\n| 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 |\n| Add Email | bpaddresses | BpadAddEmail | Stores the email address of the main contanct associated with the business partner address. | string | 80 | |\n| Fax | bpaddresses | BpadAddFax | Stores the fax number for the business partner address record. | string | 20 | (239) 555-5000 |\n| 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 |\n| Phone | bpaddresses | BpadAddPhone | Stores the primary phone number for the a given address. | string | 20 | 323-418-3559 |\n| 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 |\n| 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 |\n| Business Partner Name | bpaddresses | BpadBpName | The name of the business partner specified under BpadBPCode | string | 50 | null |\n| 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 |\n| Company Code | bpaddresses | BpadCompCode | The company code of the business partner assigned in the system this address belongs to. | string | 8 | ZZ |\n| Company Name | bpaddresses | BpadCompName | The Name of the company specified under BpadCompCode | string | 30 | Supreme Utilitarian Selections |\n| Attention (ie. Contact Name) | bpaddresses | BpadContactName | The name of the primary contact associated with the business partner's address. | string | 50 | Rob Cementer |\n| Country | bpaddresses | BpadCountry | The country where the business partner's address is located. | string | 30 | USA |\n| 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 |\n| 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 |\n| 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 |\n| 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 |\n| 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 |\n| 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 |\n| Postal Code | bpaddresses | BpadPostalCode | The postal or ZIP code corresponding to the business partner's address. | string | 12 | 10025 |\n| Region Code | bpaddresses | BpadRegionCode | The regional code (state or province) that corresponds to the business partner's address,. | string | 3 | IL |\n| 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 |\n| 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 |\n| 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 |\n| 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 |\n| 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 |\n| Business Parner 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 |", "parameters": [ { "name": "finder", "in": "query", "schema": { "type": "string" }, "example": "selectByBPCodeAddress; businessPartner=AGM001, addressType=NY, Bpdate=2015-04-23T16:47:18-04:00" }, { "name": "limit", "in": "query", "schema": { "type": "integer" }, "example": "500" }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "example": "0" }, { "name": "totalResults", "in": "query", "schema": { "type": "boolean" }, "example": "true" }, { "name": "orderBy", "in": "query", "schema": { "type": "string" }, "example": "BpadBpCode:desc" } ], "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "schema": { "type": "string", "example": "application/vnd.oracle.adf.resourcecollection+json" } } }, "content": { "application/json": { "schema": { "type": "object" }, "examples": { "example-0": { "summary": "Successful Response - Finder - selectByBPDate", "value": { "items": [ { "BpadActiveFlag": "Y", "BpadAdd1": "100 Bay Street", "BpadAdd2": null, "BpadAdd3": "Toront", "BpadAddEmail": "steven.cangiano@cmic.ca", "BpadAddFax": "499 229 1119", "BpadAddName": "Head Office", "BpadAddPhone": null, "BpadAddPhone2": "220 339 3392", "BpadAddPrimaryFlag": "N", "BpadAddTypeCode": "A1", "BpadBillToFlag": null, "BpadBpCode": "71", "BpadBpName": null, "BpadBpVenName": "Smith and Co Construction", "BpadCompCode": null, "BpadCompName": null, "BpadContactName": "Steve Cangiano", "BpadCountry": "Canada", "BpadIuCreateDate": "2015-07-21T13:47:08+00:00", "BpadIuCreateUser": "ADWAIT", "BpadIuUpdateDate": "2020-01-29T13:32:22+00:00", "BpadIuUpdateUser": "CHET", "BpadName2": null, "BpadName3": null, "BpadName4": null, "BpadOmOnlyFlag": "N", "BpadOrderFromFlag": null, "BpadPostalCode": "L4N32K", "BpadRegionCode": "ON", "BpadRemitToFlag": null, "BpadShipToFlag": null, "BpadVUuid": "BD8E16DC69EF2691E05316821FAC4947", "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/BD8E16DC69EF2691E05316821FAC4947", "name": "bpaddresses", "kind": "item" }, { "rel": "canonical", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/BD8E16DC69EF2691E05316821FAC4947", "name": "bpaddresses", "kind": "item" } ] }, { "BpadActiveFlag": "Y", "BpadAdd1": "1000 new jersey way", "BpadAdd2": null, "BpadAdd3": null, "BpadAddEmail": null, "BpadAddFax": null, "BpadAddName": "New Jersey", "BpadAddPhone": null, "BpadAddPhone2": null, "BpadAddPrimaryFlag": "N", "BpadAddTypeCode": "NJ", "BpadBillToFlag": "Y", "BpadBpCode": "KAISER", "BpadBpName": null, "BpadBpVenName": "Kaiser Permanente", "BpadCompCode": null, "BpadCompName": null, "BpadContactName": null, "BpadCountry": null, "BpadIuCreateDate": "2016-02-12T18:22:05+00:00", "BpadIuCreateUser": "ADWAIT", "BpadIuUpdateDate": null, "BpadIuUpdateUser": null, "BpadName2": null, "BpadName3": null, "BpadName4": null, "BpadOmOnlyFlag": "N", "BpadOrderFromFlag": "Y", "BpadPostalCode": null, "BpadRegionCode": "NJ", "BpadRemitToFlag": "N", "BpadShipToFlag": "Y", "BpadVUuid": "BD8E16DC6CAB2691E05316821FAC4947", "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/BD8E16DC6CAB2691E05316821FAC4947", "name": "bpaddresses", "kind": "item" }, { "rel": "canonical", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/BD8E16DC6CAB2691E05316821FAC4947", "name": "bpaddresses", "kind": "item" } ] }, { "BpadActiveFlag": "Y", "BpadAdd1": "15 Warden Ave", "BpadAdd2": "02", "BpadAdd3": "Rosemount", "BpadAddEmail": null, "BpadAddFax": null, "BpadAddName": "Rosemount Office", "BpadAddPhone": "301-222-5555", "BpadAddPhone2": null, "BpadAddPrimaryFlag": "N", "BpadAddTypeCode": "207", "BpadBillToFlag": "N", "BpadBpCode": "010116", "BpadBpName": null, "BpadBpVenName": "Reliable Contractors", "BpadCompCode": null, "BpadCompName": null, "BpadContactName": "Accounting Department", "BpadCountry": "usa", "BpadIuCreateDate": "2016-04-11T19:06:47+00:00", "BpadIuCreateUser": "CANDICE", "BpadIuUpdateDate": "2016-04-11T19:09:35+00:00", "BpadIuUpdateUser": "CANDICE", "BpadName2": null, "BpadName3": null, "BpadName4": null, "BpadOmOnlyFlag": "N", "BpadOrderFromFlag": "N", "BpadPostalCode": "62020", "BpadRegionCode": "IL", "BpadRemitToFlag": "N", "BpadShipToFlag": "N", "BpadVUuid": "BD8E16DC6BE62691E05316821FAC4947", "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/BD8E16DC6BE62691E05316821FAC4947", "name": "bpaddresses", "kind": "item" }, { "rel": "canonical", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/BD8E16DC6BE62691E05316821FAC4947", "name": "bpaddresses", "kind": "item" } ] }, { "BpadActiveFlag": "Y", "BpadAdd1": "125 Rosefield", "BpadAdd2": "1", "BpadAdd3": "Rosemount", "BpadAddEmail": null, "BpadAddFax": null, "BpadAddName": "Rosemount Office", "BpadAddPhone": "302-255-5555", "BpadAddPhone2": null, "BpadAddPrimaryFlag": "N", "BpadAddTypeCode": "208", "BpadBillToFlag": "N", "BpadBpCode": "013016", "BpadBpName": null, "BpadBpVenName": "Maddamy Builders", "BpadCompCode": null, "BpadCompName": null, "BpadContactName": "Accounting", "BpadCountry": "usa", "BpadIuCreateDate": "2016-04-11T19:17:05+00:00", "BpadIuCreateUser": "CANDICE", "BpadIuUpdateDate": null, "BpadIuUpdateUser": null, "BpadName2": null, "BpadName3": null, "BpadName4": null, "BpadOmOnlyFlag": "N", "BpadOrderFromFlag": "N", "BpadPostalCode": "60220", "BpadRegionCode": "IL", "BpadRemitToFlag": "N", "BpadShipToFlag": "N", "BpadVUuid": "BD8E16DC6C602691E05316821FAC4947", "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/BD8E16DC6C602691E05316821FAC4947", "name": "bpaddresses", "kind": "item" }, { "rel": "canonical", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/BD8E16DC6C602691E05316821FAC4947", "name": "bpaddresses", "kind": "item" } ] }, { "BpadActiveFlag": "Y", "BpadAdd1": "5th Avenue", "BpadAdd2": "1", "BpadAdd3": "New York", "BpadAddEmail": null, "BpadAddFax": null, "BpadAddName": "Hilton HQ", "BpadAddPhone": "313-252-2000", "BpadAddPhone2": null, "BpadAddPrimaryFlag": "N", "BpadAddTypeCode": "H01", "BpadBillToFlag": "Y", "BpadBpCode": "HHO001", "BpadBpName": null, "BpadBpVenName": "Hilton Hotels Inc.", "BpadCompCode": "002", "BpadCompName": "Fresenius Medical Care", "BpadContactName": null, "BpadCountry": "USA", "BpadIuCreateDate": "2016-10-28T14:31:49+00:00", "BpadIuCreateUser": "CANDICE", "BpadIuUpdateDate": null, "BpadIuUpdateUser": null, "BpadName2": null, "BpadName3": null, "BpadName4": null, "BpadOmOnlyFlag": "N", "BpadOrderFromFlag": "N", "BpadPostalCode": "10001", "BpadRegionCode": "NY", "BpadRemitToFlag": "N", "BpadShipToFlag": "N", "BpadVUuid": "BD8E16DC6C252691E05316821FAC4947", "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/BD8E16DC6C252691E05316821FAC4947", "name": "bpaddresses", "kind": "item" }, { "rel": "canonical", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/BD8E16DC6C252691E05316821FAC4947", "name": "bpaddresses", "kind": "item" } ] }, { "BpadActiveFlag": "Y", "BpadAdd1": "85 Baseline Rd.", "BpadAdd2": null, "BpadAdd3": "Ottawa", "BpadAddEmail": null, "BpadAddFax": null, "BpadAddName": null, "BpadAddPhone": null, "BpadAddPhone2": null, "BpadAddPrimaryFlag": "N", "BpadAddTypeCode": "0212", "BpadBillToFlag": "Y", "BpadBpCode": "0212", "BpadBpName": null, "BpadBpVenName": "Materials and Supply Co.", "BpadCompCode": null, "BpadCompName": null, "BpadContactName": null, "BpadCountry": null, "BpadIuCreateDate": "2016-10-28T14:39:20+00:00", "BpadIuCreateUser": "CANDICE", "BpadIuUpdateDate": "2016-10-28T14:43:54+00:00", "BpadIuUpdateUser": "CANDICE", "BpadName2": null, "BpadName3": null, "BpadName4": null, "BpadOmOnlyFlag": "N", "BpadOrderFromFlag": "Y", "BpadPostalCode": null, "BpadRegionCode": "ON", "BpadRemitToFlag": "N", "BpadShipToFlag": "Y", "BpadVUuid": "BD8E16DC711D2691E05316821FAC4947", "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/BD8E16DC711D2691E05316821FAC4947", "name": "bpaddresses", "kind": "item" }, { "rel": "canonical", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/BD8E16DC711D2691E05316821FAC4947", "name": "bpaddresses", "kind": "item" } ] }, { "BpadActiveFlag": "Y", "BpadAdd1": "55 Rideau Street", "BpadAdd2": null, "BpadAdd3": "Ottawa", "BpadAddEmail": "accounting@sunlife.ca", "BpadAddFax": "613-552-5151", "BpadAddName": "Downtown Location", "BpadAddPhone": "613-552-5252", "BpadAddPhone2": null, "BpadAddPrimaryFlag": "N", "BpadAddTypeCode": "1001", "BpadBillToFlag": "Y", "BpadBpCode": "10-001", "BpadBpName": null, "BpadBpVenName": "Sun Life Group", "BpadCompCode": "HIKUU", "BpadCompName": "CMiC Construction Canada Ltd.", "BpadContactName": "Accounting", "BpadCountry": "Canada", "BpadIuCreateDate": "2016-11-25T16:13:54+00:00", "BpadIuCreateUser": "CANDICE", "BpadIuUpdateDate": null, "BpadIuUpdateUser": null, "BpadName2": null, "BpadName3": null, "BpadName4": null, "BpadOmOnlyFlag": "N", "BpadOrderFromFlag": "Y", "BpadPostalCode": "K2B8G2", "BpadRegionCode": "ON", "BpadRemitToFlag": "N", "BpadShipToFlag": "Y", "BpadVUuid": "BD8E16DC6CF32691E05316821FAC4947", "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/BD8E16DC6CF32691E05316821FAC4947", "name": "bpaddresses", "kind": "item" }, { "rel": "canonical", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/BD8E16DC6CF32691E05316821FAC4947", "name": "bpaddresses", "kind": "item" } ] }, { "BpadActiveFlag": "Y", "BpadAdd1": "15 King Edwards Ave", "BpadAdd2": "101", "BpadAdd3": "Ottawa", "BpadAddEmail": "payable@ke.com", "BpadAddFax": null, "BpadAddName": "Accounts Payable", "BpadAddPhone": "613-523-1000", "BpadAddPhone2": null, "BpadAddPrimaryFlag": "N", "BpadAddTypeCode": "01", "BpadBillToFlag": "Y", "BpadBpCode": "1020", "BpadBpName": null, "BpadBpVenName": "King Edward Residence", "BpadCompCode": null, "BpadCompName": null, "BpadContactName": "Accounts Payable", "BpadCountry": "CANADA", "BpadIuCreateDate": "2017-02-03T14:09:39+00:00", "BpadIuCreateUser": "CANDICE", "BpadIuUpdateDate": null, "BpadIuUpdateUser": null, "BpadName2": null, "BpadName3": null, "BpadName4": null, "BpadOmOnlyFlag": "N", "BpadOrderFromFlag": "Y", "BpadPostalCode": "K2B8G2", "BpadRegionCode": "ON", "BpadRemitToFlag": "N", "BpadShipToFlag": "Y", "BpadVUuid": "BD8E16DC6D572691E05316821FAC4947", "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/BD8E16DC6D572691E05316821FAC4947", "name": "bpaddresses", "kind": "item" }, { "rel": "canonical", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/BD8E16DC6D572691E05316821FAC4947", "name": "bpaddresses", "kind": "item" } ] }, { "BpadActiveFlag": "Y", "BpadAdd1": "112-Fourth Avenue SW", "BpadAdd2": "P.O.Box 38", "BpadAdd3": "Calgary", "BpadAddEmail": null, "BpadAddFax": null, "BpadAddName": "112-Fourth Avenue SW, P.O.Box ", "BpadAddPhone": null, "BpadAddPhone2": null, "BpadAddPrimaryFlag": "N", "BpadAddTypeCode": "PRI", "BpadBillToFlag": null, "BpadBpCode": "45300", "BpadBpName": null, "BpadBpVenName": "Sancar Energy Inc. namee", "BpadCompCode": null, "BpadCompName": null, "BpadContactName": null, "BpadCountry": "Canada", "BpadIuCreateDate": "2021-08-09T13:28:52+00:00", "BpadIuCreateUser": "FIELDPOINTUSER", "BpadIuUpdateDate": null, "BpadIuUpdateUser": null, "BpadName2": null, "BpadName3": null, "BpadName4": null, "BpadOmOnlyFlag": "N", "BpadOrderFromFlag": null, "BpadPostalCode": null, "BpadRegionCode": null, "BpadRemitToFlag": null, "BpadShipToFlag": null, "BpadVUuid": "C92150EA00A3347CE05316821FAC6825", "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/C92150EA00A3347CE05316821FAC6825", "name": "bpaddresses", "kind": "item" }, { "rel": "canonical", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/C92150EA00A3347CE05316821FAC6825", "name": "bpaddresses", "kind": "item" } ] }, { "BpadActiveFlag": "Y", "BpadAdd1": "124 Test St.", "BpadAdd2": null, "BpadAdd3": null, "BpadAddEmail": null, "BpadAddFax": null, "BpadAddName": "124 Test St., , ", "BpadAddPhone": null, "BpadAddPhone2": null, "BpadAddPrimaryFlag": "N", "BpadAddTypeCode": "Add", "BpadBillToFlag": null, "BpadBpCode": "45300", "BpadBpName": null, "BpadBpVenName": "Sancar Energy Inc. namee", "BpadCompCode": null, "BpadCompName": null, "BpadContactName": null, "BpadCountry": "Canada", "BpadIuCreateDate": "2021-08-09T14:00:14+00:00", "BpadIuCreateUser": "FIELDPOINTUSER", "BpadIuUpdateDate": null, "BpadIuUpdateUser": null, "BpadName2": null, "BpadName3": null, "BpadName4": null, "BpadOmOnlyFlag": "N", "BpadOrderFromFlag": null, "BpadPostalCode": null, "BpadRegionCode": null, "BpadRemitToFlag": null, "BpadShipToFlag": null, "BpadVUuid": "C921A8A70D7D569BE05316821FAC3970", "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/C921A8A70D7D569BE05316821FAC3970", "name": "bpaddresses", "kind": "item" }, { "rel": "canonical", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/C921A8A70D7D569BE05316821FAC3970", "name": "bpaddresses", "kind": "item" } ] }, { "BpadActiveFlag": "Y", "BpadAdd1": "125 Test St.", "BpadAdd2": null, "BpadAdd3": null, "BpadAddEmail": null, "BpadAddFax": null, "BpadAddName": "125 Test St., , ", "BpadAddPhone": null, "BpadAddPhone2": null, "BpadAddPrimaryFlag": "Y", "BpadAddTypeCode": "Ad2", "BpadBillToFlag": null, "BpadBpCode": "45300", "BpadBpName": null, "BpadBpVenName": "Sancar Energy Inc. namee", "BpadCompCode": null, "BpadCompName": null, "BpadContactName": null, "BpadCountry": "Canada", "BpadIuCreateDate": "2021-08-11T00:46:46+00:00", "BpadIuCreateUser": "FIELDPOINTUSER", "BpadIuUpdateDate": null, "BpadIuUpdateUser": null, "BpadName2": null, "BpadName3": null, "BpadName4": null, "BpadOmOnlyFlag": "N", "BpadOrderFromFlag": null, "BpadPostalCode": null, "BpadRegionCode": null, "BpadRemitToFlag": null, "BpadShipToFlag": null, "BpadVUuid": "C93EC58F3D314FDCE05316821FAC966A", "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/C93EC58F3D314FDCE05316821FAC966A", "name": "bpaddresses", "kind": "item" }, { "rel": "canonical", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/C93EC58F3D314FDCE05316821FAC966A", "name": "bpaddresses", "kind": "item" } ] }, { "BpadActiveFlag": "Y", "BpadAdd1": "123 Test1 St.", "BpadAdd2": null, "BpadAdd3": "Toronto", "BpadAddEmail": null, "BpadAddFax": "123456788", "BpadAddName": "FieldpoinTest1", "BpadAddPhone": "123456789", "BpadAddPhone2": null, "BpadAddPrimaryFlag": "N", "BpadAddTypeCode": "FPT1", "BpadBillToFlag": "Y", "BpadBpCode": "BOVIS", "BpadBpName": null, "BpadBpVenName": "Bovis Lend Leaseee", "BpadCompCode": "001", "BpadCompName": "CMiC Construction Inc", "BpadContactName": null, "BpadCountry": "Canada", "BpadIuCreateDate": "2021-09-09T18:08:15+00:00", "BpadIuCreateUser": "FIELDPOINTUSER", "BpadIuUpdateDate": "2021-09-09T18:09:58+00:00", "BpadIuUpdateUser": "FIELDPOINTUSER", "BpadName2": null, "BpadName3": null, "BpadName4": null, "BpadOmOnlyFlag": "N", "BpadOrderFromFlag": "Y", "BpadPostalCode": null, "BpadRegionCode": "ON", "BpadRemitToFlag": "N", "BpadShipToFlag": "Y", "BpadVUuid": "CB94E1FE7B302104E05316821FAC3E53", "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/CB94E1FE7B302104E05316821FAC3E53", "name": "bpaddresses", "kind": "item" }, { "rel": "canonical", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/CB94E1FE7B302104E05316821FAC3E53", "name": "bpaddresses", "kind": "item" } ] }, { "BpadActiveFlag": "Y", "BpadAdd1": "123 Test1 St.", "BpadAdd2": null, "BpadAdd3": "Toronto", "BpadAddEmail": null, "BpadAddFax": null, "BpadAddName": "123 Test1 St., , Toronto", "BpadAddPhone": null, "BpadAddPhone2": null, "BpadAddPrimaryFlag": "Y", "BpadAddTypeCode": "FPT", "BpadBillToFlag": null, "BpadBpCode": "BOVIS", "BpadBpName": null, "BpadBpVenName": "Bovis Lend Leaseee", "BpadCompCode": null, "BpadCompName": null, "BpadContactName": null, "BpadCountry": "Canada", "BpadIuCreateDate": "2021-09-10T12:37:54+00:00", "BpadIuCreateUser": "FIELDPOINTUSER", "BpadIuUpdateDate": null, "BpadIuUpdateUser": null, "BpadName2": null, "BpadName3": null, "BpadName4": null, "BpadOmOnlyFlag": "N", "BpadOrderFromFlag": null, "BpadPostalCode": null, "BpadRegionCode": null, "BpadRemitToFlag": null, "BpadShipToFlag": null, "BpadVUuid": "CBA46263890B6CC4E05316821FAC089C", "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/CBA46263890B6CC4E05316821FAC089C", "name": "bpaddresses", "kind": "item" }, { "rel": "canonical", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/CBA46263890B6CC4E05316821FAC089C", "name": "bpaddresses", "kind": "item" } ] }, { "BpadActiveFlag": "Y", "BpadAdd1": "120 Test St.", "BpadAdd2": null, "BpadAdd3": "Toronto", "BpadAddEmail": null, "BpadAddFax": null, "BpadAddName": "FieldpointTest2", "BpadAddPhone": "123456789", "BpadAddPhone2": null, "BpadAddPrimaryFlag": "N", "BpadAddTypeCode": "FPT2", "BpadBillToFlag": "Y", "BpadBpCode": "BOVIS", "BpadBpName": null, "BpadBpVenName": "Bovis Lend Leaseee", "BpadCompCode": "001", "BpadCompName": "CMiC Construction Inc", "BpadContactName": null, "BpadCountry": "Canada", "BpadIuCreateDate": "2021-09-10T13:31:57+00:00", "BpadIuCreateUser": "FIELDPOINTUSER", "BpadIuUpdateDate": "2021-09-10T17:13:01+00:00", "BpadIuUpdateUser": "FIELDPOINTUSER", "BpadName2": null, "BpadName3": null, "BpadName4": null, "BpadOmOnlyFlag": "N", "BpadOrderFromFlag": "Y", "BpadPostalCode": null, "BpadRegionCode": "ON", "BpadRemitToFlag": "N", "BpadShipToFlag": "Y", "BpadVUuid": "CBA523B2ED547281E05316821FACC5AB", "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/CBA523B2ED547281E05316821FACC5AB", "name": "bpaddresses", "kind": "item" }, { "rel": "canonical", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/CBA523B2ED547281E05316821FACC5AB", "name": "bpaddresses", "kind": "item" } ] }, { "BpadActiveFlag": "Y", "BpadAdd1": "4800 keele st", "BpadAdd2": null, "BpadAdd3": "Toronto", "BpadAddEmail": null, "BpadAddFax": null, "BpadAddName": "4800 keele st, , ", "BpadAddPhone": null, "BpadAddPhone2": null, "BpadAddPrimaryFlag": "N", "BpadAddTypeCode": "ON", "BpadBillToFlag": null, "BpadBpCode": "CAD", "BpadBpName": null, "BpadBpVenName": "Cadillac Fairview", "BpadCompCode": null, "BpadCompName": null, "BpadContactName": null, "BpadCountry": null, "BpadIuCreateDate": "2023-01-16T21:07:22+00:00", "BpadIuCreateUser": "CMICUSER", "BpadIuUpdateDate": "2023-01-16T21:21:22+00:00", "BpadIuUpdateUser": "CMICUSER", "BpadName2": null, "BpadName3": null, "BpadName4": null, "BpadOmOnlyFlag": "N", "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" } ] } ], "count": 15, "hasMore": false, "limit": 500, "offset": 0, "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses", "name": "bpaddresses", "kind": "collection" } ] } }, "example-1": { "summary": "Successful Response - Finder - selectByBPCodeAddress", "value": { "items": [ { "BpadActiveFlag": "Y", "BpadAdd1": "1020 E 56th Street", "BpadAdd2": null, "BpadAdd3": "New York", "BpadAddEmail": null, "BpadAddFax": "2112-555-9999", "BpadAddName": "New York", "BpadAddPhone": "212-555-1212", "BpadAddPhone2": null, "BpadAddPrimaryFlag": "N", "BpadAddTypeCode": "NY", "BpadBillToFlag": "Y", "BpadBpCode": "AGM001", "BpadBpName": null, "BpadBpVenName": "Agway Metals Inc.", "BpadCompCode": null, "BpadCompName": null, "BpadContactName": null, "BpadCountry": "USA", "BpadIuCreateDate": "2015-04-23T19:44:24+00:00", "BpadIuCreateUser": "BILL", "BpadIuUpdateDate": null, "BpadIuUpdateUser": null, "BpadName2": null, "BpadName3": null, "BpadName4": null, "BpadOmOnlyFlag": "N", "BpadOrderFromFlag": "Y", "BpadPostalCode": "10282", "BpadRegionCode": "NY", "BpadRemitToFlag": "Y", "BpadShipToFlag": "Y", "BpadVUuid": "BD8E16DC6A682691E05316821FAC4947", "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/BD8E16DC6A682691E05316821FAC4947", "name": "bpaddresses", "kind": "item" }, { "rel": "canonical", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/BD8E16DC6A682691E05316821FAC4947", "name": "bpaddresses", "kind": "item" } ] } ], "count": 1, "hasMore": false, "limit": 500, "offset": 0, "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses", "name": "bpaddresses", "kind": "collection" } ] } }, "example-2": { "summary": "Successful Response - Finder - selectByBPCode", "value": { "items": [ { "BpadActiveFlag": "Y", "BpadAdd1": "120 Test St.", "BpadAdd2": null, "BpadAdd3": "Toronto", "BpadAddEmail": null, "BpadAddFax": null, "BpadAddName": "FieldpointTest2", "BpadAddPhone": "123456789", "BpadAddPhone2": null, "BpadAddPrimaryFlag": "N", "BpadAddTypeCode": "FPT2", "BpadBillToFlag": "Y", "BpadBpCode": "BOVIS", "BpadBpName": null, "BpadBpVenName": "Bovis Lend Leaseee", "BpadCompCode": "001", "BpadCompName": "CMiC Construction Inc", "BpadContactName": null, "BpadCountry": "Canada", "BpadIuCreateDate": "2021-09-10T13:31:57+00:00", "BpadIuCreateUser": "FIELDPOINTUSER", "BpadIuUpdateDate": "2021-09-10T17:13:01+00:00", "BpadIuUpdateUser": "FIELDPOINTUSER", "BpadName2": null, "BpadName3": null, "BpadName4": null, "BpadOmOnlyFlag": "N", "BpadOrderFromFlag": "Y", "BpadPostalCode": null, "BpadRegionCode": "ON", "BpadRemitToFlag": "N", "BpadShipToFlag": "Y", "BpadVUuid": "CBA523B2ED547281E05316821FACC5AB", "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/CBA523B2ED547281E05316821FACC5AB", "name": "bpaddresses", "kind": "item" }, { "rel": "canonical", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/CBA523B2ED547281E05316821FACC5AB", "name": "bpaddresses", "kind": "item" } ] }, { "BpadActiveFlag": "Y", "BpadAdd1": "100 Bay Street", "BpadAdd2": null, "BpadAdd3": "Toront", "BpadAddEmail": "steven.cangiano@cmic.ca", "BpadAddFax": "499 229 1119", "BpadAddName": "Head Office", "BpadAddPhone": null, "BpadAddPhone2": "220 339 3392", "BpadAddPrimaryFlag": "N", "BpadAddTypeCode": "A1", "BpadBillToFlag": null, "BpadBpCode": "71", "BpadBpName": null, "BpadBpVenName": "Centrifugal Systems Inc", "BpadCompCode": null, "BpadCompName": null, "BpadContactName": "Steve Cangiano", "BpadCountry": "Canada", "BpadIuCreateDate": "2015-07-21T13:47:08+00:00", "BpadIuCreateUser": "ADWAIT", "BpadIuUpdateDate": "2023-05-26T16:40:32+00:00", "BpadIuUpdateUser": "KWANT", "BpadName2": null, "BpadName3": null, "BpadName4": null, "BpadOmOnlyFlag": "N", "BpadOrderFromFlag": null, "BpadPostalCode": "L4N32K", "BpadRegionCode": "ON", "BpadRemitToFlag": null, "BpadShipToFlag": null, "BpadVUuid": "BD8E16DC69EF2691E05316821FAC4947", "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/BD8E16DC69EF2691E05316821FAC4947", "name": "bpaddresses", "kind": "item" }, { "rel": "canonical", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/BD8E16DC69EF2691E05316821FAC4947", "name": "bpaddresses", "kind": "item" } ] }, { "BpadActiveFlag": "Y", "BpadAdd1": "15 Warden Ave", "BpadAdd2": "02", "BpadAdd3": "Rosemount", "BpadAddEmail": null, "BpadAddFax": null, "BpadAddName": "Rosemount Office", "BpadAddPhone": "301-222-5555", "BpadAddPhone2": null, "BpadAddPrimaryFlag": "N", "BpadAddTypeCode": "207", "BpadBillToFlag": "N", "BpadBpCode": "010116", "BpadBpName": null, "BpadBpVenName": "Reliable Contractors", "BpadCompCode": null, "BpadCompName": null, "BpadContactName": "Accounting Department", "BpadCountry": "usa", "BpadIuCreateDate": "2016-04-11T19:06:47+00:00", "BpadIuCreateUser": "CANDICE", "BpadIuUpdateDate": "2016-04-11T19:09:35+00:00", "BpadIuUpdateUser": "CANDICE", "BpadName2": null, "BpadName3": null, "BpadName4": null, "BpadOmOnlyFlag": "N", "BpadOrderFromFlag": "N", "BpadPostalCode": "62020", "BpadRegionCode": "IL", "BpadRemitToFlag": "N", "BpadShipToFlag": "N", "BpadVUuid": "BD8E16DC6BE62691E05316821FAC4947", "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/BD8E16DC6BE62691E05316821FAC4947", "name": "bpaddresses", "kind": "item" }, { "rel": "canonical", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/BD8E16DC6BE62691E05316821FAC4947", "name": "bpaddresses", "kind": "item" } ] }, { "BpadActiveFlag": "Y", "BpadAdd1": "85 Baseline Rd.", "BpadAdd2": null, "BpadAdd3": "Ottawa", "BpadAddEmail": null, "BpadAddFax": null, "BpadAddName": null, "BpadAddPhone": null, "BpadAddPhone2": null, "BpadAddPrimaryFlag": "N", "BpadAddTypeCode": "0212", "BpadBillToFlag": "Y", "BpadBpCode": "0212", "BpadBpName": null, "BpadBpVenName": "Materials and Supply Co.", "BpadCompCode": null, "BpadCompName": null, "BpadContactName": null, "BpadCountry": null, "BpadIuCreateDate": "2016-10-28T14:39:20+00:00", "BpadIuCreateUser": "CANDICE", "BpadIuUpdateDate": "2016-10-28T14:43:54+00:00", "BpadIuUpdateUser": "CANDICE", "BpadName2": null, "BpadName3": null, "BpadName4": null, "BpadOmOnlyFlag": "N", "BpadOrderFromFlag": "Y", "BpadPostalCode": null, "BpadRegionCode": "ON", "BpadRemitToFlag": "N", "BpadShipToFlag": "Y", "BpadVUuid": "BD8E16DC711D2691E05316821FAC4947", "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/BD8E16DC711D2691E05316821FAC4947", "name": "bpaddresses", "kind": "item" }, { "rel": "canonical", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/BD8E16DC711D2691E05316821FAC4947", "name": "bpaddresses", "kind": "item" } ] }, { "BpadActiveFlag": "Y", "BpadAdd1": "123 Test1 St.", "BpadAdd2": null, "BpadAdd3": "Toronto", "BpadAddEmail": null, "BpadAddFax": "123456788", "BpadAddName": "FieldpoinTest1", "BpadAddPhone": "123456789", "BpadAddPhone2": null, "BpadAddPrimaryFlag": "N", "BpadAddTypeCode": "FPT1", "BpadBillToFlag": "Y", "BpadBpCode": "BOVIS", "BpadBpName": null, "BpadBpVenName": "Bovis Lend Leaseee", "BpadCompCode": "001", "BpadCompName": "CMiC Construction Inc", "BpadContactName": null, "BpadCountry": "Canada", "BpadIuCreateDate": "2021-09-09T18:08:15+00:00", "BpadIuCreateUser": "FIELDPOINTUSER", "BpadIuUpdateDate": "2021-09-09T18:09:58+00:00", "BpadIuUpdateUser": "FIELDPOINTUSER", "BpadName2": null, "BpadName3": null, "BpadName4": null, "BpadOmOnlyFlag": "N", "BpadOrderFromFlag": "Y", "BpadPostalCode": null, "BpadRegionCode": "ON", "BpadRemitToFlag": "N", "BpadShipToFlag": "Y", "BpadVUuid": "CB94E1FE7B302104E05316821FAC3E53", "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/CB94E1FE7B302104E05316821FAC3E53", "name": "bpaddresses", "kind": "item" }, { "rel": "canonical", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses/CB94E1FE7B302104E05316821FAC3E53", "name": "bpaddresses", "kind": "item" } ] } ], "count": 5, "hasMore": false, "limit": 500, "offset": 0, "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/bpaddresses", "name": "bpaddresses", "kind": "collection" } ] } } } } } } } } } }, "components": { "securitySchemes": { "cmicBasicAuth": { "type": "http", "scheme": "basic", "description": "Basic authentication" } } } } ````