POST api/PurchaseReturns

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
DocEntry	integer	None.
DocNum	integer	None.
Series	integer	None.
CardCode	string	None.
CardName	string	None.
Comments	string	None.
DocDate	date	None.
DocDueDate	date	None.
TaxDate	date	None.
DocCurrency	string	None.
SalesPersonCode	integer	None.
DocumentLines	Collection of GoodsReturnRows	None.
Udfs	Collection of Udf	None.
DocTotal	decimal number	None.
DocObjectCode	string	None.
ConfirmationEntry	integer	None.
PriceList	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "DocEntry": 1,
  "DocNum": 2,
  "Series": 3,
  "CardCode": "sample string 4",
  "CardName": "sample string 5",
  "Comments": "sample string 6",
  "DocDate": "2025-10-27T08:28:11.402669-06:00",
  "DocDueDate": "2025-10-27T08:28:11.402669-06:00",
  "TaxDate": "2025-10-27T08:28:11.402669-06:00",
  "DocCurrency": "sample string 10",
  "SalesPersonCode": 11,
  "DocumentLines": [
    {
      "ItemCode": "sample string 1",
      "ItemDescription": "sample string 2",
      "UnitPrice": 3.0,
      "Quantity": 4.0,
      "DiscountPercent": 5.0,
      "WarehouseCode": "sample string 6",
      "TaxCode": "sample string 7",
      "TaxOnly": "sample string 8",
      "UoMEntry": 9,
      "Currency": "sample string 10",
      "Udfs": [
        {
          "Name": "sample string 1",
          "FieldType": "sample string 2",
          "Value": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "FieldType": "sample string 2",
          "Value": "sample string 3"
        }
      ],
      "BaseType": 11,
      "BaseEntry": 1,
      "UoMMasterData": [
        {
          "UoMEntry": 1,
          "UomCode": "sample string 2",
          "UomName": "sample string 3",
          "UnitPrice": 4.0,
          "UnitPriceFC": 5.0
        },
        {
          "UoMEntry": 1,
          "UomCode": "sample string 2",
          "UomName": "sample string 3",
          "UnitPrice": 4.0,
          "UnitPriceFC": 5.0
        }
      ],
      "WhsName": "sample string 12",
      "TaxRate": 13.0,
      "CostingCode": "sample string 14",
      "CostingCode2": "sample string 15"
    },
    {
      "ItemCode": "sample string 1",
      "ItemDescription": "sample string 2",
      "UnitPrice": 3.0,
      "Quantity": 4.0,
      "DiscountPercent": 5.0,
      "WarehouseCode": "sample string 6",
      "TaxCode": "sample string 7",
      "TaxOnly": "sample string 8",
      "UoMEntry": 9,
      "Currency": "sample string 10",
      "Udfs": [
        {
          "Name": "sample string 1",
          "FieldType": "sample string 2",
          "Value": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "FieldType": "sample string 2",
          "Value": "sample string 3"
        }
      ],
      "BaseType": 11,
      "BaseEntry": 1,
      "UoMMasterData": [
        {
          "UoMEntry": 1,
          "UomCode": "sample string 2",
          "UomName": "sample string 3",
          "UnitPrice": 4.0,
          "UnitPriceFC": 5.0
        },
        {
          "UoMEntry": 1,
          "UomCode": "sample string 2",
          "UomName": "sample string 3",
          "UnitPrice": 4.0,
          "UnitPriceFC": 5.0
        }
      ],
      "WhsName": "sample string 12",
      "TaxRate": 13.0,
      "CostingCode": "sample string 14",
      "CostingCode2": "sample string 15"
    }
  ],
  "Udfs": [
    {
      "Name": "sample string 1",
      "FieldType": "sample string 2",
      "Value": "sample string 3"
    },
    {
      "Name": "sample string 1",
      "FieldType": "sample string 2",
      "Value": "sample string 3"
    }
  ],
  "DocTotal": 12.0,
  "DocObjectCode": "sample string 13",
  "ConfirmationEntry": 14,
  "PriceList": 15
}

application/xml, text/xml

Sample:

<GoodsReturn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CLMLTEMA.MODELS.SAP">
  <CardCode>sample string 4</CardCode>
  <CardName>sample string 5</CardName>
  <Comments>sample string 6</Comments>
  <ConfirmationEntry>14</ConfirmationEntry>
  <DocCurrency>sample string 10</DocCurrency>
  <DocDate>2025-10-27T08:28:11.402669-06:00</DocDate>
  <DocDueDate>2025-10-27T08:28:11.402669-06:00</DocDueDate>
  <DocEntry>1</DocEntry>
  <DocNum>2</DocNum>
  <DocObjectCode>sample string 13</DocObjectCode>
  <DocTotal>12</DocTotal>
  <DocumentLines>
    <GoodsReturnRows>
      <BaseEntry>1</BaseEntry>
      <BaseType>11</BaseType>
      <CostingCode>sample string 14</CostingCode>
      <CostingCode2>sample string 15</CostingCode2>
      <Currency>sample string 10</Currency>
      <DiscountPercent>5</DiscountPercent>
      <ItemCode>sample string 1</ItemCode>
      <ItemDescription>sample string 2</ItemDescription>
      <Quantity>4</Quantity>
      <TaxCode>sample string 7</TaxCode>
      <TaxOnly>sample string 8</TaxOnly>
      <TaxRate>13</TaxRate>
      <Udfs xmlns:d4p1="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.Udf">
        <d4p1:Udf>
          <d4p1:FieldType>sample string 2</d4p1:FieldType>
          <d4p1:Name>sample string 1</d4p1:Name>
          <d4p1:Value>sample string 3</d4p1:Value>
        </d4p1:Udf>
        <d4p1:Udf>
          <d4p1:FieldType>sample string 2</d4p1:FieldType>
          <d4p1:Name>sample string 1</d4p1:Name>
          <d4p1:Value>sample string 3</d4p1:Value>
        </d4p1:Udf>
      </Udfs>
      <UnitPrice>3</UnitPrice>
      <UoMEntry>9</UoMEntry>
      <UoMMasterData>
        <UoMMasterData>
          <UnitPrice>4</UnitPrice>
          <UnitPriceFC>5</UnitPriceFC>
          <UoMEntry>1</UoMEntry>
          <UomCode>sample string 2</UomCode>
          <UomName>sample string 3</UomName>
        </UoMMasterData>
        <UoMMasterData>
          <UnitPrice>4</UnitPrice>
          <UnitPriceFC>5</UnitPriceFC>
          <UoMEntry>1</UoMEntry>
          <UomCode>sample string 2</UomCode>
          <UomName>sample string 3</UomName>
        </UoMMasterData>
      </UoMMasterData>
      <WarehouseCode>sample string 6</WarehouseCode>
      <WhsName>sample string 12</WhsName>
    </GoodsReturnRows>
    <GoodsReturnRows>
      <BaseEntry>1</BaseEntry>
      <BaseType>11</BaseType>
      <CostingCode>sample string 14</CostingCode>
      <CostingCode2>sample string 15</CostingCode2>
      <Currency>sample string 10</Currency>
      <DiscountPercent>5</DiscountPercent>
      <ItemCode>sample string 1</ItemCode>
      <ItemDescription>sample string 2</ItemDescription>
      <Quantity>4</Quantity>
      <TaxCode>sample string 7</TaxCode>
      <TaxOnly>sample string 8</TaxOnly>
      <TaxRate>13</TaxRate>
      <Udfs xmlns:d4p1="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.Udf">
        <d4p1:Udf>
          <d4p1:FieldType>sample string 2</d4p1:FieldType>
          <d4p1:Name>sample string 1</d4p1:Name>
          <d4p1:Value>sample string 3</d4p1:Value>
        </d4p1:Udf>
        <d4p1:Udf>
          <d4p1:FieldType>sample string 2</d4p1:FieldType>
          <d4p1:Name>sample string 1</d4p1:Name>
          <d4p1:Value>sample string 3</d4p1:Value>
        </d4p1:Udf>
      </Udfs>
      <UnitPrice>3</UnitPrice>
      <UoMEntry>9</UoMEntry>
      <UoMMasterData>
        <UoMMasterData>
          <UnitPrice>4</UnitPrice>
          <UnitPriceFC>5</UnitPriceFC>
          <UoMEntry>1</UoMEntry>
          <UomCode>sample string 2</UomCode>
          <UomName>sample string 3</UomName>
        </UoMMasterData>
        <UoMMasterData>
          <UnitPrice>4</UnitPrice>
          <UnitPriceFC>5</UnitPriceFC>
          <UoMEntry>1</UoMEntry>
          <UomCode>sample string 2</UomCode>
          <UomName>sample string 3</UomName>
        </UoMMasterData>
      </UoMMasterData>
      <WarehouseCode>sample string 6</WarehouseCode>
      <WhsName>sample string 12</WhsName>
    </GoodsReturnRows>
  </DocumentLines>
  <PriceList>15</PriceList>
  <SalesPersonCode>11</SalesPersonCode>
  <Series>3</Series>
  <TaxDate>2025-10-27T08:28:11.402669-06:00</TaxDate>
  <Udfs xmlns:d2p1="http://schemas.datacontract.org/2004/07/CL.STRUCTURES.CLASSES.Udf">
    <d2p1:Udf>
      <d2p1:FieldType>sample string 2</d2p1:FieldType>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:Udf>
    <d2p1:Udf>
      <d2p1:FieldType>sample string 2</d2p1:FieldType>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:Udf>
  </Udfs>
</GoodsReturn>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.