Customer messages

This object represents a message associated with a customer.

List customer messages

get/objects/accounts-receivable/customer-message

Returns a collection with a key, ID, and link for each customer message.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "Active Message",
      • "href": "/objects/accounts-receivable/customer-message/1"
      },
    • {
      • "key": "2",
      • "id": "Inactive Message",
      • "href": "/objects/accounts-receivable/customer-message/2"
      },
    • {
      • "key": "3",
      • "id": "Message Balance",
      • "href": "/objects/accounts-receivable/customer-message/3"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100
    }
}
Create a customer message
post/objects/accounts-receivable/customer-message
Creates a new customer message.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
Creates a new customer message.


id
required
string
Unique ID for the customer message.


 
 Example:  "Message 1"
message
required
string
Message text.


 
 Example:  "Express shipping now available!"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "New Customer Message",
  • "message": "We look forward to doing business together!",
  • "status": "active"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "New Customer Message",
    • "href": "/objects/accounts-receivable/customer-message/1"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a customer message
get/objects/accounts-receivable/customer-message/{key}
Returns detailed information for a specified customer message.


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


 
 Example:  73
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "15",
    • "id": "WelcomeMessage",
    • "message": "Welcome to the company",
    • "status": "active",
    • "audit": {
      • "createdDateTime": "2023-08-16T13:26:56Z",
      • "modifiedDateTime": "2023-08-16T13:26:56Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "href": "/objects/accounts-receivable/customer-message/15"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Update a customer message
patch/objects/accounts-receivable/customer-message/{key}
Updates an existing customer message by setting field values. Any fields not provided remain unchanged.


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


 
 Example:  73
Request Body schema: application/json
message
string
Message text.


 
 Example:  "Express shipping now available!"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "message": "Hello and welcome!"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "15",
    • "id": "WelcomeMessage",
    • "href": "/objects/accounts-receivable/customer-message/15"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Query customer messages
post/services/core/query
Use the query service to find customer messages that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}