POST v1/Generic/InvoiceUpdate
Request Information
URI Parameters
None.
Body Parameters
InvoiceUpdateRequestName | Description | Type | Additional information |
---|---|---|---|
Guid | globally unique identifier |
None. |
|
InvoiceID | integer |
None. |
|
InvoiceNumber | string |
None. |
|
InvoiceNumberExt | string |
None. |
|
CustomerId | integer |
None. |
|
UserName | string |
None. |
|
InvoiceDate | date |
None. |
|
InvoiceDueDate | date |
None. |
|
TermsCode | string |
None. |
|
SubTotalBilledAmount | decimal number |
None. |
|
InvoiceTaxAmount | decimal number |
None. |
|
TotalBilledAmount | decimal number |
None. |
|
PaymentDueAmount | decimal number |
None. |
|
PaymentBilledDateTime | date |
None. |
|
AddressLine1 | string |
None. |
|
AddressLine2 | string |
None. |
|
AddressLine3 | string |
None. |
|
City | string |
None. |
|
StateCode | string |
None. |
|
ZipCode | string |
None. |
|
Phone | string |
None. |
|
Extension | string |
None. |
|
EmailAddress | string |
None. |
|
ContactID | integer |
None. |
|
InvoiceNote | string |
None. |
|
SourceModule | string |
None. |
|
InvoiceTitle | string |
None. |
|
Note | string |
None. |
|
DisplayItem | boolean |
None. |
|
InvoiceStatus | string |
None. |
|
InvoiceLine | Collection of InvoiceLineSelectResponse |
None. |
|
PurchaseOrderNumber | string |
None. |
|
ItemDisplaySetting | string |
None. |
|
Company | string |
None. |
|
Attn | string |
None. |
|
Country | string |
None. |
|
ShowClosedOrders | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "Guid": "9deddaae-47a5-4bb4-bfea-b08b39feef21", "InvoiceID": 2, "InvoiceNumber": "sample string 3", "InvoiceNumberExt": "sample string 4", "CustomerId": 5, "UserName": "sample string 6", "InvoiceDate": "2024-11-21T04:50:11.6711807-05:00", "InvoiceDueDate": "2024-11-21T04:50:11.6711807-05:00", "TermsCode": "sample string 7", "SubTotalBilledAmount": 8.0, "InvoiceTaxAmount": 9.0, "TotalBilledAmount": 10.0, "PaymentDueAmount": 11.0, "PaymentBilledDateTime": "2024-11-21T04:50:11.6721728-05:00", "AddressLine1": "sample string 12", "AddressLine2": "sample string 13", "AddressLine3": "sample string 14", "City": "sample string 15", "StateCode": "sample string 16", "ZipCode": "sample string 17", "Phone": "sample string 18", "Extension": "sample string 19", "EmailAddress": "sample string 20", "ContactID": 1, "InvoiceNote": "sample string 21", "SourceModule": "sample string 22", "InvoiceTitle": "sample string 23", "Note": "sample string 24", "DisplayItem": true, "InvoiceStatus": "sample string 26", "InvoiceLine": [ { "InvoiceLineID": 1, "InvoiceID": 2, "ParentInvoiceLineID": 1, "OrderID": 3, "InvoiceLineType": "sample string 4", "Title": "sample string 5", "Priority": 6, "Quantity": 7.0, "Rate": 8.0, "AmountBilled": 9.0, "PreviouslyInvoiced": 10.0, "PreviouslyInvoicedBalance": 11.0, "InitialTotal": 12.0, "Note": "sample string 13", "bNoteVisible": true, "DisplayItem": true, "LineSubTotal": 16.0, "Tax": 17.0, "ItemId": 18, "ItemType": "sample string 19", "LineType": "sample string 20", "TempInvoiceLineID": 21, "InvoiceLineGuid": "741a5856-e791-4c0c-b499-46dae02085a3", "ParentInvoiceLineGuid": "90bbf063-428f-4824-b83d-3f9a01d82386", "InvoiceLineItem": [ { "InvoiceLineItemID": 1, "InvoiceID": 2, "InvoiceLineID": 3, "OrderID": 4, "OrderVersionID": 5, "OrderVersionDetailID": 6, "ServiceID": 7, "InvoiceLineDetailType": "sample string 8", "Quantity": 9.0, "Amount": 10.0, "Tax": 11.0, "AccountingGLID": "sample string 12", "PaymentAccountID": 13, "OrderVersionPostageID": 14, "AmountApplied": 15.0, "DisplayItem": true, "PreviouslyInvoiced": 17.0, "PreviouslyInvoicedBalance": 18.0, "InitialTotal": 19.0 }, { "InvoiceLineItemID": 1, "InvoiceID": 2, "InvoiceLineID": 3, "OrderID": 4, "OrderVersionID": 5, "OrderVersionDetailID": 6, "ServiceID": 7, "InvoiceLineDetailType": "sample string 8", "Quantity": 9.0, "Amount": 10.0, "Tax": 11.0, "AccountingGLID": "sample string 12", "PaymentAccountID": 13, "OrderVersionPostageID": 14, "AmountApplied": 15.0, "DisplayItem": true, "PreviouslyInvoiced": 17.0, "PreviouslyInvoicedBalance": 18.0, "InitialTotal": 19.0 } ], "ParentObjectType": "sample string 23", "ParentObjectID": 24, "IsMerged": true }, { "InvoiceLineID": 1, "InvoiceID": 2, "ParentInvoiceLineID": 1, "OrderID": 3, "InvoiceLineType": "sample string 4", "Title": "sample string 5", "Priority": 6, "Quantity": 7.0, "Rate": 8.0, "AmountBilled": 9.0, "PreviouslyInvoiced": 10.0, "PreviouslyInvoicedBalance": 11.0, "InitialTotal": 12.0, "Note": "sample string 13", "bNoteVisible": true, "DisplayItem": true, "LineSubTotal": 16.0, "Tax": 17.0, "ItemId": 18, "ItemType": "sample string 19", "LineType": "sample string 20", "TempInvoiceLineID": 21, "InvoiceLineGuid": "741a5856-e791-4c0c-b499-46dae02085a3", "ParentInvoiceLineGuid": "90bbf063-428f-4824-b83d-3f9a01d82386", "InvoiceLineItem": [ { "InvoiceLineItemID": 1, "InvoiceID": 2, "InvoiceLineID": 3, "OrderID": 4, "OrderVersionID": 5, "OrderVersionDetailID": 6, "ServiceID": 7, "InvoiceLineDetailType": "sample string 8", "Quantity": 9.0, "Amount": 10.0, "Tax": 11.0, "AccountingGLID": "sample string 12", "PaymentAccountID": 13, "OrderVersionPostageID": 14, "AmountApplied": 15.0, "DisplayItem": true, "PreviouslyInvoiced": 17.0, "PreviouslyInvoicedBalance": 18.0, "InitialTotal": 19.0 }, { "InvoiceLineItemID": 1, "InvoiceID": 2, "InvoiceLineID": 3, "OrderID": 4, "OrderVersionID": 5, "OrderVersionDetailID": 6, "ServiceID": 7, "InvoiceLineDetailType": "sample string 8", "Quantity": 9.0, "Amount": 10.0, "Tax": 11.0, "AccountingGLID": "sample string 12", "PaymentAccountID": 13, "OrderVersionPostageID": 14, "AmountApplied": 15.0, "DisplayItem": true, "PreviouslyInvoiced": 17.0, "PreviouslyInvoicedBalance": 18.0, "InitialTotal": 19.0 } ], "ParentObjectType": "sample string 23", "ParentObjectID": 24, "IsMerged": true } ], "PurchaseOrderNumber": "sample string 27", "ItemDisplaySetting": "sample string 28", "Company": "sample string 29", "Attn": "sample string 30", "Country": "sample string 31", "ShowClosedOrders": true }
application/xml, text/xml
Sample:
<InvoiceUpdateRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Guid>9deddaae-47a5-4bb4-bfea-b08b39feef21</Guid> <InvoiceID>2</InvoiceID> <InvoiceNumber>sample string 3</InvoiceNumber> <InvoiceNumberExt>sample string 4</InvoiceNumberExt> <CustomerId>5</CustomerId> <UserName>sample string 6</UserName> <InvoiceDate>2024-11-21T04:50:11.6711807-05:00</InvoiceDate> <InvoiceDueDate>2024-11-21T04:50:11.6711807-05:00</InvoiceDueDate> <TermsCode>sample string 7</TermsCode> <SubTotalBilledAmount>8</SubTotalBilledAmount> <InvoiceTaxAmount>9</InvoiceTaxAmount> <TotalBilledAmount>10</TotalBilledAmount> <PaymentDueAmount>11</PaymentDueAmount> <PaymentBilledDateTime>2024-11-21T04:50:11.6721728-05:00</PaymentBilledDateTime> <AddressLine1>sample string 12</AddressLine1> <AddressLine2>sample string 13</AddressLine2> <AddressLine3>sample string 14</AddressLine3> <City>sample string 15</City> <StateCode>sample string 16</StateCode> <ZipCode>sample string 17</ZipCode> <Phone>sample string 18</Phone> <Extension>sample string 19</Extension> <EmailAddress>sample string 20</EmailAddress> <ContactID>1</ContactID> <InvoiceNote>sample string 21</InvoiceNote> <SourceModule>sample string 22</SourceModule> <InvoiceTitle>sample string 23</InvoiceTitle> <Note>sample string 24</Note> <DisplayItem>true</DisplayItem> <InvoiceStatus>sample string 26</InvoiceStatus> <InvoiceLine> <InvoiceLineSelectResponse> <InvoiceLineID>1</InvoiceLineID> <InvoiceID>2</InvoiceID> <ParentInvoiceLineID>1</ParentInvoiceLineID> <OrderID>3</OrderID> <InvoiceLineType>sample string 4</InvoiceLineType> <Title>sample string 5</Title> <Priority>6</Priority> <Quantity>7</Quantity> <Rate>8</Rate> <AmountBilled>9</AmountBilled> <PreviouslyInvoiced>10</PreviouslyInvoiced> <PreviouslyInvoicedBalance>11</PreviouslyInvoicedBalance> <InitialTotal>12</InitialTotal> <Note>sample string 13</Note> <bNoteVisible>true</bNoteVisible> <DisplayItem>true</DisplayItem> <LineSubTotal>16</LineSubTotal> <Tax>17</Tax> <ItemId>18</ItemId> <ItemType>sample string 19</ItemType> <LineType>sample string 20</LineType> <TempInvoiceLineID>21</TempInvoiceLineID> <InvoiceLineGuid>741a5856-e791-4c0c-b499-46dae02085a3</InvoiceLineGuid> <ParentInvoiceLineGuid>90bbf063-428f-4824-b83d-3f9a01d82386</ParentInvoiceLineGuid> <InvoiceLineItem> <InvoiceLineItemSelectResponse> <InvoiceLineItemID>1</InvoiceLineItemID> <InvoiceID>2</InvoiceID> <InvoiceLineID>3</InvoiceLineID> <OrderID>4</OrderID> <OrderVersionID>5</OrderVersionID> <OrderVersionDetailID>6</OrderVersionDetailID> <ServiceID>7</ServiceID> <InvoiceLineDetailType>sample string 8</InvoiceLineDetailType> <Quantity>9</Quantity> <Amount>10</Amount> <Tax>11</Tax> <AccountingGLID>sample string 12</AccountingGLID> <PaymentAccountID>13</PaymentAccountID> <OrderVersionPostageID>14</OrderVersionPostageID> <AmountApplied>15</AmountApplied> <DisplayItem>true</DisplayItem> <PreviouslyInvoiced>17</PreviouslyInvoiced> <PreviouslyInvoicedBalance>18</PreviouslyInvoicedBalance> <InitialTotal>19</InitialTotal> </InvoiceLineItemSelectResponse> <InvoiceLineItemSelectResponse> <InvoiceLineItemID>1</InvoiceLineItemID> <InvoiceID>2</InvoiceID> <InvoiceLineID>3</InvoiceLineID> <OrderID>4</OrderID> <OrderVersionID>5</OrderVersionID> <OrderVersionDetailID>6</OrderVersionDetailID> <ServiceID>7</ServiceID> <InvoiceLineDetailType>sample string 8</InvoiceLineDetailType> <Quantity>9</Quantity> <Amount>10</Amount> <Tax>11</Tax> <AccountingGLID>sample string 12</AccountingGLID> <PaymentAccountID>13</PaymentAccountID> <OrderVersionPostageID>14</OrderVersionPostageID> <AmountApplied>15</AmountApplied> <DisplayItem>true</DisplayItem> <PreviouslyInvoiced>17</PreviouslyInvoiced> <PreviouslyInvoicedBalance>18</PreviouslyInvoicedBalance> <InitialTotal>19</InitialTotal> </InvoiceLineItemSelectResponse> </InvoiceLineItem> <ParentObjectType>sample string 23</ParentObjectType> <ParentObjectID>24</ParentObjectID> <IsMerged>true</IsMerged> </InvoiceLineSelectResponse> <InvoiceLineSelectResponse> <InvoiceLineID>1</InvoiceLineID> <InvoiceID>2</InvoiceID> <ParentInvoiceLineID>1</ParentInvoiceLineID> <OrderID>3</OrderID> <InvoiceLineType>sample string 4</InvoiceLineType> <Title>sample string 5</Title> <Priority>6</Priority> <Quantity>7</Quantity> <Rate>8</Rate> <AmountBilled>9</AmountBilled> <PreviouslyInvoiced>10</PreviouslyInvoiced> <PreviouslyInvoicedBalance>11</PreviouslyInvoicedBalance> <InitialTotal>12</InitialTotal> <Note>sample string 13</Note> <bNoteVisible>true</bNoteVisible> <DisplayItem>true</DisplayItem> <LineSubTotal>16</LineSubTotal> <Tax>17</Tax> <ItemId>18</ItemId> <ItemType>sample string 19</ItemType> <LineType>sample string 20</LineType> <TempInvoiceLineID>21</TempInvoiceLineID> <InvoiceLineGuid>741a5856-e791-4c0c-b499-46dae02085a3</InvoiceLineGuid> <ParentInvoiceLineGuid>90bbf063-428f-4824-b83d-3f9a01d82386</ParentInvoiceLineGuid> <InvoiceLineItem> <InvoiceLineItemSelectResponse> <InvoiceLineItemID>1</InvoiceLineItemID> <InvoiceID>2</InvoiceID> <InvoiceLineID>3</InvoiceLineID> <OrderID>4</OrderID> <OrderVersionID>5</OrderVersionID> <OrderVersionDetailID>6</OrderVersionDetailID> <ServiceID>7</ServiceID> <InvoiceLineDetailType>sample string 8</InvoiceLineDetailType> <Quantity>9</Quantity> <Amount>10</Amount> <Tax>11</Tax> <AccountingGLID>sample string 12</AccountingGLID> <PaymentAccountID>13</PaymentAccountID> <OrderVersionPostageID>14</OrderVersionPostageID> <AmountApplied>15</AmountApplied> <DisplayItem>true</DisplayItem> <PreviouslyInvoiced>17</PreviouslyInvoiced> <PreviouslyInvoicedBalance>18</PreviouslyInvoicedBalance> <InitialTotal>19</InitialTotal> </InvoiceLineItemSelectResponse> <InvoiceLineItemSelectResponse> <InvoiceLineItemID>1</InvoiceLineItemID> <InvoiceID>2</InvoiceID> <InvoiceLineID>3</InvoiceLineID> <OrderID>4</OrderID> <OrderVersionID>5</OrderVersionID> <OrderVersionDetailID>6</OrderVersionDetailID> <ServiceID>7</ServiceID> <InvoiceLineDetailType>sample string 8</InvoiceLineDetailType> <Quantity>9</Quantity> <Amount>10</Amount> <Tax>11</Tax> <AccountingGLID>sample string 12</AccountingGLID> <PaymentAccountID>13</PaymentAccountID> <OrderVersionPostageID>14</OrderVersionPostageID> <AmountApplied>15</AmountApplied> <DisplayItem>true</DisplayItem> <PreviouslyInvoiced>17</PreviouslyInvoiced> <PreviouslyInvoicedBalance>18</PreviouslyInvoicedBalance> <InitialTotal>19</InitialTotal> </InvoiceLineItemSelectResponse> </InvoiceLineItem> <ParentObjectType>sample string 23</ParentObjectType> <ParentObjectID>24</ParentObjectID> <IsMerged>true</IsMerged> </InvoiceLineSelectResponse> </InvoiceLine> <PurchaseOrderNumber>sample string 27</PurchaseOrderNumber> <ItemDisplaySetting>sample string 28</ItemDisplaySetting> <Company>sample string 29</Company> <Attn>sample string 30</Attn> <Country>sample string 31</Country> <ShowClosedOrders>true</ShowClosedOrders> </InvoiceUpdateRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
stringResponse Formats
application/json, text/json
Sample:
"sample string 1"
application/xml, text/xml
Sample:
<string>sample string 1</string>