> ## 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 AR Customer > # Overview This endpoint creates a new Accounts Receivable customer record in the system. The POST request requires at minimum the company code, business partner code, and business partner name. All other fields are optional and will default to system-level settings if not provided. # UI Navigation Financial > Accounts Receivable > Setup > Maintain Customers # Reference Article - [Accounts Receivable – AR Customer - Maintain Customers](https://docs.cmicglobal.com/portal/Content/E_Reference_Material/AR_-_Accounts_Receivable/Reference/Maintain_Customers/Customers_Tab.htm) # Payload ``` json { "BpcustBpCode": "AGO", "BpcustCompCode": "MAIC", "BpcustBpCodeBf": "AGO", "BpcustCollCode": "ACCT", "BpcustTermCode": "N30", "BpcustCurrCode": "USD", "BpcustChargeCode": "NA", "BpcustArDeptCode": "00", "BpcustArAccCode": "1500.100", "BpcustCashDeptCode": "00", "BpcustCashAccCode": "1000.100", "BpcustSalesDeptCode": "00", "BpcustSalesAccCode": "4000.800", "BpcustDiscDeptCode": "00", "BpcustDiscAccCode": "5000.106", "BpcustHldbkDeptCode": "00", "BpcustHldbkAccCode": "1500.200", "BpcustFrtDeptCode": "00", "BpcustFrtAccCode": "5000.103", "BpcustInsDeptCode": "00", "BpcustInsAccCode": "5000.104", "BpcustMiscDeptCode": "00", "BpcustMiscAccCode": "4000.200", "BpcustVUuid": "" } ``` # Request Body Notes **The following fields are system-generated and must not be included:** BpIuCreateDatetime, BpIuUpdateDatetime, BpcustIuCreateDate, BpcustIuCreateDatetime, BpcustIuUpdateDate, BpcustIuUpdateDatetime, BpcustLastUpdateDate, BpcustLastInvDate, BpcustAvgDaysToPayInv, BpcustFullyPaidInvs, BpcustInvDeliq, BpcustObjectOraseq, BpcustBpccOraseq, BpcustActiveFromDate, BpcustActiveToDate # Commonly Used Body Parameters | CMiC UI Fieldname | Object | Name | Description | Type | Data Length | Required | Example | | --- | --- | --- | --- | --- | --- | --- | --- | | Company Code | arcustomer | BpcustCompCode | Code representing the company the customer is associated with within CMiC. | string | 8 | Yes | ZZ | | Business Partner Code | arcustomer | BpcustBpCode | The unique Business Partner code for this customer. | string | 8 | Yes | ZZ-ACME | | Business Partner Name | arcustomer | BpcustBpName | The name used throughout the system wherever business partner objects are available. | string | 50 | Yes | ZZ-Acme Supply | | Active Flag | arcustomer | BpcustActiveFlag | Indicates if the customer is active. Valid values are 0 (inactive) or 1 (active). | string | 1 | No | 1 | | Transaction Allow Flag | arcustomer | BpcustTranAllowFlag | Indicates if customer allows AR transactions. 1 = Allowed, 0 = Not Allowed. | string | 1 | No | 1 | | Credit Hold Flag | arcustomer | BpcustCreditHoldFlag | Indicates if the customer is on credit hold. Y = On Hold, N = Not on Hold. | string | 1 | No | N | | Billing Address Line 1 | arcustomer | BpcustBillAdd1 | First line of the customer's billing address. | string | 40 | No | 123 Greenbriar Lane | | Billing Address Line 2 | arcustomer | BpcustBillAdd2 | Second line of the customer's billing address. | string | 40 | No | Unit 75 | | Billing Address Line 3 | arcustomer | BpcustBillAdd3 | Third line of the customer's billing address, typically the city. | string | 40 | No | Chicago | | Billing Postal Code | arcustomer | BpcustBillPostalCode | ZIP or postal code of the billing address. | string | 12 | No | 60082 | | Billing State/Province Code | arcustomer | BpcustBillRegionCode | State or province code of the billing address. | string | 3 | No | IL | | Billing Country | arcustomer | BpcustBillCountry | Country of the billing address. | string | 30 | No | US | | Billing Contact Name | arcustomer | BpcustBillContactName | Name of the primary billing contact person. | string | 30 | No | Mr. Green | | Billing Phone Number | arcustomer | BpcustBillPhone | Phone number for billing inquiries. | string | 20 | No | (847) 555-1212 | | Billing Fax Number | arcustomer | BpcustBillFax | Fax number for billing communications. | string | 20 | No | (847) 555-1313 | | Billing Email Address | arcustomer | BpcustBillEmail | Email address of the billing contact. | string | 80 | No | [billing@example.com](https://mailto:billing@example.com) | | Ship Address Line 1 | arcustomer | BpcustShipAdd1 | First line of the shipping address. | string | 40 | No | 123 Greenbriar Lane | | Ship Address Line 2 | arcustomer | BpcustShipAdd2 | Second line of the shipping address. | string | 40 | No | Unit 75 | | Ship Address Line 3 | arcustomer | BpcustShipAdd3 | Third line of the shipping address (often city). | string | 40 | No | Chicago | | Ship ZIP/Postal Code | arcustomer | BpcustShipPostalCode | ZIP/postal code for the shipping address. | string | 12 | No | 60082 | | Ship State/Province Code | arcustomer | BpcustShipRegionCode | Abbreviation for the shipping state/province. | string | 3 | No | IL | | Ship Country | arcustomer | BpcustShipCountry | Country for the shipping address. | string | 30 | No | US | | Ship Contact Name | arcustomer | BpcustShipContactName | Contact person at the shipping address. | string | 30 | No | Mr. Green | | Ship Phone | arcustomer | BpcustShipPhone | Phone number for shipping. | string | 20 | No | (847) 555-1212 | | Ship Fax | arcustomer | BpcustShipFax | Fax number for shipping. | string | 20 | No | (847) 555-1313 | | Ship Email | arcustomer | BpcustShipEmail | Email address for shipping contact. | string | 80 | No | [shipping@example.com](https://mailto:shipping@example.com) | | Default Accounts Receivable Account | arcustomer | BpcustArAccCode | Default AR account debited on invoice entry and credited when payments are received. | string | 16 | No | 1500.1 | | Default Accounts Receivable Department | arcustomer | BpcustArDeptCode | Default AR department code linked to the AR control account. | string | 6 | No | 10 | | Default Cash Account Code | arcustomer | BpcustCashAccCode | Default cash account used for receipt payments. | string | 16 | No | 1000.1 | | Currency Code | arcustomer | BpcustCurrCode | Code representing the currency used for transactions (e.g., USD, CAD). | string | 3 | No | USD | | Credit Limit | arcustomer | BpcustCrLimitAmt | Maximum credit extended to the customer. | number | 18 | No | 999999999999 | | Term Code | arcustomer | BpcustTermCode | Payment terms code assigned to the customer (e.g., NET30). | string | 6 | No | NET30 | | Discount Account Code | arcustomer | BpcustDiscAccCode | GL account for discounts. Represents a reduction in revenue when a customer takes a cash discount. | string | 16 | No | 5000.106 | | Discount Department Code | arcustomer | BpcustDiscDeptCode | Department code for the discount account. | string | 6 | No | 0 | | Discount Percent (overrides Terms Code) | arcustomer | BpcustDiscPc | A discount percentage that overrides the standard terms. | number | 7 | No | 2.5 | | Retainage Receivable Account Code | arcustomer | BpcustHldbkAccCode | GL account code for retainage receivables. | string | 16 | No | 1500.2 | | Retainage Receivable Department Code | arcustomer | BpcustHldbkDeptCode | Department code associated with retainage receivable. | string | 6 | No | 0 | | Retainage Percent (overrides Terms Code) | arcustomer | BpcustHldbkPc | A retainage percentage that overrides term codes. | number | 7 | No | 10 | | Freight Charges Account Code | arcustomer | BpcustFrtAccCode | GL account code for freight charges. | string | 16 | No | 5000.103 | | Freight Charges Department Code | arcustomer | BpcustFrtDeptCode | Department code for freight charges. | string | 6 | No | 0 | | Insurance Charges Account Code | arcustomer | BpcustInsAccCode | GL account code for insurance-related charges. | string | 16 | No | 5000.104 | | Insurance Charges Department Code | arcustomer | BpcustInsDeptCode | Department code for insurance charges. | string | 6 | No | 0 | | Miscellaneous Charges Account Code | arcustomer | BpcustMiscAccCode | GL account code for miscellaneous charges. | string | 16 | No | 4000.2 | | Miscellaneous Charges Department Code | arcustomer | BpcustMiscDeptCode | Department code for miscellaneous charges. | string | 6 | No | 0 | | Sales Account Code | arcustomer | BpcustSalesAccCode | GL account code for revenue/sales. | string | 16 | No | 4000.8 | | Sales Department Code | arcustomer | BpcustSalesDeptCode | Department code for revenue/sales. | string | 6 | No | 0 | | Salesman Code | arcustomer | BpcustSalesmanCode | Code identifying the assigned salesperson/sales rep. | string | 16 | No | SMITH01 | | Collector Code | arcustomer | BpcustCollCode | Internal code identifying the assigned collector for this customer. | string | 4 | No | ZZ1 | | Financial Charge Code | arcustomer | BpcustChargeCode | Determines the interest calculation rules for overdue balances. | string | 3 | No | 10 | | Statement Flag | arcustomer | BpcustStatementFlag | Flag indicating if this customer is to receive regular account statements. Y/N. | string | 1 | No | Y | | AR Statement Email Flag | arcustomer | BpcustArStatementEmailFlag | Indicates whether AR statements should be emailed. Y/N. | string | 1 | No | Y | | AR Statement Email Addresses | arcustomer | BpcustArStatementEmailAdd | Email addresses (comma-separated) for receiving AR statements. | string | 4000 | No | [billing@example.com](https://mailto:billing@example.com) | | Are Dunning Letters to be Sent | arcustomer | BpcustDunnFlag | Flag that indicates if dunning letters should be sent. 1 = Send, 0 = Do not send. | string | 1 | No | 1 | | Tax Exempt Flag | arcustomer | BpcustTaxedCode | Indicates if this customer is tax exempt. Y = Exempt, N = Not Exempt. | string | 1 | No | N | | Tax1 Code | arcustomer | BpcustTax1Code | First (default) tax code for this customer. | string | 11 | No | 1 | | Tax2 Code | arcustomer | BpcustTax2Code | Second tax code for this customer. | string | 11 | No | 2 | | Tax3 Code | arcustomer | BpcustTax3Code | Third tax code for this customer. | string | 11 | No | 3 | | Bank Transit Number (EFT) | arcustomer | BpcustBankAccNum1 | Bank transit or routing number for Electronic Funds Transfer (EFT). | string | 9 | No | | | Bank Account Number (EFT) | arcustomer | BpcustBankAccNum2 | Bank account number for EFT transactions. | string | 17 | No | | | Bank Suffix (EFT) | arcustomer | BpcustBankAccNum3 | Bank account suffix, if applicable, for EFT transactions. | string | 12 | No | | | Bank Code (EFT) | arcustomer | BpcustBankCode | Internal or external bank code used for EFT transactions. | string | 9 | No | | | Bank Name (EFT) | arcustomer | BpcustBankName | Name of the bank used for EFT transactions. | string | 30 | No | Chase Bank | | Default Job Billing Rate Code | arcustomer | BpcustJbBillRateTableCode | Rate table code for default job billing. | string | 10 | No | | | Default Job Billing Type Code | arcustomer | BpcustJbBillTypeCode | Billing type code for default job billing. | string | 4 | No | | | Default Job Billing Invoice Format Code | arcustomer | BpcustJbInvFormatCode | Invoice format code for job billing. | string | 4 | No | | | Default Job Billing Invoice Link Code | arcustomer | BpcustJbInvGroupCode | Link/grouping code for job billing invoices. | string | 10 | No | | | Default Job Billing Map Code | arcustomer | BpcustJbMapCode | Mapping code for job billing. | string | 10 | No | | | Default Retainage Code | arcustomer | BpcustJbretrCode | Code referencing the default retainage setting for job billing. | string | 10 | No | | | Allocate AP Discounts to Job Flag | arcustomer | BpcustAllocApdiscJobFlag | Indicates whether AP discounts should be allocated to a job for this customer. Y/N. | string | 1 | No | N | | Trucker Pay Discount % | arcustomer | BpcustTruckerPayDiscPc | Percentage discount for trucker pay scenario. | number | 7 | No | 2.5 | | Material Sales Propagate Company Exist Flag | arcustomer | BpcustMsPropagateCompFlag | Controls whether to propagate material sales settings across companies. Y/N. | string | 1 | No | N | | Web Site | arcustomer | BpcustWebSite | Customer's website URL. | string | 200 | No | [https://www.example.com](https://www.example.com) | ## OpenAPI ````json POST /ar-rest-api/rest/1/arcustomer { "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": "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": "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": "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 | RFQ (Request for Quote) Extensions" }, { "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": { "/ar-rest-api/rest/1/arcustomer": { "post": { "tags": [ "Financials | Accounts Receivable" ], "summary": "Create a AR Customer", "description": "# Overview\n\nThis endpoint creates a new Accounts Receivable customer record in the system. The POST request requires at minimum the company code, business partner code, and business partner name. All other fields are optional and will default to system-level settings if not provided.\n\n# UI Navigation\n\nFinancial > Accounts Receivable > Setup > Maintain Customers\n\n# Reference Article\n\n- [Accounts Receivable – AR Customer - Maintain Customers](https://docs.cmicglobal.com/portal/Content/E_Reference_Material/AR_-_Accounts_Receivable/Reference/Maintain_Customers/Customers_Tab.htm)\n \n\n# Payload\n\n``` json\n{\n \"BpcustBpCode\": \"AGO\",\n \"BpcustCompCode\": \"MAIC\",\n \"BpcustBpCodeBf\": \"AGO\",\n \"BpcustCollCode\": \"ACCT\",\n \"BpcustTermCode\": \"N30\",\n \"BpcustCurrCode\": \"USD\",\n \"BpcustChargeCode\": \"NA\",\n \"BpcustArDeptCode\": \"00\",\n \"BpcustArAccCode\": \"1500.100\",\n \"BpcustCashDeptCode\": \"00\",\n \"BpcustCashAccCode\": \"1000.100\",\n \"BpcustSalesDeptCode\": \"00\",\n \"BpcustSalesAccCode\": \"4000.800\",\n \"BpcustDiscDeptCode\": \"00\",\n \"BpcustDiscAccCode\": \"5000.106\",\n \"BpcustHldbkDeptCode\": \"00\",\n \"BpcustHldbkAccCode\": \"1500.200\",\n \"BpcustFrtDeptCode\": \"00\",\n \"BpcustFrtAccCode\": \"5000.103\",\n \"BpcustInsDeptCode\": \"00\",\n \"BpcustInsAccCode\": \"5000.104\",\n \"BpcustMiscDeptCode\": \"00\",\n \"BpcustMiscAccCode\": \"4000.200\",\n \"BpcustVUuid\": \"\"\n}\n\n ```\n\n# Request Body Notes\n\n**The following fields are system-generated and must not be included:**\n\nBpIuCreateDatetime, BpIuUpdateDatetime, BpcustIuCreateDate, BpcustIuCreateDatetime, BpcustIuUpdateDate, BpcustIuUpdateDatetime, BpcustLastUpdateDate, BpcustLastInvDate, BpcustAvgDaysToPayInv, BpcustFullyPaidInvs, BpcustInvDeliq, BpcustObjectOraseq, BpcustBpccOraseq, BpcustActiveFromDate, BpcustActiveToDate\n\n# Commonly Used Body Parameters\n\n| CMiC UI Fieldname | Object | Name | Description | Type | Data Length | Required | Example |\n| --- | --- | --- | --- | --- | --- | --- | --- |\n| Company Code | arcustomer | BpcustCompCode | Code representing the company the customer is associated with within CMiC. | string | 8 | Yes | ZZ |\n| Business Partner Code | arcustomer | BpcustBpCode | The unique Business Partner code for this customer. | string | 8 | Yes | ZZ-ACME |\n| Business Partner Name | arcustomer | BpcustBpName | The name used throughout the system wherever business partner objects are available. | string | 50 | Yes | ZZ-Acme Supply |\n| Active Flag | arcustomer | BpcustActiveFlag | Indicates if the customer is active. Valid values are 0 (inactive) or 1 (active). | string | 1 | No | 1 |\n| Transaction Allow Flag | arcustomer | BpcustTranAllowFlag | Indicates if customer allows AR transactions. 1 = Allowed, 0 = Not Allowed. | string | 1 | No | 1 |\n| Credit Hold Flag | arcustomer | BpcustCreditHoldFlag | Indicates if the customer is on credit hold. Y = On Hold, N = Not on Hold. | string | 1 | No | N |\n| Billing Address Line 1 | arcustomer | BpcustBillAdd1 | First line of the customer's billing address. | string | 40 | No | 123 Greenbriar Lane |\n| Billing Address Line 2 | arcustomer | BpcustBillAdd2 | Second line of the customer's billing address. | string | 40 | No | Unit 75 |\n| Billing Address Line 3 | arcustomer | BpcustBillAdd3 | Third line of the customer's billing address, typically the city. | string | 40 | No | Chicago |\n| Billing Postal Code | arcustomer | BpcustBillPostalCode | ZIP or postal code of the billing address. | string | 12 | No | 60082 |\n| Billing State/Province Code | arcustomer | BpcustBillRegionCode | State or province code of the billing address. | string | 3 | No | IL |\n| Billing Country | arcustomer | BpcustBillCountry | Country of the billing address. | string | 30 | No | US |\n| Billing Contact Name | arcustomer | BpcustBillContactName | Name of the primary billing contact person. | string | 30 | No | Mr. Green |\n| Billing Phone Number | arcustomer | BpcustBillPhone | Phone number for billing inquiries. | string | 20 | No | (847) 555-1212 |\n| Billing Fax Number | arcustomer | BpcustBillFax | Fax number for billing communications. | string | 20 | No | (847) 555-1313 |\n| Billing Email Address | arcustomer | BpcustBillEmail | Email address of the billing contact. | string | 80 | No | [billing@example.com](https://mailto:billing@example.com) |\n| Ship Address Line 1 | arcustomer | BpcustShipAdd1 | First line of the shipping address. | string | 40 | No | 123 Greenbriar Lane |\n| Ship Address Line 2 | arcustomer | BpcustShipAdd2 | Second line of the shipping address. | string | 40 | No | Unit 75 |\n| Ship Address Line 3 | arcustomer | BpcustShipAdd3 | Third line of the shipping address (often city). | string | 40 | No | Chicago |\n| Ship ZIP/Postal Code | arcustomer | BpcustShipPostalCode | ZIP/postal code for the shipping address. | string | 12 | No | 60082 |\n| Ship State/Province Code | arcustomer | BpcustShipRegionCode | Abbreviation for the shipping state/province. | string | 3 | No | IL |\n| Ship Country | arcustomer | BpcustShipCountry | Country for the shipping address. | string | 30 | No | US |\n| Ship Contact Name | arcustomer | BpcustShipContactName | Contact person at the shipping address. | string | 30 | No | Mr. Green |\n| Ship Phone | arcustomer | BpcustShipPhone | Phone number for shipping. | string | 20 | No | (847) 555-1212 |\n| Ship Fax | arcustomer | BpcustShipFax | Fax number for shipping. | string | 20 | No | (847) 555-1313 |\n| Ship Email | arcustomer | BpcustShipEmail | Email address for shipping contact. | string | 80 | No | [shipping@example.com](https://mailto:shipping@example.com) |\n| Default Accounts Receivable Account | arcustomer | BpcustArAccCode | Default AR account debited on invoice entry and credited when payments are received. | string | 16 | No | 1500.1 |\n| Default Accounts Receivable Department | arcustomer | BpcustArDeptCode | Default AR department code linked to the AR control account. | string | 6 | No | 10 |\n| Default Cash Account Code | arcustomer | BpcustCashAccCode | Default cash account used for receipt payments. | string | 16 | No | 1000.1 |\n| Currency Code | arcustomer | BpcustCurrCode | Code representing the currency used for transactions (e.g., USD, CAD). | string | 3 | No | USD |\n| Credit Limit | arcustomer | BpcustCrLimitAmt | Maximum credit extended to the customer. | number | 18 | No | 999999999999 |\n| Term Code | arcustomer | BpcustTermCode | Payment terms code assigned to the customer (e.g., NET30). | string | 6 | No | NET30 |\n| Discount Account Code | arcustomer | BpcustDiscAccCode | GL account for discounts. Represents a reduction in revenue when a customer takes a cash discount. | string | 16 | No | 5000.106 |\n| Discount Department Code | arcustomer | BpcustDiscDeptCode | Department code for the discount account. | string | 6 | No | 0 |\n| Discount Percent (overrides Terms Code) | arcustomer | BpcustDiscPc | A discount percentage that overrides the standard terms. | number | 7 | No | 2.5 |\n| Retainage Receivable Account Code | arcustomer | BpcustHldbkAccCode | GL account code for retainage receivables. | string | 16 | No | 1500.2 |\n| Retainage Receivable Department Code | arcustomer | BpcustHldbkDeptCode | Department code associated with retainage receivable. | string | 6 | No | 0 |\n| Retainage Percent (overrides Terms Code) | arcustomer | BpcustHldbkPc | A retainage percentage that overrides term codes. | number | 7 | No | 10 |\n| Freight Charges Account Code | arcustomer | BpcustFrtAccCode | GL account code for freight charges. | string | 16 | No | 5000.103 |\n| Freight Charges Department Code | arcustomer | BpcustFrtDeptCode | Department code for freight charges. | string | 6 | No | 0 |\n| Insurance Charges Account Code | arcustomer | BpcustInsAccCode | GL account code for insurance-related charges. | string | 16 | No | 5000.104 |\n| Insurance Charges Department Code | arcustomer | BpcustInsDeptCode | Department code for insurance charges. | string | 6 | No | 0 |\n| Miscellaneous Charges Account Code | arcustomer | BpcustMiscAccCode | GL account code for miscellaneous charges. | string | 16 | No | 4000.2 |\n| Miscellaneous Charges Department Code | arcustomer | BpcustMiscDeptCode | Department code for miscellaneous charges. | string | 6 | No | 0 |\n| Sales Account Code | arcustomer | BpcustSalesAccCode | GL account code for revenue/sales. | string | 16 | No | 4000.8 |\n| Sales Department Code | arcustomer | BpcustSalesDeptCode | Department code for revenue/sales. | string | 6 | No | 0 |\n| Salesman Code | arcustomer | BpcustSalesmanCode | Code identifying the assigned salesperson/sales rep. | string | 16 | No | SMITH01 |\n| Collector Code | arcustomer | BpcustCollCode | Internal code identifying the assigned collector for this customer. | string | 4 | No | ZZ1 |\n| Financial Charge Code | arcustomer | BpcustChargeCode | Determines the interest calculation rules for overdue balances. | string | 3 | No | 10 |\n| Statement Flag | arcustomer | BpcustStatementFlag | Flag indicating if this customer is to receive regular account statements. Y/N. | string | 1 | No | Y |\n| AR Statement Email Flag | arcustomer | BpcustArStatementEmailFlag | Indicates whether AR statements should be emailed. Y/N. | string | 1 | No | Y |\n| AR Statement Email Addresses | arcustomer | BpcustArStatementEmailAdd | Email addresses (comma-separated) for receiving AR statements. | string | 4000 | No | [billing@example.com](https://mailto:billing@example.com) |\n| Are Dunning Letters to be Sent | arcustomer | BpcustDunnFlag | Flag that indicates if dunning letters should be sent. 1 = Send, 0 = Do not send. | string | 1 | No | 1 |\n| Tax Exempt Flag | arcustomer | BpcustTaxedCode | Indicates if this customer is tax exempt. Y = Exempt, N = Not Exempt. | string | 1 | No | N |\n| Tax1 Code | arcustomer | BpcustTax1Code | First (default) tax code for this customer. | string | 11 | No | 1 |\n| Tax2 Code | arcustomer | BpcustTax2Code | Second tax code for this customer. | string | 11 | No | 2 |\n| Tax3 Code | arcustomer | BpcustTax3Code | Third tax code for this customer. | string | 11 | No | 3 |\n| Bank Transit Number (EFT) | arcustomer | BpcustBankAccNum1 | Bank transit or routing number for Electronic Funds Transfer (EFT). | string | 9 | No | |\n| Bank Account Number (EFT) | arcustomer | BpcustBankAccNum2 | Bank account number for EFT transactions. | string | 17 | No | |\n| Bank Suffix (EFT) | arcustomer | BpcustBankAccNum3 | Bank account suffix, if applicable, for EFT transactions. | string | 12 | No | |\n| Bank Code (EFT) | arcustomer | BpcustBankCode | Internal or external bank code used for EFT transactions. | string | 9 | No | |\n| Bank Name (EFT) | arcustomer | BpcustBankName | Name of the bank used for EFT transactions. | string | 30 | No | Chase Bank |\n| Default Job Billing Rate Code | arcustomer | BpcustJbBillRateTableCode | Rate table code for default job billing. | string | 10 | No | |\n| Default Job Billing Type Code | arcustomer | BpcustJbBillTypeCode | Billing type code for default job billing. | string | 4 | No | |\n| Default Job Billing Invoice Format Code | arcustomer | BpcustJbInvFormatCode | Invoice format code for job billing. | string | 4 | No | |\n| Default Job Billing Invoice Link Code | arcustomer | BpcustJbInvGroupCode | Link/grouping code for job billing invoices. | string | 10 | No | |\n| Default Job Billing Map Code | arcustomer | BpcustJbMapCode | Mapping code for job billing. | string | 10 | No | |\n| Default Retainage Code | arcustomer | BpcustJbretrCode | Code referencing the default retainage setting for job billing. | string | 10 | No | |\n| Allocate AP Discounts to Job Flag | arcustomer | BpcustAllocApdiscJobFlag | Indicates whether AP discounts should be allocated to a job for this customer. Y/N. | string | 1 | No | N |\n| Trucker Pay Discount % | arcustomer | BpcustTruckerPayDiscPc | Percentage discount for trucker pay scenario. | number | 7 | No | 2.5 |\n| Material Sales Propagate Company Exist Flag | arcustomer | BpcustMsPropagateCompFlag | Controls whether to propagate material sales settings across companies. Y/N. | string | 1 | No | N |\n| Web Site | arcustomer | BpcustWebSite | Customer's website URL. | string | 200 | No | [https://www.example.com](https://www.example.com) |\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "BpcustBpCode": "ALDO", "BpcustCompCode": "001", "BpcustBpCodeBf": "ALDOT", "BpcustCollCode": "ACCT", "BpcustTermCode": "NET30", "BpcustCurrCode": "USD", "BpcustChargeCode": "NA", "BpcustArDeptCode": "00", "BpcustArAccCode": "11011", "BpcustCashDeptCode": "00", "BpcustCashAccCode": "10001", "BpcustSalesDeptCode": "00", "BpcustSalesAccCode": "40001", "BpcustDiscDeptCode": "00", "BpcustDiscAccCode": "73003", "BpcustHldbkDeptCode": "00", "BpcustHldbkAccCode": "11012", "BpcustFrtDeptCode": "00", "BpcustFrtAccCode": "40020", "BpcustInsDeptCode": "00", "BpcustInsAccCode": "40020", "BpcustMiscDeptCode": "00", "BpcustMiscAccCode": "40020", "BpcustVUuid": "" } } } } }, "parameters": [ { "name": "Content-Type", "in": "header", "schema": { "type": "string" }, "example": "application/vnd.oracle.adf.resourceItem+json" } ], "responses": { "201": { "description": "Created", "headers": { "Content-Type": { "schema": { "type": "string", "example": "application/vnd.oracle.adf.resourceitem+json" } } }, "content": { "application/json": { "schema": { "type": "object" }, "examples": { "example-0": { "summary": "Successful Response", "value": { "BpIuCreateDatetime": null, "BpIuUpdateDatetime": null, "BpcustActiveFlag": null, "BpcustActiveFromDate": null, "BpcustActiveToDate": null, "BpcustAllocApdiscJobFlag": null, "BpcustArAccCode": "11011", "BpcustArAccName": null, "BpcustArDeptCode": "00", "BpcustArDeptName": null, "BpcustArStatementEmailAdd": null, "BpcustArStatementEmailFlag": null, "BpcustAvgDaysToPayInv": null, "BpcustBankAccNum1": null, "BpcustBankAccNum2": null, "BpcustBankAccNum3": null, "BpcustBankCode": null, "BpcustBankName": null, "BpcustBillAdd1": null, "BpcustBillAdd2": null, "BpcustBillAdd3": null, "BpcustBillContactName": null, "BpcustBillCountry": null, "BpcustBillEmail": null, "BpcustBillFax": null, "BpcustBillPhone": null, "BpcustBillPostalCode": null, "BpcustBillRegionCode": null, "BpcustBillRegionName": null, "BpcustBpCode": "ALDO", "BpcustBpCodeBf": "ALDOT", "BpcustBpName": null, "BpcustBpNameBf": null, "BpcustBpccCode": null, "BpcustBpccOraseq": null, "BpcustCashAccCode": "10001", "BpcustCashAccName": null, "BpcustCashDeptCode": "00", "BpcustCashDeptName": null, "BpcustChargeCode": "NA", "BpcustChargeName": null, "BpcustClassCode": null, "BpcustClassName": null, "BpcustCollCode": "ACCT", "BpcustCollName": null, "BpcustCompCode": "001", "BpcustCompName": null, "BpcustCrLimitAmt": null, "BpcustCurrCode": "USD", "BpcustCurrName": null, "BpcustDaysOutstInvPaidTtl": null, "BpcustDeliveryDiscPc": null, "BpcustDiscAccCode": "73003", "BpcustDiscAccName": null, "BpcustDiscDeptCode": "00", "BpcustDiscDeptName": null, "BpcustDiscPc": null, "BpcustDunnFlag": null, "BpcustFrtAccCode": "40020", "BpcustFrtAccName": null, "BpcustFrtDeptCode": "00", "BpcustFrtDeptName": null, "BpcustFullyPaidInvs": null, "BpcustHldbkAccCode": "11012", "BpcustHldbkAccName": null, "BpcustHldbkDeptCode": "00", "BpcustHldbkDeptName": null, "BpcustHldbkPc": null, "BpcustInsAccCode": "40020", "BpcustInsAccName": null, "BpcustInsDeptCode": "00", "BpcustInsDeptName": null, "BpcustInvDeliq": null, "BpcustIuCreateDate": null, "BpcustIuCreateDatetime": null, "BpcustIuUpdateDate": null, "BpcustIuUpdateDatetime": null, "BpcustJbBillRateTableCode": null, "BpcustJbBillRateTableName": null, "BpcustJbBillTypeCode": null, "BpcustJbBillTypeName": null, "BpcustJbInvFormatCode": null, "BpcustJbInvFormatName": null, "BpcustJbInvGroupCode": null, "BpcustJbMapCode": null, "BpcustJbMapName": null, "BpcustJbretrCode": null, "BpcustJbretrName": null, "BpcustLastInvDate": null, "BpcustLastUpdateDate": null, "BpcustMiscAccCode": "40020", "BpcustMiscAccName": null, "BpcustMiscDeptCode": "00", "BpcustMiscDeptName": null, "BpcustMsPropagateCompFlag": null, "BpcustObjectOraseq": null, "BpcustSalesAccCode": "40001", "BpcustSalesAccName": null, "BpcustSalesDeptCode": "00", "BpcustSalesDeptName": null, "BpcustSalesmanCode": null, "BpcustShipAdd1": null, "BpcustShipAdd2": null, "BpcustShipAdd3": null, "BpcustShipContactName": null, "BpcustShipCountry": null, "BpcustShipEmail": null, "BpcustShipFax": null, "BpcustShipPhone": null, "BpcustShipPostalCode": null, "BpcustShipRegionCode": null, "BpcustShipRegionName": null, "BpcustStatementFlag": null, "BpcustTax1Code": null, "BpcustTax1Name": null, "BpcustTax2Code": null, "BpcustTax2Name": null, "BpcustTax3Code": null, "BpcustTax3Name": null, "BpcustTaxedCode": null, "BpcustTermCode": "NET30", "BpcustTermName": null, "BpcustTranAllowFlag": null, "BpcustTruckerPayDiscPc": null, "BpcustVUuid": "F22A4B6D2DBE6D88E05316821FAC7B73", "BpcustWebSite": null, "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ar-rest-api/rest/1/arcustomer/F22A4B6D2DBE6D88E05316821FAC7B73", "name": "arcustomer", "kind": "item" }, { "rel": "canonical", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ar-rest-api/rest/1/arcustomer/F22A4B6D2DBE6D88E05316821FAC7B73", "name": "arcustomer", "kind": "item" } ] } }, "example-1": { "summary": "Successful Response", "value": { "BpIuCreateDatetime": null, "BpIuUpdateDatetime": null, "BpcustActiveFlag": null, "BpcustActiveFromDate": null, "BpcustActiveToDate": null, "BpcustAllocApdiscJobFlag": null, "BpcustArAccCode": "11011", "BpcustArAccName": null, "BpcustArDeptCode": "00", "BpcustArDeptName": null, "BpcustArStatementEmailAdd": null, "BpcustArStatementEmailFlag": null, "BpcustAvgDaysToPayInv": null, "BpcustBankAccNum1": null, "BpcustBankAccNum2": null, "BpcustBankAccNum3": null, "BpcustBankCode": null, "BpcustBankName": null, "BpcustBillAdd1": null, "BpcustBillAdd2": null, "BpcustBillAdd3": null, "BpcustBillContactName": null, "BpcustBillCountry": null, "BpcustBillEmail": null, "BpcustBillFax": null, "BpcustBillPhone": null, "BpcustBillPostalCode": null, "BpcustBillRegionCode": null, "BpcustBillRegionName": null, "BpcustBpCode": "ALDO", "BpcustBpCodeBf": "ALDOT", "BpcustBpName": null, "BpcustBpNameBf": null, "BpcustBpccCode": null, "BpcustBpccOraseq": null, "BpcustCashAccCode": "10001", "BpcustCashAccName": null, "BpcustCashDeptCode": "00", "BpcustCashDeptName": null, "BpcustChargeCode": "NA", "BpcustChargeName": null, "BpcustClassCode": null, "BpcustClassName": null, "BpcustCollCode": "ACCT", "BpcustCollName": null, "BpcustCompCode": "001", "BpcustCompName": null, "BpcustCrLimitAmt": null, "BpcustCurrCode": "USD", "BpcustCurrName": null, "BpcustDaysOutstInvPaidTtl": null, "BpcustDeliveryDiscPc": null, "BpcustDiscAccCode": "73003", "BpcustDiscAccName": null, "BpcustDiscDeptCode": "00", "BpcustDiscDeptName": null, "BpcustDiscPc": null, "BpcustDunnFlag": null, "BpcustFrtAccCode": "40020", "BpcustFrtAccName": null, "BpcustFrtDeptCode": "00", "BpcustFrtDeptName": null, "BpcustFullyPaidInvs": null, "BpcustHldbkAccCode": "11012", "BpcustHldbkAccName": null, "BpcustHldbkDeptCode": "00", "BpcustHldbkDeptName": null, "BpcustHldbkPc": null, "BpcustInsAccCode": "40020", "BpcustInsAccName": null, "BpcustInsDeptCode": "00", "BpcustInsDeptName": null, "BpcustInvDeliq": null, "BpcustIuCreateDate": null, "BpcustIuCreateDatetime": null, "BpcustIuUpdateDate": null, "BpcustIuUpdateDatetime": null, "BpcustJbBillRateTableCode": null, "BpcustJbBillRateTableName": null, "BpcustJbBillTypeCode": null, "BpcustJbBillTypeName": null, "BpcustJbInvFormatCode": null, "BpcustJbInvFormatName": null, "BpcustJbInvGroupCode": null, "BpcustJbMapCode": null, "BpcustJbMapName": null, "BpcustJbretrCode": null, "BpcustJbretrName": null, "BpcustLastInvDate": null, "BpcustLastUpdateDate": null, "BpcustMiscAccCode": "40020", "BpcustMiscAccName": null, "BpcustMiscDeptCode": "00", "BpcustMiscDeptName": null, "BpcustMsPropagateCompFlag": null, "BpcustObjectOraseq": null, "BpcustSalesAccCode": "40001", "BpcustSalesAccName": null, "BpcustSalesDeptCode": "00", "BpcustSalesDeptName": null, "BpcustSalesmanCode": null, "BpcustShipAdd1": null, "BpcustShipAdd2": null, "BpcustShipAdd3": null, "BpcustShipContactName": null, "BpcustShipCountry": null, "BpcustShipEmail": null, "BpcustShipFax": null, "BpcustShipPhone": null, "BpcustShipPostalCode": null, "BpcustShipRegionCode": null, "BpcustShipRegionName": null, "BpcustStatementFlag": null, "BpcustTax1Code": null, "BpcustTax1Name": null, "BpcustTax2Code": null, "BpcustTax2Name": null, "BpcustTax3Code": null, "BpcustTax3Name": null, "BpcustTaxedCode": null, "BpcustTermCode": "NET30", "BpcustTermName": null, "BpcustTranAllowFlag": null, "BpcustTruckerPayDiscPc": null, "BpcustVUuid": "F22A4B6D2DBE6D88E05316821FAC7B73", "BpcustWebSite": null, "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ar-rest-api/rest/1/arcustomer/F22A4B6D2DBE6D88E05316821FAC7B73", "name": "arcustomer", "kind": "item" }, { "rel": "canonical", "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/ar-rest-api/rest/1/arcustomer/F22A4B6D2DBE6D88E05316821FAC7B73", "name": "arcustomer", "kind": "item" } ] } } } } } } } } } }, "components": { "securitySchemes": { "cmicBasicAuth": { "type": "http", "scheme": "basic", "description": "Basic authentication" } } } } ````