Customer contacts

Contact information for a customer.

List customer contacts

get/objects/accounts-receivable/customer-contact

Returns a collection with a key, ID, and link for each customer contact. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "17",
      • "id": "ALEX",
      • "href": "/objects/accounts-receivable/customer-contact/17"
      },
    • {
      • "key": "18",
      • "id": "Ashly",
      • "href": "/objects/accounts-receivable/customer-contact/18"
      },
    • {
      • "key": "19",
      • "id": "Lisa",
      • "href": "/objects/accounts-receivable/customer-contact/19"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get a customer contact
get/objects/accounts-receivable/customer-contact/{key}
Returns detailed information for a specified customer contact.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the customer contact.


 
 Example:  1
Responses 
200
OK


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "1",
    • "categoryName": "Main Office",
    • "contact": {
      • "key": "197",
      • "id": "Jeffrey Palms"
      },
    • "audit": {
      • "createdDateTime": "2022-04-20T16:20:00Z",
      • "modifiedDateTime": "2022-04-20T16:20:00Z",
      • "createdBy": "1",
      • "modifiedBy": "95"
      },
    • "customer": {
      • "key": "15",
      • "id": "CPACBELL"
      }
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Query customer contacts
post/services/core/query
Use the query service to find customer contacts that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


Request samples