Logo
Submit a request
Follow

Customers

Adding a Customer

URL

https://app.bluefolder.com/api/2.0/customers/add.aspx

Request

<request>
    <customerAdd>
        <billToAddressId></billToAddressId>
        <billToAddressName></billToAddressName>
        <billToCity></billToCity>
        <billToCountry></billToCountry>
        <billToPostalCode></billToPostalCode>
        <billToState></billToState>
        <billToStreetAddress></billToStreetAddress>
        <billToType></billToType>
        <customerName></customerName>
        <customerType></customerType>
        <description></description>
        <websiteURL></websiteURL>
        <industryType></industryType>
        <notes></notes>
        <defaultLaborRateId></defaultLaborRateId>
        <defaultTaxCodeId></defaultTaxCodeId>
        <inactive></inactive>
        <taxExempt></taxExempt>
        <primaryContact>
            <firstName></firstName>
            <lastName></lastName>
            <email></email>
            <jobTitle></jobTitle>
            <notes></notes>
            <phone></phone>
            <phoneFax></phoneFax>
            <phoneHome></phoneHome>
            <phoneMobile></phoneMobile>
            <phoneOther></phoneOther>
            <title></title>
        </primaryContact>
        <primaryLocation>
            <locationName></locationName>
            <addressCity></addressCity>
            <addressCountry></addressCountry>
            <addressPostalCode></addressPostalCode>
            <addressState></addressState>
            <addressStreet></addressStreet>
            <locationNotes></locationNotes>
            <serviceManagerId></serviceManagerId>
            <technicianId></technicianId>
            <zone></zone>
        </primaryLocation>
        <customFields>
            <customField name="field_name1"></customField>
            <customField name="field_name2"></customField>
        </customFields>
        <accountManagerId></accountManagerId>
        <serviceManagerId></serviceManagerId>
        <technicianId></technicianId>
        <externalId></externalId>
    </customerAdd>
</request>
            
  • billToType - string; one of primaryLocation (default), otherCustomer, address
  • billToAddressId - numeric, required only when billToType is 'otherCustomer' then must match an existing customer location id from one of your customers in your customer location list
  • billToAddressName - string, only used when billToType is 'address'
  • billToCity - string, only used when billToType is 'address'
  • billToCountry - string, only used when billToType is 'address'
  • billToPostalCode - string, only used when billToType is 'address'
  • billToState - string, only used when billToType is 'address'
  • billToStreetAddress - string, only used when billToType is 'address'
  • customerName - (required) string (100 char limit)
  • customerType - string (50 char limit)
  • description - string (250 char limit)
  • websiteURL - string (255 char limit)
  • industryType - string (50 char limit)
  • notes - string (no char limit)
  • defaultLaborRateId - numeric, must match an existing labor rate Id from your item list
  • defaultTaxCodeId - numeric, must match an existing tax code Id from your tax codes list
  • inactive - boolean
  • taxExempt - boolean
  • primaryContact
    • firstName - (required) string (25 char limit)
    • lastName - (required) string (25 char limit)
    • email - string (100 char limit)
    • jobTitle - string (50 char limit)
    • notes - string (1000 char limit)
    • phone - string (30 char limit)
    • phoneFax - string (30 char limit)
    • phoneHome - string (30 char limit)
    • phoneMobile - string (30 char limit)
    • phoneOther - string (30 char limit)
    • title - string (10 char limit)
  • primaryLocation
    • locationName - string (50 char limit)
    • addressCity - string (25 char limit)
    • addressCountry - string (25 char limit)
    • addressPostalCode - string (10 char limit)
    • addressState - string (25 char limit)
    • addressStreet - string (250 char limit)
    • locationNotes - string (1000 char limit)
    • serviceManagerId - numeric, must match an existing User Id from your user list
    • technicianId - numeric, must match an existing User Id from your user list
    • zone - string (25 char limit)
  • customFields
    • customField - the "name" attribute must specify the exact name of a custom field in your account. The actual value included between the opening and closing "customField" element tags should be a string value, regardless of the custom field's "data type".
  • accountManagerId - numeric, must match an existing User Id from your user list
  • serviceManagerId - numeric, must match an existing User Id from your user list
  • technicianId - numeric, must match an existing User Id from your user list
  • externalId - string, external identifier that can be used to retrieve or track a customer

Response

<response status="ok">
    <customerId>xxxxxx</customerId>
</response>
            

Editing a Customer

URL

https://app.bluefolder.com/api/2.0/customers/edit.aspx

Request

<request>
    <customerEdit>
        <billToAddressId></billToAddressId>
        <billToAddressName></billToAddressName>
        <billToCity></billToCity>
        <billToCountry></billToCountry>
        <billToPostalCode></billToPostalCode>
        <billToState></billToState>
        <billToStreetAddress></billToStreetAddress>
        <billToType></billToType>
        <customerId></customerId>
        <customerName></customerName>
        <customerType></customerType>
        <description></description>
        <websiteURL></websiteURL>
        <industryType></industryType>
        <notes></notes>
        <defaultLaborRateId></defaultLaborRateId>
        <defaultTaxCodeId></defaultTaxCodeId>
        <inactive></inactive>
        <taxExempt></taxExempt>
        <customFields>
            <customField name="field_name1"></customField>
            <customField name="field_name2"></customField>
        </customFields>
        <accountManagerId></accountManagerId>
        <serviceManagerId></serviceManagerId>
        <technicianId></technicianId>
        <externalId></externalId>
    </customerEdit>
</request>
            
  • billToType - string; one of primaryLocation (default), otherCustomer, address
  • billToAddressId - numeric, required only when billToType is 'otherCustomer' then must match an existing customer location id from one of your customers in your customer location list
  • billToAddressName - string, only used when billToType is 'address'
  • billToCity - string, only used when billToType is 'address'
  • billToCountry - string, only used when billToType is 'address'
  • billToPostalCode - string, only used when billToType is 'address'
  • billToState - string, only used when billToType is 'address'
  • billToStreetAddress - string, only used when billToType is 'address'
  • customerId - (required, if externalId not provided) numeric, the Id of the customer to be edited
  • customerName - string (100 char limit)
  • customerType - string (50 char limit)
  • description - string (250 char limit)
  • websiteURL - string (255 char limit)
  • industryType - string (50 char limit)
  • notes - string (no char limit)
  • defaultLaborRateId - numeric, must match an existing labor rate Id from your item list
  • defaultTaxCodeId - numeric, must match an existing tax code Id from your tax codes list
  • inactive - boolean
  • taxExempt - boolean
  • customFields
    • customField - the "name" attribute must specify the exact name of a custom field in your account. The actual value included between the opening and closing "customField" element tags should be a string value, regardless of the custom field's "data type".
  • accountManagerId - numeric, must match an existing User Id from your user list
  • serviceManagerId - numeric, must match an existing User Id from your user list
  • technicianId - numeric, must match an existing User Id from your user list
  • externalId - (required, if customerId not provided) string, external identifier that can be used to retrieve or track a customer

Response

<response status="ok">
    <customerId>xxxxxx</customerId>
    <externalId></externalId>
</response>
            

Retrieving a Single Customer

URL

https://app.bluefolder.com/api/2.0/customers/get.aspx

Request

<request>
    <customerId>xxxxxx</customerId>
    <externalId></externalId>
</request>
            
  • customerId - (required, if externalId not provided) numeric, the Id of the customer to be edited
  • externalId - (required, if customerId not provided) string, external identifier that can be used to retrieve or track a customer

Response

<response status="ok">
    <customer>
      <accountManagerId></accountManagerId>
      <billToAddressId></billToAddressId>
      <billToAddressName></billToAddressName>
      <billToCity></billToCity>
      <billToCountry></billToCountry>
      <billToCustomerId></billToCustomerId>
      <billToCustomerName></billToCustomerName>
      <billToPostalCode></billToPostalCode>
      <billToState></billToState>
      <billToStreetAddress></billToStreetAddress>
      <billToType></billToType>
      <customerId></customerId>
      <customerName>Amenity Arbor</customerName>
      <customerType></customerType>
      <dateTimeCreated></dateTimeCreated>
      <defaultLaborRateId></defaultLaborRateId>
      <defaultTaxCodeId></defaultTaxCodeId>
      <description>&lt;&gt;</description>
      <inactive></inactive>
      <industryType></industryType>
      <notes></notes>
      <serviceManagerId></serviceManagerId>
      <taxExempt></taxExempt>
      <technicianId></technicianId>
      <website></website>
      <externalId></externalId>
      <customFields>
        <customField>
          <name></name>
          <value></value>
        </customField>
      </customFields>
      <contacts>
        <contact>
          <customerId></customerId>
          <contactId></contactId>
          <displayName></displayName>
          <email></email>
          <firstName></firstName>
          <fullName></fullName>
          <isPrimary></isPrimary>
          <jobTitle></jobTitle>
          <lastName></lastName>
          <locationId></locationId>
          <middleName></middleName>
          <notes></notes>
          <phone></phone>
          <phoneFax></phoneFax>
          <phoneHome></phoneHome>
          <phoneMobile></phoneMobile>
          <phoneOther></phoneOther>
          <portalLastLogin></portalLastLogin>
          <portalLoginCount></portalLoginCount>
          <portalUserId></portalUserId>
          <portalUsername></portalUsername>
          <title></title>
        </contact>
      </contacts>
      <locations>
        <location>
          <addressCity></addressCity>
          <addressCountry></addressCountry>
          <addressPostalCode></addressPostalCode>
          <addressState></addressState>
          <addressStreet></addressStreet>
          <customerId></customerId>
          <isPrimary></isPrimary>
          <locationId></locationId>
          <locationName></locationName>
          <notes></notes>
          <phone></phone>
          <serviceManagerId></serviceManagerId>
          <technicianId></technicianId>
          <zone></zone>
        </location>
      </locations>
      <comments>
        <comment>
          <comment></comment>
          <createdByUserId></createdByUserId>
          <customerId></customerId>
          <dateTimeCreated></dateTimeCreated>
          <id></id>
        </comment>
      </comments>
      <equipment>
        <equipmentItem>
          <createdByUserId></createdByUserId>
          <customerId></customerId>
          <dateTimeCreated></dateTimeCreated>
          <equipName></equipName>
          <equipType></equipType>
          <id></id>
          <locationId></locationId>
          <mfrName></mfrName>
          <modelNo></modelNo>
          <nextServiceDate></nextServiceDate>
          <notes></notes>
          <purchaseDate></purchaseDate>
          <refNo></refNo>
          <serialNo></serialNo>
          <serviceInterval></serviceInterval>
          <serviceIntervalUnit></serviceIntervalUnit>
          <wherePurchased></wherePurchased>
        </equipmentItem>
      </equipment>
    </customer>
</response>
            

Retrieving a List of Customers

URL

https://app.bluefolder.com/api/2.0/customers/list.aspx

Request

<request>
    <customerList>
        <listType></listType>
    </customerList>
</request>
            
Parameters: listType: either 'basic' or 'full'

Response (for 'basic' list)

<response status="ok">
    <customer>
        <customerId></customerId>
        <customerName></customerName>
        <customerType></customerType>
        <inactive></inactive>
        <externalId></externalId>
    </customer>
</response>
            

Retrieving Custom Field List for Customers

URL

https://app.bluefolder.com/api/2.0/customers/getCustomFields.aspx

Request

<request></request>
            
 

Response

<response status="ok">
    <customFields>
        <customField>
            <DisplayOrder></DisplayOrder>
            <FieldDataType></FieldDataType>
            <FieldId></FieldId>
            <FieldListValues>
                <FieldListValue></FieldListValue>
                ...
            </FieldListValues>
            <FieldName></FieldName>
            <FieldRequired></FieldRequired>
        </customField>
        ...
    </customFields>
</response>
            
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request