API Catalog

Create a AR Customer

01 Oct 2025
7 Minutes to read

Print
Dark
Light

Create a AR Customer

Updated on 01 Oct 2025
7 Minutes to read

Print
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback!

Post

/ar-rest-api/rest/1/arcustomer

Create Customers

UI Location: Financials - Accounts Recievable - Setup - Maintain Customers

Security

HTTP

Type basic

Basic authentication

Header parameters

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourceItem+json

Body parameters

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": "" }

BpcustCollCode

string Required

Collector Code

💻 UI Fieldname: *Collector

Max length4

BpcustHldbkAccCode

string Required

Retainage Account Code

Max length16

BpcustFrtDeptCode

string Required

Freight Charges Department Code

Max length6

BpcustSalesAccCode

string Required

Sales Account Code

Max length16

BpcustTermCode

string Required

Terms Code

💻 UI Fieldname: *Terms

Max length6

BpcustCashDeptCode

string Required

Bank Account Department Code

Max length6

BpcustFrtAccCode

string Required

Freight Charges Account Code

Max length16

BpcustBpCode

string Required

Business Partner Code

Max length8

BpcustHldbkDeptCode

string Required

Retainage Department Code

Max length6

BpcustChargeCode

string Required

Interest Charge Code

Max length3

BpcustInsDeptCode

string Required

Insurance Charges Department Code

Max length6

BpcustMiscDeptCode

string Required

Miscellaneous Charges Department Code

Max length6

BpcustVUuid

string Required

UNIQUE UUID of column

Max length64

BpcustCompCode

string Required

Company code

Max length8

BpcustDiscDeptCode

string Required

Discount Department Code

Max length6

BpcustBpCodeBf

string Required

Business Partner Code

💻 UI Fieldname: Customer

Max length8

BpcustInsAccCode

string Required

Insurance Charges Account Code

Max length16

BpcustArAccCode

string Required

Accounts Receivable Control Account Code

Max length16

BpcustSalesDeptCode

string Required

Sales Department Code

Max length6

BpcustArDeptCode

string Required

Accounts Receivable Department Code

Max length6

BpcustCashAccCode

string Required

Bank Account Code

Max length16

BpcustMiscAccCode

string Required

Misceallenous Charges Account Code

Max length16

BpcustDiscAccCode

string Required

Discount Account Code

Max length16

BpcustCurrCode

string Required

Currency Code

Max length3

BpcustInsDeptName

string

Insurance Charges Department Name

Max length30

BpcustJbBillTypeName

string

Default Job Billing Type Name

Max length60

BpcustChargeName

string

Interest Charge Name

Max length30

BpcustTax1Name

string

Tax1 Name

Max length30

BpcustShipRegionCode

string

Shipping State/Province Code

Max length3

BpcustBankName

string

Customer Bank Name (EFT)

Max length30

BpcustDiscAccName

string

Discount Account Name

Max length30

BpcustDeliveryDiscPc

number

Delivery Charge Discount Percentage

Max length7

BpcustBpccCode

string

Customer Credit Code

Max length10

BpcustAvgDaysToPayInv

number

Average days to pay weighted by payed amount, for a customer based on his invoice payment history within the cut-off days viz. da.arctrl.arctrl_days_to_pay_cut_off_days.

Max length6

BpcustShipFax

string

Shipping Fax Number

Max length20

BpcustJbBillRateTableCode

string

Default Job Billing Rate Code.

Max length10

BpcustHldbkDeptName

string

Retainage Department Name

Max length30

BpcustTax2Code

string

Tax Code 2

Max length11

BpcustSalesDeptName

string

Sales Department Name

Max length30

BpcustClassName

string

Class Name

Max length30

BpcustShipCountry

string

Shipping Country Name

Max length30

BpcustIuUpdateDate

string

Last Update Date

BpcustStatementFlag

string

Are Statements required for this customer Y/N

Max length1

BpcustLastUpdateDate

string

Last date record updated

BpcustTranAllowFlag

string

Allow transactions against this customer Y/N

Max length1

BpcustDaysOutstInvPaidTtl

number

Not Used, You May Leave Blank

Max length10

BpcustIuCreateDate

string

Initial Create Date

BpcustMiscDeptName

string

Miscellaneous Charges Department Name

Max length30

BpcustFrtAccName

string

Freight Charges Account Name

Max length30

BpcustJbInvFormatCode

string

Default Job Billing Invoice Format Code.

Max length4

BpcustCreditHoldFlag

string

Reference column, update through Workflow process if aging > xx days then set to 'Y'

Max length1

BpcustBankAccNum2

string

Customer Bank Account Number (EFT)

Max length17

BpcustBillRegionCode

string

Billing State/Province Code

💻 UI Fieldname: State

Max length3

BpcustBankAccNum3

string

Customer Bank Suffix (EFT)

Max length12

BpcustObjectOraseq

number

Oraseq Num for Notes Attachment by da.dbk_sys_info.oraseq

BpcustMsPropagateCompFlag

string

Material Sales Propagate Company Exist Flag, If Found (Y) Else (N)

Max length1

BpcustShipContactName

string

Shipping Contact Name

Max length30

BpcustShipEmail

string

Shipping Email Address

Max length80

BpcustShipAdd1

string

Shipping Address Line 1

Max length40

BpcustInsAccName

string

Insurance Charges Account Name

Max length30

BpcustBankAccNum1

string

Customer Bank Transit Number (EFT)

Max length9

BpcustShipAdd3

string

Shipping Address Line 3

Max length40

BpcustShipAdd2

string

Shippiing Address Line 2

Max length40

BpcustDunnFlag

string

Are dunning letters to be send to the customer Y/N

Max length1

BpcustJbInvFormatName

string

Default Job Billing Invoice Format Name

Max length60

BpcustTax3Code

string

Tac Code 3

Max length11

BpcustFullyPaidInvs

number

Max length10

BpcustShipRegionName

string

Region Name

Max length30

BpcustJbretrName

string

Default Retainage Name

Max length60

BpcustBillFax

string

Billling Fax Number

💻 UI Fieldname: Fax

Max length20

BpcustArAccName

string

Accounts Receivable Control Account Name

Max length30

BpcustActiveToDate

string

Not Used

BpcustJbMapName

string

Default Job Billing Map Name

Max length60

BpcustCashAccName

string

Bank Account Name

Max length30

BpcustCurrName

string

Currency Name

Max length30

BpcustTax2Name

string

Tax2 Name

Max length30

BpcustMiscAccName

string

Misceallenous Charges Account Name

Max length30

BpcustArDeptName

string

Accounts Receivable Department Name

Max length30

BpcustActiveFlag

string

Indicates if the customer is active - Valid values are 0,1 or null

💻 UI Fieldname: Active Flag

Max length1

BpcustBillCountry

string

Billing Country Name

💻 UI Fieldname: Country

Max length30

BpcustDiscPc

number

Discount Percent (overrides Terms Code)

Max length7

BpcustSalesmanCode

string

Employee Code for the Salesman

Max length16

BpIuCreateDatetime

string

Initial Create Timestamp

Max length6

BpcustClassCode

string

Class code

💻 UI Fieldname: Class

Max length4

BpcustFrtDeptName

string

Freight Charges Department Name

Max length30

BpcustBillContactName

string

Billing Contact Name

💻 UI Fieldname: Attention

Max length30

BpcustArStatementEmailFlag

string

Ar statement Email Addresses Flag

💻 UI Fieldname: Email AR Statement

Max length1

BpcustBankCode

string

Customer Bank Code (EFT)

Max length9

BpcustTruckerPayDiscPc

number

Trucker Pay Discount Percentage

Max length7

BpcustJbBillTypeCode

string

Default Job Billing Type Code.

Max length4

BpcustArStatementEmailAdd

string

Ar statement Email Addresses string

Max length4000

BpcustShipPhone

string

Shipping Phone Number

Max length20

BpcustBillPhone

string

Billling Phone Number

💻 UI Fieldname: Phone

Max length20

BpcustCrLimitAmt

number

Credit Limit

Max length18

BpcustSalesAccName

string

Sales Account Name

Max length30

BpcustTax1Code

string

Tax Code 1

Max length11

BpcustCollName

string

Collector Name

Max length30

BpcustBillAdd2

string

Billing Address Line 2

💻 UI Fieldname: Suite

Max length40

BpcustBillAdd1

string

Billing Address Line 1

💻 UI Fieldname: Street Address

Max length40

BpcustHldbkAccName

string

Retainage Account Name

Max length30

BpcustBillAdd3

string

Billing Address Line 3

💻 UI Fieldname: City

Max length40

BpcustIuCreateDatetime

string

Initial Create Timestamp

Max length6

BpcustBillPostalCode

string

Billiing ZIP/Postal Code

💻 UI Fieldname: ZIP / Postal Code

Max length12

BpcustActiveFromDate

string

Not Used

BpcustJbInvGroupCode

string

Default Job Billing Invoice Link Code.

Max length10

BpcustInvDeliq

number

Max length10

BpcustJbBillRateTableName

string

Default Job Billing Rate Name

Max length60

BpcustJbretrCode

string

Default Retainage Code.

Max length10

BpcustCompName

string

Company Name

Max length30

BpcustWebSite

string

Web site of the customer

💻 UI Fieldname: Web Site

Max length200

BpcustJbMapCode

string

Default Job Billing Map Code.

Max length10

BpcustLastUpdateUser

string

Last user that updated record

Max length30

BpcustShipPostalCode

string

Shipping Zip/Postal Code

Max length12

BpcustIuUpdateDatetime

string

Last Update Timestamp

Max length6

BpcustAllocApdiscJobFlag

string

Allocate AP Discounts to Job Flag Y/N

Max length1

BpcustBpNameBf

string

Business Partner Name

Max length50

BpcustDiscDeptName

string

Discount Department Name

Max length30

BpcustBpccOraseq

number

Customer Credit Code Oraseq

BpcustLastInvDate

string

Not Used

BpcustBillRegionName

string

Billing State/Province Name

Max length30

BpcustTax3Name

string

Tax3 Name

Max length30

BpIuUpdateDatetime

string

Last Update Timestamp

Max length6

BpcustTermName

string

Terms Name

Max length30

BpcustBpName

string

Business Partner Name

Max length50

BpcustTaxedCode

string

Is this customer tax exempt Y/N

Max length1

BpcustBillEmail

string

Billing Email Number

💻 UI Fieldname: E-mail

Max length80

BpcustTenantId

string

Max length30

BpcustHldbkPc

number

Retainage Percent (overrides Terms Code)

Max length7

BpcustCashDeptName

string

Bank Account Department Name

Max length30

Responses

201

Created

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourceitem+json

example-0

Successful Response

{
  "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

Successful Response

{
  "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"
    }
  ]
}

object

What's Next

Create multiple AR Invoices

Create a AR Customer

Create Customers

What's Next

Contact Us