Document toolboxDocument toolbox

Account REST API

Owned by Andrew Hill (Deactivated)
Last updated: Sept 30, 2024 by Jason Andrew
2 min read

3.0.0

The Account REST API is used to create, get, update or delete account objects. Deleting an account will also delete all account locations currently associated with the account. 


On this page:

Related pages:

Resource URL Summary

Retrieve the details of a specific Account

GET /seiapi/v3/trans/Account/${AccountNum}

Insert or Update the details of a specific Account

PUT /seiapi/v3/trans/Account/${AccountNum}

Delete a specific Account

DELETE /seiapi/v3/trans/Account/${AccountNum}

API Specific Parameters

ParameterDescription

${AccountNum}

Identifies the Account Location Related Objects Account Object.

HTTP Headers

This API uses the default ServiceMobility HTTP Headers.


API Specifics

Retrieve the details of a specific Account

This REST API will return an Account with the specified ID. The Account with the specified ID must already exist in the system.

URL

GET /seiapi/v3/trans/Account/${AccountNum}

HTTP Request Body

This request does not require a request body. 

HTTP Response Body

On success, an HTTP status code of 200 will be returned, and the response body will contain an Account Location Related Objects Account Object. Otherwise, on error, the response body will contain a descriptive reason for the error. 

JSON Format 
{
    "AccountNum": "", 
	"AccountsReceivable": "",
    "AccountType": "", 
    "Addresses": [
       {
          "AddrLine1": "", 
          "AddrLine2": "", 
          "AddrLine3": "", 
          "AddrLine4": "", 
          "AddrType": "", 
          "City": "", 
          "Country": "", 
          "Intersection" : "",
          "Lat" : "",
          "Lon" : "",
          "Region": "", 
          "Zip": ""
       }   
    ], 
    "Contacts": [
        {
            "Email": "", 
            "FirstName": "", 
            "IsPrimary": true, 
            "LastName": "", 
            "Phones": [
                {
                    "PhoneNum": "", 
                    "PhoneType": ""
                }
            ]
        }
    ],
	"FlexAttrs": {
      "${FlexFormID}": {
        "${FlexAttrID}": [
          "",
          ""
        ]
      }
    }, 
	"FlexForms": [
        "${FlexFormID}"
    ],
	"Integrations": {
		"Financial": {
			"ID": "",
			"Extensions": {
				"": ""
			}
		}
	},
	"IsActive": true,
    "Name": "", 
    "Notes" : "",
	"PaymentSystemID": "",
	"TaxExempt": false,
    "TierPricingID": "",
    "Website": ""
}

Insert or Update the details of a specific Account

This REST API will insert a new Account with the specified ID into the system, if an Account with the specified ID does not already exist in the system.

If, however, the Account with the specified ID does already exist in the system, then this REST API will update (i.e. replace) the already existing Account with the specified ID with the details of the Account supplied in the HTTP Request Body.

URL

PUT /seiapi/v3/trans/Account/${AccountNum}

HTTP Request Body

The HTTP request body must contain a valid Account Location Related Objects Account Object.

HTTP Response

On success the API will return a response code of 200.

Delete a specific Account

This REST API will delete an Account with the specified ID from the system. The Account with the specified ID must already exist in the system.

URL

DELETE /seiapi/v3/trans/Account/${AccountNum}

HTTP Request Body

This request does not require a request body.

HTTP Response

On success an HTTP response code of 200 will be returned. The system will return HTTP response code 410 in case of non-existent Account Location Related Objects Account Object.