POST api/Invoice/FinalizeInvoiceOrQuote

Created by: Vijaya Created On: 2018/02/27 Updates Invoice/Quote status to Posted/Closed.

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
WebOrderID	integer	None.
InvoiceID	integer	None.
CustomerID	integer	None.
CustomerName	string	None.
CustomerEmail	string	None.
CustomerType	integer	None.
SalesPersonID	integer	None.
OrderNumber	string	None.
BranchID	integer	None.
InvoiceDate	date	None.
InvoiceAccountType	integer	None.
TermID	integer	None.
InvoiceStatusPL	integer	None.
PercentOfDiscount	decimal number	None.
ItemsTotal	decimal number	None.
Discount	decimal number	None.
Credits	integer	None.
GST	decimal number	None.
Total	decimal number	None.
Balance	decimal number	None.
BillingPhone	string	None.
BillingFax	string	None.
BillingAddress	string	None.
BillingStreet	string	None.
BillingPostalCode	string	None.
BillingStateID	integer	None.
BillingCountryID	integer	None.
DeliveryName	string	None.
DelieryAddress	string	None.
DeliveryStreet	string	None.
DeliveryPostalCode	string	None.
DeliveryStateID	integer	None.
DeliveryCountryID	integer	None.
CourierID	integer	None.
TrackingNumber	string	None.
IsCourierBooked	boolean	None.
PickupTIme	date	None.
IsOrderRequiresPicking	boolean	None.
PriorityID	integer	None.
PickingStatusID	integer	None.
TagNumbers	string	None.
PartIDS	string	None.
UsedTypes	string	None.
Quantities	string	None.
Price_ExGSTS	string	None.
Price_InGSTS	string	None.
GeneralINotesInformation	string	None.
NotesToAppearonInvoice	string	None.
PaymentModeIDs	string	None.
Amounts	string	None.
PaymentNotes	string	None.
PaymentDate	date	None.
CreatedBy	integer	None.
CreatedDate	date	None.
InvoiceItemsArray	string	None.
InvoicePaymentsArray	string	None.
QuoteItemsArray	string	None.
QuotePaymentsArray	string	None.
PrintitemsOnInvoice	boolean	None.
DiscountType	string	None.
InvQuotId	integer	None.
InvoiceAccountTypeString	string	None.
InvoiceStartDate	date	None.
InvoiceEndDate	date	None.
Comments	string	None.
FromLocation	integer	None.
ToLocation	integer	None.
InvoiceGroup1ID	integer	None.
InvoiceGroup2ID	integer	None.
PricelistCat	integer	None.
POSnotes	string	None.
ExchangeItemsArray	string	None.
OldInvoiceID	integer	None.
CurrentInvoiceID	integer	None.
SearchTerm	string	None.
drpParam1	integer	None.
drpParam2	integer	None.
IsHardDelete	boolean	None.
AvailableBalance	decimal number	None.
CapriconNumber	string	None.
Surcharge	decimal number	None.
IsWPIaddress	boolean	None.
DefaultPaymentID	integer	None.
SelfExchangeItemsArray	string	None.
QuoteID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "WebOrderID": 1,
  "InvoiceID": 2,
  "CustomerID": 3,
  "CustomerName": "sample string 4",
  "CustomerEmail": "sample string 5",
  "CustomerType": 6,
  "SalesPersonID": 7,
  "OrderNumber": "sample string 8",
  "BranchID": 9,
  "InvoiceDate": "2021-02-24T12:55:15.1063425+11:00",
  "InvoiceAccountType": 11,
  "TermID": 12,
  "InvoiceStatusPL": 13,
  "PercentOfDiscount": 14.0,
  "ItemsTotal": 15.0,
  "Discount": 16.0,
  "Credits": 17,
  "GST": 18.0,
  "Total": 19.0,
  "Balance": 20.0,
  "BillingPhone": "sample string 21",
  "BillingFax": "sample string 22",
  "BillingAddress": "sample string 23",
  "BillingStreet": "sample string 24",
  "BillingPostalCode": "sample string 25",
  "BillingStateID": 26,
  "BillingCountryID": 27,
  "DeliveryName": "sample string 28",
  "DelieryAddress": "sample string 29",
  "DeliveryStreet": "sample string 30",
  "DeliveryPostalCode": "sample string 31",
  "DeliveryStateID": 32,
  "DeliveryCountryID": 33,
  "CourierID": 34,
  "TrackingNumber": "sample string 35",
  "IsCourierBooked": true,
  "PickupTIme": "2021-02-24T12:55:15.1063425+11:00",
  "IsOrderRequiresPicking": true,
  "PriorityID": 39,
  "PickingStatusID": 40,
  "TagNumbers": "sample string 41",
  "PartIDS": "sample string 42",
  "UsedTypes": "sample string 43",
  "Quantities": "sample string 44",
  "Price_ExGSTS": "sample string 45",
  "Price_InGSTS": "sample string 46",
  "GeneralINotesInformation": "sample string 47",
  "NotesToAppearonInvoice": "sample string 48",
  "PaymentModeIDs": "sample string 49",
  "Amounts": "sample string 50",
  "PaymentNotes": "sample string 51",
  "PaymentDate": "2021-02-24T12:55:15.1063425+11:00",
  "CreatedBy": 53,
  "CreatedDate": "2021-02-24T12:55:15.1063425+11:00",
  "InvoiceItemsArray": "sample string 55",
  "InvoicePaymentsArray": "sample string 56",
  "QuoteItemsArray": "sample string 57",
  "QuotePaymentsArray": "sample string 58",
  "PrintitemsOnInvoice": true,
  "DiscountType": "sample string 60",
  "InvQuotId": 61,
  "InvoiceAccountTypeString": "sample string 62",
  "InvoiceStartDate": "2021-02-24T12:55:15.1063425+11:00",
  "InvoiceEndDate": "2021-02-24T12:55:15.1063425+11:00",
  "Comments": "sample string 65",
  "FromLocation": 66,
  "ToLocation": 67,
  "InvoiceGroup1ID": 68,
  "InvoiceGroup2ID": 69,
  "PricelistCat": 70,
  "POSnotes": "sample string 71",
  "ExchangeItemsArray": "sample string 72",
  "OldInvoiceID": 73,
  "CurrentInvoiceID": 74,
  "SearchTerm": "sample string 75",
  "drpParam1": 76,
  "drpParam2": 77,
  "IsHardDelete": true,
  "AvailableBalance": 1.0,
  "CapriconNumber": "sample string 79",
  "Surcharge": 80.0,
  "IsWPIaddress": true,
  "DefaultPaymentID": 82,
  "SelfExchangeItemsArray": "sample string 83",
  "QuoteID": 84
}

application/xml, text/xml

Sample:

<InvoiceQuoteModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TARWebAPI.Models">
  <Amounts>sample string 50</Amounts>
  <AvailableBalance>1</AvailableBalance>
  <Balance>20</Balance>
  <BillingAddress>sample string 23</BillingAddress>
  <BillingCountryID>27</BillingCountryID>
  <BillingFax>sample string 22</BillingFax>
  <BillingPhone>sample string 21</BillingPhone>
  <BillingPostalCode>sample string 25</BillingPostalCode>
  <BillingStateID>26</BillingStateID>
  <BillingStreet>sample string 24</BillingStreet>
  <BranchID>9</BranchID>
  <CapriconNumber>sample string 79</CapriconNumber>
  <Comments>sample string 65</Comments>
  <CourierID>34</CourierID>
  <CreatedBy>53</CreatedBy>
  <CreatedDate>2021-02-24T12:55:15.1063425+11:00</CreatedDate>
  <Credits>17</Credits>
  <CurrentInvoiceID>74</CurrentInvoiceID>
  <CustomerEmail>sample string 5</CustomerEmail>
  <CustomerID>3</CustomerID>
  <CustomerName>sample string 4</CustomerName>
  <CustomerType>6</CustomerType>
  <DefaultPaymentID>82</DefaultPaymentID>
  <DelieryAddress>sample string 29</DelieryAddress>
  <DeliveryCountryID>33</DeliveryCountryID>
  <DeliveryName>sample string 28</DeliveryName>
  <DeliveryPostalCode>sample string 31</DeliveryPostalCode>
  <DeliveryStateID>32</DeliveryStateID>
  <DeliveryStreet>sample string 30</DeliveryStreet>
  <Discount>16</Discount>
  <DiscountType>sample string 60</DiscountType>
  <ExchangeItemsArray>sample string 72</ExchangeItemsArray>
  <FromLocation>66</FromLocation>
  <GST>18</GST>
  <GeneralINotesInformation>sample string 47</GeneralINotesInformation>
  <InvQuotId>61</InvQuotId>
  <InvoiceAccountType>11</InvoiceAccountType>
  <InvoiceAccountTypeString>sample string 62</InvoiceAccountTypeString>
  <InvoiceDate>2021-02-24T12:55:15.1063425+11:00</InvoiceDate>
  <InvoiceEndDate>2021-02-24T12:55:15.1063425+11:00</InvoiceEndDate>
  <InvoiceGroup1ID>68</InvoiceGroup1ID>
  <InvoiceGroup2ID>69</InvoiceGroup2ID>
  <InvoiceID>2</InvoiceID>
  <InvoiceItemsArray>sample string 55</InvoiceItemsArray>
  <InvoicePaymentsArray>sample string 56</InvoicePaymentsArray>
  <InvoiceStartDate>2021-02-24T12:55:15.1063425+11:00</InvoiceStartDate>
  <InvoiceStatusPL>13</InvoiceStatusPL>
  <IsCourierBooked>true</IsCourierBooked>
  <IsHardDelete>true</IsHardDelete>
  <IsOrderRequiresPicking>true</IsOrderRequiresPicking>
  <IsWPIaddress>true</IsWPIaddress>
  <ItemsTotal>15</ItemsTotal>
  <NotesToAppearonInvoice>sample string 48</NotesToAppearonInvoice>
  <OldInvoiceID>73</OldInvoiceID>
  <OrderNumber>sample string 8</OrderNumber>
  <POSnotes>sample string 71</POSnotes>
  <PartIDS>sample string 42</PartIDS>
  <PaymentDate>2021-02-24T12:55:15.1063425+11:00</PaymentDate>
  <PaymentModeIDs>sample string 49</PaymentModeIDs>
  <PaymentNotes>sample string 51</PaymentNotes>
  <PercentOfDiscount>14</PercentOfDiscount>
  <PickingStatusID>40</PickingStatusID>
  <PickupTIme>2021-02-24T12:55:15.1063425+11:00</PickupTIme>
  <Price_ExGSTS>sample string 45</Price_ExGSTS>
  <Price_InGSTS>sample string 46</Price_InGSTS>
  <PricelistCat>70</PricelistCat>
  <PrintitemsOnInvoice>true</PrintitemsOnInvoice>
  <PriorityID>39</PriorityID>
  <Quantities>sample string 44</Quantities>
  <QuoteID>84</QuoteID>
  <QuoteItemsArray>sample string 57</QuoteItemsArray>
  <QuotePaymentsArray>sample string 58</QuotePaymentsArray>
  <SalesPersonID>7</SalesPersonID>
  <SearchTerm>sample string 75</SearchTerm>
  <SelfExchangeItemsArray>sample string 83</SelfExchangeItemsArray>
  <Surcharge>80</Surcharge>
  <TagNumbers>sample string 41</TagNumbers>
  <TermID>12</TermID>
  <ToLocation>67</ToLocation>
  <Total>19</Total>
  <TrackingNumber>sample string 35</TrackingNumber>
  <UsedTypes>sample string 43</UsedTypes>
  <WebOrderID>1</WebOrderID>
  <drpParam1>76</drpParam1>
  <drpParam2>77</drpParam2>
</InvoiceQuoteModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.