TAG LINE
SMALL TITLE

Contact

(API Version v2)


This entity represents a Contact that has been assigned to an Account.


What can you do with Contact?


Properties

Property Details
identity
READ-ONLY
"identity": 24
Type: Number
This is the unique numeric identifier for the Contact
contactTypeId
"contactTypeId": 14
Type: Number
Unique identifier for the associated ContactType object.
contactTypeName
"contactTypeName": "Sample Name"
Type: String
The name of the object associated with the contactTypeId property.
title
"title": "Mr."
Type: String
Title given to the contact.
firstName
"firstName": "John"
Type: String
The Contact's first name.
lastName
"lastName": "Doe"
Type: String
The Contact's last name.
name
READ-ONLY
"name": "John Doe"
Type: String
The Contact's full name generated based on firstName and lastName.
isUsedForTax
"isUsedForTax": true
Type: Boolean
Whether or not this Contact's address is used as the taxation address for the account.


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • contactTypeId
  • title
  • firstName
  • lastName
  • isUsedForTax

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the Contact object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

GETapi/v2/Contact/
Retrieve all of the Contact objects.
Retrieve all of the Contact objects.
GET api/v2/Contact/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "contactTypeId": 19,
            "contactTypeName": "Sample Text Data",
            "title": "Mr.",
            "firstName": "John",
            "lastName": "Doe",
            "name": "John Doe",
            "isUsedForTax": true
        }
    ]
}
GETapi/v2/Contact/Paged
Retrieve all of the Contact objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.
Retrieve all of the Contact objects in a paged fashion.
GET api/v2/Contact/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "contactTypeId": 18,
                "contactTypeName": "Sample Text Data",
                "title": "Mr.",
                "firstName": "John",
                "lastName": "Doe",
                "name": "John Doe",
                "isUsedForTax": true
            }
        ]
    }
}
GETapi/v2/Contact/Paged/Detail
Retrieve all of the Contact objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
Retrieve all of the Contact objects in a paged fashion with all object details.
GET api/v2/Contact/Paged/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "contactTypeId": 23,
                "contactTypeName": "Sample Text Data",
                "title": "Mr.",
                "firstName": "John",
                "lastName": "Doe",
                "name": "John Doe",
                "isUsedForTax": true,
                "details": {
                    "sampleSingleObject": {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    },
                    "sampleMultipleObjects": {
                        "totalCount": 1,
                        "items": [
                            {
                                "identity": 2,
                                "property1": "Sample Text",
                                "property2": "2021-04-26T15:25:29.117Z",
                                "property3": 2
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETapi/v2/Contact/{id}
Retrieve an instance of the Contact object by its ID.
{id}Unique identifier for the Contact object.
Retrieve an instance of the Contact object by its ID.
GET api/v2/Contact/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "contactTypeId": 25,
        "contactTypeName": "Sample Text Data",
        "title": "Mr.",
        "firstName": "John",
        "lastName": "Doe",
        "name": "John Doe",
        "isUsedForTax": true
    }
}
GETapi/v2/Contact/{id}/Detail
Retrieve deep detail of the Contact object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
{id}Unique identifier for the Contact object.
Retrieve deep detail of the Contact object by its ID.
GET api/v2/Contact/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "contactTypeId": 20,
        "contactTypeName": "Sample Text Data",
        "title": "Mr.",
        "firstName": "John",
        "lastName": "Doe",
        "name": "John Doe",
        "isUsedForTax": true,
        "details": {
            "sampleSingleObject": {
                "identity": 2,
                "property1": "Sample Text",
                "property2": "2021-04-26T15:25:29.117Z",
                "property3": 2
            },
            "sampleMultipleObjects": {
                "totalCount": 1,
                "items": [
                    {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    }
                ]
            }
        }
    }
}
PATCHapi/v2/Contact/{id}
Update or Add the Contact object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.
{id}Unique identifier for the Contact object.
Update or Add the Contact object and optionally make changes to any child objects.
PATCH api/v2/Contact/{id}

{
    "details": {},
    "contacts": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "contactTypeId": 14,
                "title": "Mr.",
                "firstName": "John",
                "lastName": "Doe",
                "isUsedForTax": true
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "patch",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "action": "created",
                "dtoTypeKey": "contact",
                "instance": {
                    "identity": 1,
                    "contactTypeId": 9,
                    "contactTypeName": "Sample Text Data",
                    "title": "Mr.",
                    "firstName": "John",
                    "lastName": "Doe",
                    "name": "John Doe",
                    "isUsedForTax": true
                }
            }
        ]
    }
}
POSTapi/v2/Contact/
Create a new instance of the Contact object.
Create a new instance of the Contact object.
POST api/v2/Contact/

{
    "contactTypeId": 6,
    "title": "Mr.",
    "firstName": "John",
    "lastName": "Doe",
    "isUsedForTax": true
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "contactTypeId": 27,
                "contactTypeName": "Sample Text Data",
                "title": "Mr.",
                "firstName": "John",
                "lastName": "Doe",
                "name": "John Doe",
                "isUsedForTax": true
            }
        ]
    }
}
PUTapi/v2/Contact/{id}
Update an existing instance of the Contact object.
Update an existing instance of the Contact object.
PUT api/v2/Contact/{id}

{
    "identity": 1,
    "contactTypeId": 26,
    "title": "Mr.",
    "firstName": "John",
    "lastName": "Doe",
    "isUsedForTax": true
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "contactTypeId": 23,
                "contactTypeName": "Sample Text Data",
                "title": "Mr.",
                "firstName": "John",
                "lastName": "Doe",
                "name": "John Doe",
                "isUsedForTax": true
            }
        ]
    }
}