POST api/PurchaseReturn

Request Information

URI Parameters

None.

Body Parameters

Z_PurchaseReturnRequest
NameDescriptionTypeAdditional information
purchaseReturnHeader

P_PurchaseReturnHeader

None.
purchaseReturnLine

Collection of P_PurchaseReturnLine

None.
inventBatchTransDetail

Collection of C_InventBatchTransDetail

None.
inventBatchTrans

Collection of C_InventBatchTrans

None.

Request Formats

application/json, text/json

Sample: 
{
  "purchaseReturnHeader": {
    "Id": 1,
    "PRId": "sample string 2",
    "PRDate": "2025-12-15T23:49:45.9217864+00:00",
    "SupplierCode": "sample string 3",
    "InvoiceNo": "sample string 4",
    "Transporter": "sample string 5",
    "Remarks": "sample string 6",
    "DebitNoteNo": "sample string 7",
    "BranchCode": 8,
    "CreatedBy": 9,
    "CreatedOn": "2025-12-15T23:49:45.9217864+00:00",
    "ItemTypeFlag": "sample string 10"
  },
  "purchaseReturnLine": [
    {
      "Id": 1,
      "LineNumber": 1,
      "PRId": "sample string 2",
      "ItemCode": "sample string 3",
      "Unit": 1,
      "Rate": 1.0,
      "ReturnQty": 1.0,
      "TaxCode": "sample string 4",
      "BatchNo": "sample string 5",
      "SupplierCode": "sample string 6",
      "BranchCode": 7,
      "CreatedBy": 1,
      "CreatedOn": "2025-12-15T23:49:45.9217864+00:00",
      "GRNNo": "sample string 8"
    },
    {
      "Id": 1,
      "LineNumber": 1,
      "PRId": "sample string 2",
      "ItemCode": "sample string 3",
      "Unit": 1,
      "Rate": 1.0,
      "ReturnQty": 1.0,
      "TaxCode": "sample string 4",
      "BatchNo": "sample string 5",
      "SupplierCode": "sample string 6",
      "BranchCode": 7,
      "CreatedBy": 1,
      "CreatedOn": "2025-12-15T23:49:45.9217864+00:00",
      "GRNNo": "sample string 8"
    }
  ],
  "inventBatchTransDetail": [
    {
      "Id": 1,
      "TransId": "sample string 2",
      "ItemCode": "sample string 3",
      "BatchNo": "sample string 4",
      "Qty": 1.0,
      "Barcode": "sample string 5",
      "OuterNo": "sample string 6",
      "PalletNo": "sample string 7",
      "UnitId": 1,
      "BarcodeCreatedDate": "2025-12-15T23:49:45.9217864+00:00",
      "OuterCreatedDate": "2025-12-15T23:49:45.9217864+00:00",
      "PalletCreatedDate": "2025-12-15T23:49:45.9217864+00:00",
      "SOID": "sample string 9",
      "InvoiceNo": "sample string 10",
      "PackingSlipId": "sample string 11",
      "BarcodePrint": "sample string 12",
      "OuterPrint": "sample string 13",
      "PalletPrint": "sample string 14",
      "TransDate": "2025-12-15T23:49:45.9217864+00:00",
      "BranchCode": 15,
      "VoucherNo": "sample string 16",
      "InventBatchId": 17,
      "SupplierGRNNo": "sample string 18",
      "UpdatedByIT": "sample string 19"
    },
    {
      "Id": 1,
      "TransId": "sample string 2",
      "ItemCode": "sample string 3",
      "BatchNo": "sample string 4",
      "Qty": 1.0,
      "Barcode": "sample string 5",
      "OuterNo": "sample string 6",
      "PalletNo": "sample string 7",
      "UnitId": 1,
      "BarcodeCreatedDate": "2025-12-15T23:49:45.9217864+00:00",
      "OuterCreatedDate": "2025-12-15T23:49:45.9217864+00:00",
      "PalletCreatedDate": "2025-12-15T23:49:45.9217864+00:00",
      "SOID": "sample string 9",
      "InvoiceNo": "sample string 10",
      "PackingSlipId": "sample string 11",
      "BarcodePrint": "sample string 12",
      "OuterPrint": "sample string 13",
      "PalletPrint": "sample string 14",
      "TransDate": "2025-12-15T23:49:45.9217864+00:00",
      "BranchCode": 15,
      "VoucherNo": "sample string 16",
      "InventBatchId": 17,
      "SupplierGRNNo": "sample string 18",
      "UpdatedByIT": "sample string 19"
    }
  ],
  "inventBatchTrans": [
    {
      "Id": 1,
      "TransId": "sample string 2",
      "ItemCode": "sample string 3",
      "VoucherNo": "sample string 4",
      "TransType": "sample string 5",
      "BatchNo": "sample string 6",
      "BatchOpeningQty": 1.0,
      "BatchTransQty": 1.0,
      "BatchClosingQty": 1.0,
      "TransDate": "2025-12-15T23:49:45.9217864+00:00",
      "WarehouseId": 7,
      "SupplierCode": "sample string 8",
      "STSupplierCode": "sample string 9",
      "FinalStockFlag": "sample string 10",
      "ActualRate": 1.0,
      "ExciseRate": 1.0,
      "CostRate": 1.0,
      "TotalRate": 11.0,
      "PostTransId": "sample string 12",
      "BranchCode": 13,
      "PurchaseDate": "2025-12-15T23:49:45.9217864+00:00",
      "UpdatedByIT": "sample string 14"
    },
    {
      "Id": 1,
      "TransId": "sample string 2",
      "ItemCode": "sample string 3",
      "VoucherNo": "sample string 4",
      "TransType": "sample string 5",
      "BatchNo": "sample string 6",
      "BatchOpeningQty": 1.0,
      "BatchTransQty": 1.0,
      "BatchClosingQty": 1.0,
      "TransDate": "2025-12-15T23:49:45.9217864+00:00",
      "WarehouseId": 7,
      "SupplierCode": "sample string 8",
      "STSupplierCode": "sample string 9",
      "FinalStockFlag": "sample string 10",
      "ActualRate": 1.0,
      "ExciseRate": 1.0,
      "CostRate": 1.0,
      "TotalRate": 11.0,
      "PostTransId": "sample string 12",
      "BranchCode": 13,
      "PurchaseDate": "2025-12-15T23:49:45.9217864+00:00",
      "UpdatedByIT": "sample string 14"
    }
  ]
}

application/xml, text/xml

Sample: 
<Z_PurchaseReturnRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RREL.Data.Models">
  <inventBatchTrans>
    <C_InventBatchTrans>
      <ActualRate>1</ActualRate>
      <BatchClosingQty>1</BatchClosingQty>
      <BatchNo>sample string 6</BatchNo>
      <BatchOpeningQty>1</BatchOpeningQty>
      <BatchTransQty>1</BatchTransQty>
      <BranchCode>13</BranchCode>
      <CostRate>1</CostRate>
      <ExciseRate>1</ExciseRate>
      <FinalStockFlag>sample string 10</FinalStockFlag>
      <Id>1</Id>
      <ItemCode>sample string 3</ItemCode>
      <PostTransId>sample string 12</PostTransId>
      <PurchaseDate>2025-12-15T23:49:45.9217864+00:00</PurchaseDate>
      <STSupplierCode>sample string 9</STSupplierCode>
      <SupplierCode>sample string 8</SupplierCode>
      <TotalRate>11</TotalRate>
      <TransDate>2025-12-15T23:49:45.9217864+00:00</TransDate>
      <TransId>sample string 2</TransId>
      <TransType>sample string 5</TransType>
      <UpdatedByIT>sample string 14</UpdatedByIT>
      <VoucherNo>sample string 4</VoucherNo>
      <WarehouseId>7</WarehouseId>
    </C_InventBatchTrans>
    <C_InventBatchTrans>
      <ActualRate>1</ActualRate>
      <BatchClosingQty>1</BatchClosingQty>
      <BatchNo>sample string 6</BatchNo>
      <BatchOpeningQty>1</BatchOpeningQty>
      <BatchTransQty>1</BatchTransQty>
      <BranchCode>13</BranchCode>
      <CostRate>1</CostRate>
      <ExciseRate>1</ExciseRate>
      <FinalStockFlag>sample string 10</FinalStockFlag>
      <Id>1</Id>
      <ItemCode>sample string 3</ItemCode>
      <PostTransId>sample string 12</PostTransId>
      <PurchaseDate>2025-12-15T23:49:45.9217864+00:00</PurchaseDate>
      <STSupplierCode>sample string 9</STSupplierCode>
      <SupplierCode>sample string 8</SupplierCode>
      <TotalRate>11</TotalRate>
      <TransDate>2025-12-15T23:49:45.9217864+00:00</TransDate>
      <TransId>sample string 2</TransId>
      <TransType>sample string 5</TransType>
      <UpdatedByIT>sample string 14</UpdatedByIT>
      <VoucherNo>sample string 4</VoucherNo>
      <WarehouseId>7</WarehouseId>
    </C_InventBatchTrans>
  </inventBatchTrans>
  <inventBatchTransDetail>
    <C_InventBatchTransDetail>
      <Barcode>sample string 5</Barcode>
      <BarcodeCreatedDate>2025-12-15T23:49:45.9217864+00:00</BarcodeCreatedDate>
      <BarcodePrint>sample string 12</BarcodePrint>
      <BatchNo>sample string 4</BatchNo>
      <BranchCode>15</BranchCode>
      <Id>1</Id>
      <InventBatchId>17</InventBatchId>
      <InvoiceNo>sample string 10</InvoiceNo>
      <ItemCode>sample string 3</ItemCode>
      <OuterCreatedDate>2025-12-15T23:49:45.9217864+00:00</OuterCreatedDate>
      <OuterNo>sample string 6</OuterNo>
      <OuterPrint>sample string 13</OuterPrint>
      <PackingSlipId>sample string 11</PackingSlipId>
      <PalletCreatedDate>2025-12-15T23:49:45.9217864+00:00</PalletCreatedDate>
      <PalletNo>sample string 7</PalletNo>
      <PalletPrint>sample string 14</PalletPrint>
      <Qty>1</Qty>
      <SOID>sample string 9</SOID>
      <SupplierGRNNo>sample string 18</SupplierGRNNo>
      <TransDate>2025-12-15T23:49:45.9217864+00:00</TransDate>
      <TransId>sample string 2</TransId>
      <UnitId>1</UnitId>
      <UpdatedByIT>sample string 19</UpdatedByIT>
      <VoucherNo>sample string 16</VoucherNo>
    </C_InventBatchTransDetail>
    <C_InventBatchTransDetail>
      <Barcode>sample string 5</Barcode>
      <BarcodeCreatedDate>2025-12-15T23:49:45.9217864+00:00</BarcodeCreatedDate>
      <BarcodePrint>sample string 12</BarcodePrint>
      <BatchNo>sample string 4</BatchNo>
      <BranchCode>15</BranchCode>
      <Id>1</Id>
      <InventBatchId>17</InventBatchId>
      <InvoiceNo>sample string 10</InvoiceNo>
      <ItemCode>sample string 3</ItemCode>
      <OuterCreatedDate>2025-12-15T23:49:45.9217864+00:00</OuterCreatedDate>
      <OuterNo>sample string 6</OuterNo>
      <OuterPrint>sample string 13</OuterPrint>
      <PackingSlipId>sample string 11</PackingSlipId>
      <PalletCreatedDate>2025-12-15T23:49:45.9217864+00:00</PalletCreatedDate>
      <PalletNo>sample string 7</PalletNo>
      <PalletPrint>sample string 14</PalletPrint>
      <Qty>1</Qty>
      <SOID>sample string 9</SOID>
      <SupplierGRNNo>sample string 18</SupplierGRNNo>
      <TransDate>2025-12-15T23:49:45.9217864+00:00</TransDate>
      <TransId>sample string 2</TransId>
      <UnitId>1</UnitId>
      <UpdatedByIT>sample string 19</UpdatedByIT>
      <VoucherNo>sample string 16</VoucherNo>
    </C_InventBatchTransDetail>
  </inventBatchTransDetail>
  <purchaseReturnHeader>
    <BranchCode>8</BranchCode>
    <CreatedBy>9</CreatedBy>
    <CreatedOn>2025-12-15T23:49:45.9217864+00:00</CreatedOn>
    <DebitNoteNo>sample string 7</DebitNoteNo>
    <Id>1</Id>
    <InvoiceNo>sample string 4</InvoiceNo>
    <ItemTypeFlag>sample string 10</ItemTypeFlag>
    <PRDate>2025-12-15T23:49:45.9217864+00:00</PRDate>
    <PRId>sample string 2</PRId>
    <Remarks>sample string 6</Remarks>
    <SupplierCode>sample string 3</SupplierCode>
    <Transporter>sample string 5</Transporter>
  </purchaseReturnHeader>
  <purchaseReturnLine>
    <P_PurchaseReturnLine>
      <BatchNo>sample string 5</BatchNo>
      <BranchCode>7</BranchCode>
      <CreatedBy>1</CreatedBy>
      <CreatedOn>2025-12-15T23:49:45.9217864+00:00</CreatedOn>
      <GRNNo>sample string 8</GRNNo>
      <Id>1</Id>
      <ItemCode>sample string 3</ItemCode>
      <LineNumber>1</LineNumber>
      <PRId>sample string 2</PRId>
      <Rate>1</Rate>
      <ReturnQty>1</ReturnQty>
      <SupplierCode>sample string 6</SupplierCode>
      <TaxCode>sample string 4</TaxCode>
      <Unit>1</Unit>
    </P_PurchaseReturnLine>
    <P_PurchaseReturnLine>
      <BatchNo>sample string 5</BatchNo>
      <BranchCode>7</BranchCode>
      <CreatedBy>1</CreatedBy>
      <CreatedOn>2025-12-15T23:49:45.9217864+00:00</CreatedOn>
      <GRNNo>sample string 8</GRNNo>
      <Id>1</Id>
      <ItemCode>sample string 3</ItemCode>
      <LineNumber>1</LineNumber>
      <PRId>sample string 2</PRId>
      <Rate>1</Rate>
      <ReturnQty>1</ReturnQty>
      <SupplierCode>sample string 6</SupplierCode>
      <TaxCode>sample string 4</TaxCode>
      <Unit>1</Unit>
    </P_PurchaseReturnLine>
  </purchaseReturnLine>
</Z_PurchaseReturnRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Z_PurchaseReturnRequest'.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.
Content

HttpContent

None.
StatusCode

HttpStatusCode

None.
ReasonPhrase

string

None.
Headers

Collection of Object

None.
RequestMessage

HttpRequestMessage

None.
IsSuccessStatusCode

boolean

None.