v1

latestOpenAPI 3.1.02026-07-242442479.7 KB

Update an Order

put/api/record/crmorder/{id}

Path parameters

idstring required

Use an Order's globally unique identifier (GUID)

Request body

accountidstring required

Use an Account's globally unique identifier (GUID) to change the related account.

companynamestring required

Company name of the related account.

addressstring

Full address of the related account.

amountdiscountnumber float

Set a number discount for the whole order. Will take precedence over the percentage field if both are set.

amountdiscountpercentnumber float

Set a percentage discount for the whole order, if the amountdiscount is also set the percentage discount will not be applied.

currencycodeinteger

Set the number which represents the relevant currency. (Picklist)

descriptionstring

Free text description of the order.

emailaddressstring

The email address associated with the related account.

faxstring

The fax number associated with the related account.

idnumberstring

The ID number associated with the related account.

owneridstring

A system user's GUID, will fill in automatically with the user who created the order and be used for permissions. Can be set manually.

rounddiscountcodeinteger

To apply a round discount to the order enter 1, otherwise enter 2. Defaults to no discount. (Picklist)

statuscodeinteger

Status of the order (Picklist)

taxincludecodeinteger

To include VAT in the total enter 1, otherwise enter 0. Defaults to include VAT unless defined otherwise. (Picklist)

telephonestring

The phone number associated with the related account.

Response

200

successboolean
datastring
messagestring

Example response

{
  "success": true,
  "data": "Record ID"
}