TRY NEW VERSION

Try now New API BETA

Try out the new view and capabilities of the API documentation

START

PUT api/2.0/crm/invoiceline/{id} This function requires authentication

Description

Updates the selected invoice line with the parameters (invoice ID, invoice item ID, etc.) specified in the request.

Parameters
Name Description Type Example
id
sent in url
Invoice line ID number 1234
invoiceId
sent in body
Invoice ID number 1234
invoiceItemId
sent in body
Invoice item ID number 1234
invoiceTax1Id
sent in body
New first invoice tax ID
optional
number 1234
invoiceTax2Id
sent in body
New second invoice tax ID
optional
number 1234
sortOrder
sent in body
New sort order
optional
number 1234
description
sent in body
New description
optional
string some text
quantity
sent in body
New quantity
optional
decimal 1.1
price
sent in body
New price
optional
decimal 1.1
discount
sent in body
New discount
optional
decimal 1.1
Example
PUT api/2.0/crm/invoiceline/1234
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "invoiceId": 1234,
  "invoiceItemId": 1234,
  "invoiceTax1Id": 1234,
  "invoiceTax2Id": 1234,
  "sortOrder": 1234,
  "description": "some text",
  "quantity": 1.1,
  "price": 1.1,
  "discount": 1.1
}
Returns

Updated invoice line

Example Response

application/json

{
  "status": 0,
  "response": {
    "InvoiceID": 0,
    "InvoiceItemID": 0,
    "InvoiceTax1ID": 0,
    "InvoiceTax2ID": 0,
    "SortOrder": 0,
    "Description": "Description",
    "Quantity": 0.0,
    "Price": 0.0,
    "Discount": 0.0,
    "id": 1234
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <InvoiceID>0</InvoiceID>
    <InvoiceItemID>0</InvoiceItemID>
    <InvoiceTax1ID>0</InvoiceTax1ID>
    <InvoiceTax2ID>0</InvoiceTax2ID>
    <SortOrder>0</SortOrder>
    <Description>Description</Description>
    <Quantity>0</Quantity>
    <Price>0</Price>
    <Discount>0</Discount>
    <id>1234</id>
  </response>
</result>