POST api/ReturnSale/GetByID

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
ID		integer	Required
RequestedUserID		integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "RequestedUserID": 1
}

application/xml, text/xml

Sample:

<RequestIDModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.Request">
  <RequestedUserID>1</RequestedUserID>
  <ID>1</ID>
</RequestIDModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ReturnSaleResponse

Name	Type	Additional information
ReturnSale	ReturnSaleModel	None.
ResponseCode	integer	None.
ResponseText	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ReturnSale": {
    "ID": 1,
    "CustomerID": 1,
    "Customer": "sample string 2",
    "PaymentMode": "sample string 3",
    "PaymentModeID": 1,
    "dDiscountPercentage": 1.0,
    "dDiscountValue": 1.0,
    "dTotalSaleValue": 1.0,
    "dTotalSaleValueString": "sample string 4",
    "SaleDate": "2025-01-22T21:00:03.642828-06:00",
    "SaleDateString": "sample string 5",
    "sRemarks": "sample string 6",
    "CreatedAt": "2025-01-22T21:00:03.642828-06:00",
    "CreatedAtString": "sample string 7",
    "OriginalSaleID": 1,
    "SaleReturnTypeID": 1,
    "UpdatedAt": "2025-01-22T21:00:03.642828-06:00",
    "CreatedByUserID": 1,
    "dtDate": "2025-01-22T21:00:03.642828-06:00",
    "OrderType": "sample string 8",
    "IsOnlineOrder": true,
    "ReturnSaleDetails": [
      {
        "ID": 1,
        "ReturnSaleID": 1,
        "ProductID": 1,
        "ProductVariantID": 1,
        "Product": "sample string 2",
        "ProductVariant": "sample string 3",
        "Quantity": 1,
        "dTotalValue": 1.0,
        "dTotalValueString": "sample string 4",
        "TaxAmount": 1.0,
        "TaxAmountString": "sample string 5",
        "dTotalDiscount": 1.0,
        "dTotalDiscountString": "sample string 6",
        "GrandTotal": 1.0,
        "GrandTotalString": "sample string 7",
        "SaleDetailID": 1,
        "BLabel": "sample string 8",
        "ProductImage": "sample string 9",
        "TaxPer": 1.0,
        "dTotalUnitValue": 1.0,
        "dTotalUnitValueString": "sample string 10",
        "dDiscountPer": 1.0,
        "ReturnTrackableProductsSaleDetails": [
          {
            "ID": 1,
            "ProductID": 1,
            "ProductVariantID": 1,
            "Product": "sample string 2",
            "ProductVariant": "sample string 3",
            "ReturnSaleDetailID": 1,
            "TrackableCode": "sample string 4",
            "CreatedAt": "2025-01-22T21:00:03.642828-06:00"
          },
          {
            "ID": 1,
            "ProductID": 1,
            "ProductVariantID": 1,
            "Product": "sample string 2",
            "ProductVariant": "sample string 3",
            "ReturnSaleDetailID": 1,
            "TrackableCode": "sample string 4",
            "CreatedAt": "2025-01-22T21:00:03.642828-06:00"
          }
        ],
        "IsTrackableVisibility": "sample string 11"
      },
      {
        "ID": 1,
        "ReturnSaleID": 1,
        "ProductID": 1,
        "ProductVariantID": 1,
        "Product": "sample string 2",
        "ProductVariant": "sample string 3",
        "Quantity": 1,
        "dTotalValue": 1.0,
        "dTotalValueString": "sample string 4",
        "TaxAmount": 1.0,
        "TaxAmountString": "sample string 5",
        "dTotalDiscount": 1.0,
        "dTotalDiscountString": "sample string 6",
        "GrandTotal": 1.0,
        "GrandTotalString": "sample string 7",
        "SaleDetailID": 1,
        "BLabel": "sample string 8",
        "ProductImage": "sample string 9",
        "TaxPer": 1.0,
        "dTotalUnitValue": 1.0,
        "dTotalUnitValueString": "sample string 10",
        "dDiscountPer": 1.0,
        "ReturnTrackableProductsSaleDetails": [
          {
            "ID": 1,
            "ProductID": 1,
            "ProductVariantID": 1,
            "Product": "sample string 2",
            "ProductVariant": "sample string 3",
            "ReturnSaleDetailID": 1,
            "TrackableCode": "sample string 4",
            "CreatedAt": "2025-01-22T21:00:03.642828-06:00"
          },
          {
            "ID": 1,
            "ProductID": 1,
            "ProductVariantID": 1,
            "Product": "sample string 2",
            "ProductVariant": "sample string 3",
            "ReturnSaleDetailID": 1,
            "TrackableCode": "sample string 4",
            "CreatedAt": "2025-01-22T21:00:03.642828-06:00"
          }
        ],
        "IsTrackableVisibility": "sample string 11"
      }
    ],
    "ReturnSaleInvoices": [
      {
        "ID": 1,
        "ReturnSaleID": 1,
        "sRemarks": "sample string 2",
        "InvoiceDate": "2025-01-22T21:00:03.642828-06:00",
        "CreatedAt": "2025-01-22T21:00:03.642828-06:00",
        "UpdatedAt": "2025-01-22T21:00:03.642828-06:00",
        "CreatedByUserID": 1,
        "OldSaleInvoiceID": 1
      },
      {
        "ID": 1,
        "ReturnSaleID": 1,
        "sRemarks": "sample string 2",
        "InvoiceDate": "2025-01-22T21:00:03.642828-06:00",
        "CreatedAt": "2025-01-22T21:00:03.642828-06:00",
        "UpdatedAt": "2025-01-22T21:00:03.642828-06:00",
        "CreatedByUserID": 1,
        "OldSaleInvoiceID": 1
      }
    ]
  },
  "ResponseCode": 1,
  "ResponseText": "sample string 2"
}

application/xml, text/xml

Sample:

<ReturnSaleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.Response">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">1</ResponseCode>
  <ResponseText xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">sample string 2</ResponseText>
  <ReturnSale xmlns:d2p1="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">
    <d2p1:CreatedAt>2025-01-22T21:00:03.642828-06:00</d2p1:CreatedAt>
    <d2p1:CreatedAtString>sample string 7</d2p1:CreatedAtString>
    <d2p1:CreatedByUserID>1</d2p1:CreatedByUserID>
    <d2p1:Customer>sample string 2</d2p1:Customer>
    <d2p1:CustomerID>1</d2p1:CustomerID>
    <d2p1:ID>1</d2p1:ID>
    <d2p1:IsOnlineOrder>true</d2p1:IsOnlineOrder>
    <d2p1:OrderType>sample string 8</d2p1:OrderType>
    <d2p1:OriginalSaleID>1</d2p1:OriginalSaleID>
    <d2p1:PaymentMode>sample string 3</d2p1:PaymentMode>
    <d2p1:PaymentModeID>1</d2p1:PaymentModeID>
    <d2p1:ReturnSaleDetails>
      <d2p1:ReturnSaleDetailModel>
        <d2p1:BLabel>sample string 8</d2p1:BLabel>
        <d2p1:GrandTotal>1</d2p1:GrandTotal>
        <d2p1:GrandTotalString>sample string 7</d2p1:GrandTotalString>
        <d2p1:ID>1</d2p1:ID>
        <d2p1:IsTrackableVisibility>sample string 11</d2p1:IsTrackableVisibility>
        <d2p1:Product>sample string 2</d2p1:Product>
        <d2p1:ProductID>1</d2p1:ProductID>
        <d2p1:ProductImage>sample string 9</d2p1:ProductImage>
        <d2p1:ProductVariant>sample string 3</d2p1:ProductVariant>
        <d2p1:ProductVariantID>1</d2p1:ProductVariantID>
        <d2p1:Quantity>1</d2p1:Quantity>
        <d2p1:ReturnSaleID>1</d2p1:ReturnSaleID>
        <d2p1:ReturnTrackableProductsSaleDetails>
          <d2p1:ReturnTrackableProductsSaleDetailModel>
            <d2p1:CreatedAt>2025-01-22T21:00:03.642828-06:00</d2p1:CreatedAt>
            <d2p1:ID>1</d2p1:ID>
            <d2p1:Product>sample string 2</d2p1:Product>
            <d2p1:ProductID>1</d2p1:ProductID>
            <d2p1:ProductVariant>sample string 3</d2p1:ProductVariant>
            <d2p1:ProductVariantID>1</d2p1:ProductVariantID>
            <d2p1:ReturnSaleDetailID>1</d2p1:ReturnSaleDetailID>
            <d2p1:TrackableCode>sample string 4</d2p1:TrackableCode>
          </d2p1:ReturnTrackableProductsSaleDetailModel>
          <d2p1:ReturnTrackableProductsSaleDetailModel>
            <d2p1:CreatedAt>2025-01-22T21:00:03.642828-06:00</d2p1:CreatedAt>
            <d2p1:ID>1</d2p1:ID>
            <d2p1:Product>sample string 2</d2p1:Product>
            <d2p1:ProductID>1</d2p1:ProductID>
            <d2p1:ProductVariant>sample string 3</d2p1:ProductVariant>
            <d2p1:ProductVariantID>1</d2p1:ProductVariantID>
            <d2p1:ReturnSaleDetailID>1</d2p1:ReturnSaleDetailID>
            <d2p1:TrackableCode>sample string 4</d2p1:TrackableCode>
          </d2p1:ReturnTrackableProductsSaleDetailModel>
        </d2p1:ReturnTrackableProductsSaleDetails>
        <d2p1:SaleDetailID>1</d2p1:SaleDetailID>
        <d2p1:TaxAmount>1</d2p1:TaxAmount>
        <d2p1:TaxAmountString>sample string 5</d2p1:TaxAmountString>
        <d2p1:TaxPer>1</d2p1:TaxPer>
        <d2p1:dDiscountPer>1</d2p1:dDiscountPer>
        <d2p1:dTotalDiscount>1</d2p1:dTotalDiscount>
        <d2p1:dTotalDiscountString>sample string 6</d2p1:dTotalDiscountString>
        <d2p1:dTotalUnitValue>1</d2p1:dTotalUnitValue>
        <d2p1:dTotalUnitValueString>sample string 10</d2p1:dTotalUnitValueString>
        <d2p1:dTotalValue>1</d2p1:dTotalValue>
        <d2p1:dTotalValueString>sample string 4</d2p1:dTotalValueString>
      </d2p1:ReturnSaleDetailModel>
      <d2p1:ReturnSaleDetailModel>
        <d2p1:BLabel>sample string 8</d2p1:BLabel>
        <d2p1:GrandTotal>1</d2p1:GrandTotal>
        <d2p1:GrandTotalString>sample string 7</d2p1:GrandTotalString>
        <d2p1:ID>1</d2p1:ID>
        <d2p1:IsTrackableVisibility>sample string 11</d2p1:IsTrackableVisibility>
        <d2p1:Product>sample string 2</d2p1:Product>
        <d2p1:ProductID>1</d2p1:ProductID>
        <d2p1:ProductImage>sample string 9</d2p1:ProductImage>
        <d2p1:ProductVariant>sample string 3</d2p1:ProductVariant>
        <d2p1:ProductVariantID>1</d2p1:ProductVariantID>
        <d2p1:Quantity>1</d2p1:Quantity>
        <d2p1:ReturnSaleID>1</d2p1:ReturnSaleID>
        <d2p1:ReturnTrackableProductsSaleDetails>
          <d2p1:ReturnTrackableProductsSaleDetailModel>
            <d2p1:CreatedAt>2025-01-22T21:00:03.642828-06:00</d2p1:CreatedAt>
            <d2p1:ID>1</d2p1:ID>
            <d2p1:Product>sample string 2</d2p1:Product>
            <d2p1:ProductID>1</d2p1:ProductID>
            <d2p1:ProductVariant>sample string 3</d2p1:ProductVariant>
            <d2p1:ProductVariantID>1</d2p1:ProductVariantID>
            <d2p1:ReturnSaleDetailID>1</d2p1:ReturnSaleDetailID>
            <d2p1:TrackableCode>sample string 4</d2p1:TrackableCode>
          </d2p1:ReturnTrackableProductsSaleDetailModel>
          <d2p1:ReturnTrackableProductsSaleDetailModel>
            <d2p1:CreatedAt>2025-01-22T21:00:03.642828-06:00</d2p1:CreatedAt>
            <d2p1:ID>1</d2p1:ID>
            <d2p1:Product>sample string 2</d2p1:Product>
            <d2p1:ProductID>1</d2p1:ProductID>
            <d2p1:ProductVariant>sample string 3</d2p1:ProductVariant>
            <d2p1:ProductVariantID>1</d2p1:ProductVariantID>
            <d2p1:ReturnSaleDetailID>1</d2p1:ReturnSaleDetailID>
            <d2p1:TrackableCode>sample string 4</d2p1:TrackableCode>
          </d2p1:ReturnTrackableProductsSaleDetailModel>
        </d2p1:ReturnTrackableProductsSaleDetails>
        <d2p1:SaleDetailID>1</d2p1:SaleDetailID>
        <d2p1:TaxAmount>1</d2p1:TaxAmount>
        <d2p1:TaxAmountString>sample string 5</d2p1:TaxAmountString>
        <d2p1:TaxPer>1</d2p1:TaxPer>
        <d2p1:dDiscountPer>1</d2p1:dDiscountPer>
        <d2p1:dTotalDiscount>1</d2p1:dTotalDiscount>
        <d2p1:dTotalDiscountString>sample string 6</d2p1:dTotalDiscountString>
        <d2p1:dTotalUnitValue>1</d2p1:dTotalUnitValue>
        <d2p1:dTotalUnitValueString>sample string 10</d2p1:dTotalUnitValueString>
        <d2p1:dTotalValue>1</d2p1:dTotalValue>
        <d2p1:dTotalValueString>sample string 4</d2p1:dTotalValueString>
      </d2p1:ReturnSaleDetailModel>
    </d2p1:ReturnSaleDetails>
    <d2p1:ReturnSaleInvoices>
      <d2p1:ReturnSaleInvoiceModel>
        <d2p1:CreatedAt>2025-01-22T21:00:03.642828-06:00</d2p1:CreatedAt>
        <d2p1:CreatedByUserID>1</d2p1:CreatedByUserID>
        <d2p1:ID>1</d2p1:ID>
        <d2p1:InvoiceDate>2025-01-22T21:00:03.642828-06:00</d2p1:InvoiceDate>
        <d2p1:OldSaleInvoiceID>1</d2p1:OldSaleInvoiceID>
        <d2p1:ReturnSaleID>1</d2p1:ReturnSaleID>
        <d2p1:UpdatedAt>2025-01-22T21:00:03.642828-06:00</d2p1:UpdatedAt>
        <d2p1:sRemarks>sample string 2</d2p1:sRemarks>
      </d2p1:ReturnSaleInvoiceModel>
      <d2p1:ReturnSaleInvoiceModel>
        <d2p1:CreatedAt>2025-01-22T21:00:03.642828-06:00</d2p1:CreatedAt>
        <d2p1:CreatedByUserID>1</d2p1:CreatedByUserID>
        <d2p1:ID>1</d2p1:ID>
        <d2p1:InvoiceDate>2025-01-22T21:00:03.642828-06:00</d2p1:InvoiceDate>
        <d2p1:OldSaleInvoiceID>1</d2p1:OldSaleInvoiceID>
        <d2p1:ReturnSaleID>1</d2p1:ReturnSaleID>
        <d2p1:UpdatedAt>2025-01-22T21:00:03.642828-06:00</d2p1:UpdatedAt>
        <d2p1:sRemarks>sample string 2</d2p1:sRemarks>
      </d2p1:ReturnSaleInvoiceModel>
    </d2p1:ReturnSaleInvoices>
    <d2p1:SaleDate>2025-01-22T21:00:03.642828-06:00</d2p1:SaleDate>
    <d2p1:SaleDateString>sample string 5</d2p1:SaleDateString>
    <d2p1:SaleReturnTypeID>1</d2p1:SaleReturnTypeID>
    <d2p1:UpdatedAt>2025-01-22T21:00:03.642828-06:00</d2p1:UpdatedAt>
    <d2p1:dDiscountPercentage>1</d2p1:dDiscountPercentage>
    <d2p1:dDiscountValue>1</d2p1:dDiscountValue>
    <d2p1:dTotalSaleValue>1</d2p1:dTotalSaleValue>
    <d2p1:dTotalSaleValueString>sample string 4</d2p1:dTotalSaleValueString>
    <d2p1:dtDate>2025-01-22T21:00:03.642828-06:00</d2p1:dtDate>
    <d2p1:sRemarks>sample string 6</d2p1:sRemarks>
  </ReturnSale>
</ReturnSaleResponse>