Waiting for engine...
Skip to main content

Provision Partner Customer Account operation

Partners can use the Provision Partner Customer Account operation by to programmatically provision accounts for their customers as secondary accounts of the partner account.

The Boomi Enterprise Platform Partner API and the Boomi Enterprise Platform Partner API connector both support the Provision Partner Customer Account operation. The procedure by which a partner provisions a customer account is as follows:

  1. The client initiates the action by sending an Account Provision object EXECUTE request that specifies metadata for the customer account, including the status and features, to the .

  2. The platform returns an Account Provision Result object, which specifies a request tracking ID and PENDING status.

  3. The client requests the status of the action by sending an Account Provision object GET request, which specifies the tracking ID.

  4. The platform returns an Account Provision Result object, which specifies either PENDING or COMPLETED status.

    • If the status is COMPLETED, customer account provisioning is successful, and the response includes the account ID.

    • If the status is still PENDING, the client can resend the GET request (step 3).

Note: Salesforce is ’s sales, finance, and support system of record for its customers. partners use the Salesforce Partner Relationship Management (PRM) portal to manually provision and manage their customer accounts. The Account Provision object allows for high-volume, limited customization provisioning of trial and production accounts. The Account Provision object does not allow for modification of PRM account attributes.
When you use the Account Provision object to programmatically provision a customer account, it creates a corresponding account and opportunity record in the Salesforce PRM system. The attributes of the new PRM account record are as follows:

  • Trial User defaults to the user name under which they requested the API action.
  • Calculation of the Term is automatic.
  • Payment Terms default to those specified in the partner agreement.
  • The opportunity name default is the account name appended with the account creation date.
  • The opportunity stage defaults to Qualify - 30% for a trial account.
  • The close date on the account and opportunity default to the date of creation.
  • Opportunity Type defaults to New Business.

    The Ready to Close and Billing Approve check boxes in the PRM account creation screen are not applicable to account provisioning through the API.

Account Provision object​

<AccountProvision name="" street="" city="" stateCode="" zipCode="" countryCode="" status="" expirationDate="">
  <product productCode="" quantity=""/>
  .
  .
  .
  <product productCode="" quantity=""/>
</AccountProvision>
FieldTypeDescription
FilterFilterFilter
namestringThe name of the customer account.
streetstringThe billing street address of the customer account.
citystringThe billing city of the customer account.
stateCodestringThe two- or three-character abbreviation for the billing state of the customer account. State codes are based on the ISO-3166 standard. For example, PA is the state code for Pennsylvania in the United States, and NSW is the state code for New South Wales in Australia.
You must enter a state code for Australia, Canada, and the United States. Brazil, Italy, and Mexico support state codes, but they are not required. For any other country, send a blank value (stateCode="").
zipCodestringThe billing postal or ZIP Code of the customer account.
countryCodestringThe billing country code of the customer account. Country codes are based on the ISO-3166 standard— for example, US.
statusstringThe requested customer account status: active (production) or trial.
expirationDatestringThe requested customer account contractual billing end date in the format yyyy-MM-dd. If status is trial in an EXECUTE request, this field is ignored — the trial expiration date defaults to 60 days from the date of creation.
productCodestringThe Salesforce PRM product code for a requested customer account feature. The list of product codes available to a partner is in their price book in the PRM portal.
quantityintThe quantity applicable to productCode.

Supported operations​

GETQUERYCREATEUPDATEEXECUTEDELETE
Supported Not supported Not supported  SupportedSupported  Not supported

  • The EXECUTE operation initiates the provisioning of a customer account for a partner. The Account Provision Result object returns the status of the request and an ID for tracking that status.

  • The GET operation specifies the tracking ID returned by the EXECUTE operation in the Account Provision Result object. The response to a GET operation is another Account Provision Result object.

  • The UPDATE operation initiates an update to the provisioning of the specified partner customer account, and the ID specifies the account. The Account Provision Result object contains the status of the UPDATE request.

    Support for the following updates are individually and in combination:

    • Modify customer contact information.

    • Change status from trial to active.

    • Enable products, such as features and connectors, from the partner’s price book.

    The request body contains the fields to be updated only.

Note: You cannot use the Boomi Partner API’s override parameter, accountId, with these operations.

Account Provision Result object​

The EXECUTE, GET, or UPDATE operations return the Account Provision Result object on an Account Provision object.

<AccountProvisionResult id="" accountId="" status=""/>
FieldTypeDescription
idstring(For EXECUTE operations) Tracking ID of a partner customer account provisioning request.
accountIdstring(For GET operations where status is COMPLETED) ID of a newly provisioned partner customer account.
statusstringStatus of the partner customer account provisioning request:
- PENDING for EXECUTE and GET operations
- COMPLETED for GET and UPDATE operations

SOAP implementation​

  • EXECUTE operation

    The following example initiates provisioning of a trial partner customer account named Podner Sub with the features identified by the product codes E_Ent1Yr and STDCONN.

    Request:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
      xmlns:par="http://partner.api.platform.boomi.com/" xmlns:api="http://api.platform.boomi.com/">
       <soapenv:Header>
          <wsse:Security
           xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
            <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
              <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
              <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">
               ATOMSPHERE_PASSWORD
              </wsse:Password>
            </wsse:UsernameToken>
          </wsse:Security>
       </soapenv:Header>
       <soapenv:Body>
          <par:execute>
             <par:object xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:AccountProvision" 
             			name="Podner Sub" street="111 Tumbleweed Road" city="Old West" stateCode="PA" zipCode="15999" countryCode="US" status="trial">
             		<api:product productCode="E_Ent1Yr" quantity="1"/>
             		<api:product productCode="STDCONN" quantity="1"/>
             </par:object>
          </par:execute>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <ns4:executeResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns4="http://partner.api.platform.boomi.com/">
             <result xsi:type="bns:AccountProvisionResult" status="PENDING" id="0123456789ABCDEFGH"/>
          </ns4:executeResponse>
       </S:Body>
    </S:Envelope>

    In the returned Account Provision Result object, the id attribute value, 0123456789ABCDEFGH, is a tracking ID that you can specify in subsequent GET requests to retrieve the status of the provisioning request.

  • GET operation

    The following example retrieves the status of a provisioning request with tracking ID 0123456789ABCDEFGH.

    Request:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
      xmlns:par="http://partner.api.platform.boomi.com/" xmlns:api="http://api.platform.boomi.com/">
       <soapenv:Header>
          <wsse:Security
           xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
            <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
              <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
              <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">
               ATOMSPHERE_PASSWORD
              </wsse:Password>
            </wsse:UsernameToken>
          </wsse:Security>
       </soapenv:Header>
       <soapenv:Body>
          <par:get>
              <par:objectType>AccountProvision</par:objectType>
              <par:objectId>0123456789ABCDEFGH</par:objectId>
          </par:get>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <ns4:getResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns4="http://partner.api.platform.boomi.com/">
             <result xsi:type="bns:AccountProvisionResult" status="COMPLETED" accountId="podnersub-0A1B2C" id="0123456789ABCDEFGH"/>
          </ns4:getResponse>
       </S:Body>
    </S:Envelope>

    In the returned Account Provision Result object:

    • The status attribute value, COMPLETED, indicates the successful provisioning of the partner customer account.

    • The accountId attribute value, podnersub-0A1B2C, is the ID of the new account.

  • UPDATE operation

    The following example initiates an update to the provisioning of the account podnersub-0A1B2C. Specifically, the request is to:

    • Add the four-digit suffix to the customer’s ZIP Code.

    • Change the status of the account from trial to active with an expiration date of March 2, 2017.

    • Enable the feature identified by the product code ADVCONN.

    Request:

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
      xmlns:par="http://partner.api.platform.boomi.com/" xmlns:api="http://api.platform.boomi.com/">
       <soapenv:Header>
          <wsse:Security
           xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
            <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
              <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
              <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">
               ATOMSPHERE_PASSWORD
              </wsse:Password>
            </wsse:UsernameToken>
          </wsse:Security>
       </soapenv:Header>
       <soapenv:Body>
          <par:update>
             <object xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:AccountProvision" 
             			id="podnersub-0A1B2C" zipCode="15999-8765" status="active" expirationDate="2017-03-02">
             		<api:product productCode="ADVCONN" quantity="1"/>
             </object>
          </par:update>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <ns4:updateResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns4="http://partner.api.platform.boomi.com/">
             <result xsi:type="bns:AccountProvisionResult" status="COMPLETED"/>
          </ns4:updateResponse>
       </S:Body>
    </S:Envelope>

On this Page