跳到主要内容

Update an invoice item

PUT /api/2.0/crm/invoiceitem/{id:[0-9]+}

Updates the selected invoice item with the parameters (title, description, price, etc.) specified in the request.

Request body​

id​

type: integer

Invoice item ID

Example: 0

title​

type: string

New invoice item title

Example: "string"

description​

type: string

New invoice item description

Example: "string"

price​

type: number

New invoice item price

Example: 0

sku​

type: string

New invoice item stock keeping unit

Example: "string"

stockQuantity​

type: number

New invoice item stock quantity

Example: 0

trackInventory​

type: boolean

Specifies if the inventory is tracked or not

Example: true

invoiceTax1id​

type: integer

New first invoice item tax ID

Example: 0

invoiceTax2id​

type: integer

New second invoice item tax ID

Example: 0

Request example​

{
  "id": 0,
  "title": "string",
  "description": "string",
  "price": 0,
  "sku": "string",
  "stockQuantity": 0,
  "trackInventory": true,
  "invoiceTax1id": 0,
  "invoiceTax2id": 0
}

Returns​

Updated invoice item. A request that is not authenticated returns 401.

Title​

type: string

Example: "Title"

StockKeepingUnit​

type: string

Example: "StockKeepingUnit"

Description​

type: string

Example: "Description"

Price​

type: number

Example: 1.2

Currency​

type: CurrencyInfoWrapper

StockQuantity​

type: number

Example: 2.2

TrackInvenory​

type: boolean

Example: true

InvoiceTax1​

type: InvoiceTaxWrapper

InvoiceTax2​

type: InvoiceTaxWrapper

CreateOn​

type: string

Example: "2020-12-14T22:13:41.5378233Z"

CreateBy​

type: EmployeeWraper

CanEdit​

type: boolean

Example: true

CanDelete​

type: boolean

Example: true

ID​

type: integer

Example: 1234

Response example​

{
  "Title": "Title",
  "StockKeepingUnit": "StockKeepingUnit",
  "Description": "Description",
  "Price": 1.2,
  "Currency": {
    "Title": "Chinese Yuan",
    "Symbol": "¥",
    "Abbreviation": "CNY",
    "CultureName": "CN",
    "IsConvertable": true,
    "IsBasic": false
  },
  "StockQuantity": 2.2,
  "TrackInvenory": true,
  "InvoiceTax1": {
    "Name": "Name",
    "Description": "Description",
    "Rate": "Rate",
    "CreateOn": "2020-12-14T22:13:41.5378233Z",
    "CreateBy": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "DisplayName": "Mike Zanyatski",
      "Title": "Manager",
      "AvatarSmall": "url to small avatar",
      "ProfileUrl": "/Products/People/Profile.aspx?user=administrator"
    },
    "CanEdit": true,
    "CanDelete": true,
    "ID": 1234
  },
  "InvoiceTax2": {
    "Name": "Name",
    "Description": "Description",
    "Rate": "Rate",
    "CreateOn": "2020-12-14T22:13:41.5378233Z",
    "CreateBy": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "DisplayName": "Mike Zanyatski",
      "Title": "Manager",
      "AvatarSmall": "url to small avatar",
      "ProfileUrl": "/Products/People/Profile.aspx?user=administrator"
    },
    "CanEdit": true,
    "CanDelete": true,
    "ID": 1234
  },
  "CreateOn": "2020-12-14T22:13:41.5378233Z",
  "CreateBy": {
    "Id": "00000000-0000-0000-0000-000000000000",
    "DisplayName": "Mike Zanyatski",
    "Title": "Manager",
    "AvatarSmall": "url to small avatar",
    "ProfileUrl": "/Products/People/Profile.aspx?user=administrator"
  },
  "CanEdit": true,
  "CanDelete": true,
  "ID": 1234
}