Customer messages

This object represents a message associated with a customer. The customer message field on invoices that are created for the associated customer are populated with the message contained in this object. A customer is associated with a message using the customerMessage property in the customer object.

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 with you!",
  • "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:  4
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "15",
    • "id": "Welcome Message",
    • "message": "Welcome to the company!",
    • "status": "active",
    • "audit": {
      • "createdDateTime": "2024-08-16T13:26:56Z",
      • "createdByUser": {
        },
      • "createdBy": "1",
      • "modifiedDateTime": "2024-08-16T13:26:56Z",
      • "modifiedByUser": {
        },
      • "modifiedBy": "1"
      },
    • "href": "/objects/accounts-receivable/customer-message/15"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
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:  4
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": "Welcome Message",
    • "href": "/objects/accounts-receivable/customer-message/15"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}