PUT api/proforma/update

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
DocumentId	integer	None.
DocumentType	DocumentType	None.
DocumentNumber	string	None.
UserId	integer	None.
CustomerId	integer	None.
Customer	Customer	None.
DocumentDate	date	None.
DueDate	date	None.
SubTotal	decimal number	None.
DiscountType	DiscountType	None.
DiscountValue	decimal number	None.
TaxType	TaxType	None.
TaxRate	decimal number	None.
GrandTotal	decimal number	None.
TopMessage	string	None.
BottomMessage	string	None.
TermsConditions	string	None.
Status	DocumentStatus	None.
Products	Collection of DocumentProduct	None.
OtherCharges	Collection of OtherCharge	None.
Payment	PaymentInfo	None.
CreatedAt	date	None.
UpdatedAt	date	None.

Request Formats

application/json, text/json

Sample:

{
  "DocumentId": 1,
  "DocumentType": 1,
  "DocumentNumber": "sample string 2",
  "UserId": 3,
  "CustomerId": 4,
  "Customer": {
    "CustomerId": 1,
    "UserId": 2,
    "CustomerName": "sample string 3",
    "CompanyName": "sample string 4",
    "Email": "sample string 5",
    "Phone": "sample string 6",
    "Address": "sample string 7",
    "GSTNumber": "sample string 8",
    "CreatedAt": "2026-04-17T20:37:52.2697308+05:30",
    "UpdatedAt": "2026-04-17T20:37:52.2697308+05:30"
  },
  "DocumentDate": "2026-04-17T20:37:52.2697308+05:30",
  "DueDate": "2026-04-17T20:37:52.2697308+05:30",
  "SubTotal": 6.0,
  "DiscountType": 1,
  "DiscountValue": 7.0,
  "TaxType": 1,
  "TaxRate": 8.0,
  "GrandTotal": 9.0,
  "TopMessage": "sample string 10",
  "BottomMessage": "sample string 11",
  "TermsConditions": "sample string 12",
  "Status": 1,
  "Products": [
    {
      "DocumentProductId": 1,
      "ProductId": 2,
      "ProductName": "sample string 3",
      "Quantity": 4,
      "Price": 5.0,
      "Total": 6.0,
      "HSNCode": "sample string 7",
      "GSTRate": 8.0
    },
    {
      "DocumentProductId": 1,
      "ProductId": 2,
      "ProductName": "sample string 3",
      "Quantity": 4,
      "Price": 5.0,
      "Total": 6.0,
      "HSNCode": "sample string 7",
      "GSTRate": 8.0
    }
  ],
  "OtherCharges": [
    {
      "ChargeId": 1,
      "ChargeName": "sample string 2",
      "Amount": 3.0
    },
    {
      "ChargeId": 1,
      "ChargeName": "sample string 2",
      "Amount": 3.0
    }
  ],
  "Payment": {
    "PaymentId": 1,
    "Amount": 2.0,
    "PaymentMethod": "sample string 3",
    "TransactionId": "sample string 4",
    "PaidDate": "2026-04-17T20:37:52.2697308+05:30"
  },
  "CreatedAt": "2026-04-17T20:37:52.2697308+05:30",
  "UpdatedAt": "2026-04-17T20:37:52.2697308+05:30"
}

application/xml, text/xml

Sample:

<ProformaInvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Quotation.Bo">
  <BottomMessage>sample string 11</BottomMessage>
  <CreatedAt>2026-04-17T20:37:52.2697308+05:30</CreatedAt>
  <Customer>
    <Address>sample string 7</Address>
    <CompanyName>sample string 4</CompanyName>
    <CreatedAt>2026-04-17T20:37:52.2697308+05:30</CreatedAt>
    <CustomerId>1</CustomerId>
    <CustomerName>sample string 3</CustomerName>
    <Email>sample string 5</Email>
    <GSTNumber>sample string 8</GSTNumber>
    <Phone>sample string 6</Phone>
    <UpdatedAt>2026-04-17T20:37:52.2697308+05:30</UpdatedAt>
    <UserId>2</UserId>
  </Customer>
  <CustomerId>4</CustomerId>
  <DiscountType>NoDiscount</DiscountType>
  <DiscountValue>7</DiscountValue>
  <DocumentDate>2026-04-17T20:37:52.2697308+05:30</DocumentDate>
  <DocumentId>1</DocumentId>
  <DocumentNumber>sample string 2</DocumentNumber>
  <DocumentType>Quotation</DocumentType>
  <DueDate>2026-04-17T20:37:52.2697308+05:30</DueDate>
  <GrandTotal>9</GrandTotal>
  <OtherCharges>
    <DocumentBase.OtherCharge>
      <Amount>3</Amount>
      <ChargeId>1</ChargeId>
      <ChargeName>sample string 2</ChargeName>
    </DocumentBase.OtherCharge>
    <DocumentBase.OtherCharge>
      <Amount>3</Amount>
      <ChargeId>1</ChargeId>
      <ChargeName>sample string 2</ChargeName>
    </DocumentBase.OtherCharge>
  </OtherCharges>
  <Payment>
    <Amount>2</Amount>
    <PaidDate>2026-04-17T20:37:52.2697308+05:30</PaidDate>
    <PaymentId>1</PaymentId>
    <PaymentMethod>sample string 3</PaymentMethod>
    <TransactionId>sample string 4</TransactionId>
  </Payment>
  <Products>
    <DocumentBase.DocumentProduct>
      <DocumentProductId>1</DocumentProductId>
      <GSTRate>8</GSTRate>
      <HSNCode>sample string 7</HSNCode>
      <Price>5</Price>
      <ProductId>2</ProductId>
      <ProductName>sample string 3</ProductName>
      <Quantity>4</Quantity>
      <Total>6</Total>
    </DocumentBase.DocumentProduct>
    <DocumentBase.DocumentProduct>
      <DocumentProductId>1</DocumentProductId>
      <GSTRate>8</GSTRate>
      <HSNCode>sample string 7</HSNCode>
      <Price>5</Price>
      <ProductId>2</ProductId>
      <ProductName>sample string 3</ProductName>
      <Quantity>4</Quantity>
      <Total>6</Total>
    </DocumentBase.DocumentProduct>
  </Products>
  <Status>Draft</Status>
  <SubTotal>6</SubTotal>
  <TaxRate>8</TaxRate>
  <TaxType>NoTax</TaxType>
  <TermsConditions>sample string 12</TermsConditions>
  <TopMessage>sample string 10</TopMessage>
  <UpdatedAt>2026-04-17T20:37:52.2697308+05:30</UpdatedAt>
  <UserId>3</UserId>
</ProformaInvoice>

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.