POST api/quickbook/UpdateInvoice

Sparse Update Invoice

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
RequestModel	QboCommonRequestModel	None.
Id	string	None.
InvoiceID	integer	None.
CustomerID	string	None.
ReceiverAccountID	string	None.
InvoiceDate	date	None.
DueDate	date	None.
QbTaxId	string	None.
TaxType	string	None.
TotalTax	decimal number	None.
DepositAmt	decimal number	None.
Currency	string	None.
TotalAmount	decimal number	None.
PaymentAmount	decimal number	None.
InvoiceNo	string	None.
IsPartialUpdate	boolean	None.
invoiceItems	Collection of InvoiceItemRequestDataModel	None.
SyncToken	integer	None.

Request Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "requestModel": {
    "userId": 1,
    "apiKey": "sample string 2"
  },
  "id": "sample string 1",
  "invoiceID": 2,
  "customerID": "sample string 3",
  "receiverAccountID": "sample string 4",
  "invoiceDate": "2025-07-17T04:31:19.3412086+00:00",
  "dueDate": "2025-07-17T04:31:19.3412086+00:00",
  "qbTaxId": "sample string 5",
  "taxType": "sample string 6",
  "totalTax": 7.0,
  "depositAmt": 8.0,
  "currency": "sample string 9",
  "totalAmount": 10.0,
  "paymentAmount": 1.0,
  "invoiceNo": "sample string 11",
  "isPartialUpdate": true,
  "invoiceItems": [
    {
      "id": "sample string 1",
      "itemName": "sample string 2",
      "itemDescription": "sample string 3",
      "itemQty": 4,
      "itemType": "sample string 5",
      "itemAmount": 6.0
    },
    {
      "id": "sample string 1",
      "itemName": "sample string 2",
      "itemDescription": "sample string 3",
      "itemQty": 4,
      "itemType": "sample string 5",
      "itemAmount": 6.0
    }
  ],
  "syncToken": 13
}

application/xml, text/xml

Sample:

<InvoiceRequestDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel">
  <Currency>sample string 9</Currency>
  <CustomerID>sample string 3</CustomerID>
  <DepositAmt>8</DepositAmt>
  <DueDate>2025-07-17T04:31:19.3412086+00:00</DueDate>
  <Id>sample string 1</Id>
  <InvoiceDate>2025-07-17T04:31:19.3412086+00:00</InvoiceDate>
  <InvoiceID>2</InvoiceID>
  <InvoiceNo>sample string 11</InvoiceNo>
  <IsPartialUpdate>true</IsPartialUpdate>
  <PaymentAmount>1</PaymentAmount>
  <QbTaxId>sample string 5</QbTaxId>
  <ReceiverAccountID>sample string 4</ReceiverAccountID>
  <RequestModel>
    <APIKey>sample string 2</APIKey>
    <UserId>1</UserId>
  </RequestModel>
  <SyncToken>13</SyncToken>
  <TaxType>sample string 6</TaxType>
  <TotalAmount>10</TotalAmount>
  <TotalTax>7</TotalTax>
  <invoiceItems>
    <InvoiceItemRequestDataModel>
      <Id>sample string 1</Id>
      <ItemAmount>6</ItemAmount>
      <ItemDescription>sample string 3</ItemDescription>
      <ItemName>sample string 2</ItemName>
      <ItemQty>4</ItemQty>
      <ItemType>sample string 5</ItemType>
    </InvoiceItemRequestDataModel>
    <InvoiceItemRequestDataModel>
      <Id>sample string 1</Id>
      <ItemAmount>6</ItemAmount>
      <ItemDescription>sample string 3</ItemDescription>
      <ItemName>sample string 2</ItemName>
      <ItemQty>4</ItemQty>
      <ItemType>sample string 5</ItemType>
    </InvoiceItemRequestDataModel>
  </invoiceItems>
</InvoiceRequestDataModel>

multipart/form-data

Sample:

<InvoiceRequestDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel"><Currency>sample string 9</Currency><CustomerID>sample string 3</CustomerID><DepositAmt>8</DepositAmt><DueDate>2025-07-17T04:31:19.3412086+00:00</DueDate><Id>sample string 1</Id><InvoiceDate>2025-07-17T04:31:19.3412086+00:00</InvoiceDate><InvoiceID>2</InvoiceID><InvoiceNo>sample string 11</InvoiceNo><IsPartialUpdate>true</IsPartialUpdate><PaymentAmount>1</PaymentAmount><QbTaxId>sample string 5</QbTaxId><ReceiverAccountID>sample string 4</ReceiverAccountID><RequestModel><APIKey>sample string 2</APIKey><UserId>1</UserId></RequestModel><SyncToken>13</SyncToken><TaxType>sample string 6</TaxType><TotalAmount>10</TotalAmount><TotalTax>7</TotalTax><invoiceItems><InvoiceItemRequestDataModel><Id>sample string 1</Id><ItemAmount>6</ItemAmount><ItemDescription>sample string 3</ItemDescription><ItemName>sample string 2</ItemName><ItemQty>4</ItemQty><ItemType>sample string 5</ItemType></InvoiceItemRequestDataModel><InvoiceItemRequestDataModel><Id>sample string 1</Id><ItemAmount>6</ItemAmount><ItemDescription>sample string 3</ItemDescription><ItemName>sample string 2</ItemName><ItemQty>4</ItemQty><ItemType>sample string 5</ItemType></InvoiceItemRequestDataModel></invoiceItems></InvoiceRequestDataModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Action Status

CommonResponseDataModel

Name	Type	Additional information
ReturnID	integer	Required
Message	string	Required
Successful	boolean	Required
Code	integer	None.
TotalRecord	integer	None.

Response Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "returnID": 1,
  "message": "sample string 2",
  "successful": true,
  "code": 4,
  "totalRecord": 5
}

application/xml, text/xml

Sample:

<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">
  <Code>4</Code>
  <Message>sample string 2</Message>
  <ReturnID>1</ReturnID>
  <Successful>true</Successful>
  <TotalRecord>5</TotalRecord>
</CommonResponseDataModel>

multipart/form-data

Sample:

<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"><Code>4</Code><Message>sample string 2</Message><ReturnID>1</ReturnID><Successful>true</Successful><TotalRecord>5</TotalRecord></CommonResponseDataModel>