COconductor-is

Update a sales representative

Changed on

Updates an existing sales representative.

post/quickbooks-desktop/sales-representatives/{id}

Request

Path parameters

idstring required

The QuickBooks-assigned unique identifier of the sales representative to update.

Example:80000001-1234567890

Headers

Conductor-End-User-Idstring required

The ID of the End-User to receive this request.

Example:end_usr_1234567abcdefg

Request body

revisionNumberstring required

The current QuickBooks-assigned revision number of the sales representative object you are updating, which you can get by fetching the object first. Provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.

initialstring

The initials of this sales representative's name.

Maximum length: 5 characters.

isActiveboolean

Indicates whether this sales representative is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to true.

entityIdstring

The sales representative's corresponding person entity in QuickBooks, stored as either an employee, vendor, or other-name entry.

Example request

{
  "revisionNumber": "1721172183",
  "initial": "JD",
  "isActive": true,
  "entityId": "80000001-1234567890"
}

Response

Returns the updated sales representative.

idstring required

The unique identifier assigned by QuickBooks to this sales representative. This ID is unique across all sales representatives but not across different QuickBooks object types.

objectType'qbd_sales_representative' required

The type of object. This value is always "qbd_sales_representative".

createdAtstring required

The date and time when this sales representative was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

updatedAtstring required

The date and time when this sales representative was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

revisionNumberstring required

The current QuickBooks-assigned revision number of this sales representative object, which changes each time the object is modified. When updating this object, you must provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.

initialstring required

The initials of this sales representative's name.

isActiveboolean required

Indicates whether this sales representative is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to true.

Example response

{
  "id": "80000001-1234567890",
  "objectType": "qbd_sales_representative",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "initial": "JD",
  "isActive": true,
  "entity": {
    "id": "80000001-1234567890",
    "fullName": "John Doe"
  }
}

Changes

  • 1de07095c4b7Revision changes
    • warning

      for the path request parameter id, the maxLength was set to 36

    • warning

      the request property's maxLength was set to 36

  • 10d4e9ebd1dfRevision changes
    • breaking

      response property entity/fullName list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property entity/id list-of-types was widened by adding types null to media type application/json of response 200