PATCH api/PurchaseOrders
Request Information
URI Parameters
None.
Body Parameters
PurchaseOrder| Name | Description | Type | Additional information |
|---|---|---|---|
| DocEntry | integer |
None. |
|
| DocNum | integer |
None. |
|
| CardCode | string |
None. |
|
| PriceList | integer |
None. |
|
| CardName | string |
None. |
|
| DocDate | date |
None. |
|
| DocDueDate | date |
None. |
|
| TaxDate | date |
None. |
|
| Comments | string |
None. |
|
| DocTotal | decimal number |
None. |
|
| SalesPersonCode | integer |
None. |
|
| DocCurrency | string |
None. |
|
| DocumentLines | Collection of PurchaseOrderRows |
None. |
|
| Udfs | Collection of Udf |
None. |
|
| DocStatus | string |
None. |
|
| DocObjectCode | string |
None. |
|
| ConfirmationEntry | integer |
None. |
|
| AttachmentEntry | integer |
None. |
|
| WithholdingTaxDataCollection | Collection of WithholdingTaxCode |
None. |
Request Formats
application/json, text/json
Sample:
{
"DocEntry": 1,
"DocNum": 2,
"CardCode": "sample string 3",
"PriceList": 4,
"CardName": "sample string 5",
"DocDate": "2025-10-26T14:24:29.9100062-06:00",
"DocDueDate": "2025-10-26T14:24:29.9100062-06:00",
"TaxDate": "2025-10-26T14:24:29.9100062-06:00",
"Comments": "sample string 9",
"DocTotal": 10.0,
"SalesPersonCode": 11,
"DocCurrency": "sample string 12",
"DocumentLines": [
{
"ItemCode": "sample string 1",
"ItemDescription": "sample string 2",
"UnitPrice": 3.0,
"Quantity": 4.0,
"DiscountPercent": 5.0,
"WarehouseCode": "sample string 6",
"Currency": "sample string 7",
"TaxCode": "sample string 8",
"TaxOnly": "sample string 9",
"TaxRate": 10.0,
"UoMEntry": 11,
"BaseType": 12,
"BaseEntry": 1,
"BaseLine": 1,
"LineNum": 13,
"LineStatus": "sample string 14",
"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"
}
],
"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 15",
"VATLiable": 16
},
{
"ItemCode": "sample string 1",
"ItemDescription": "sample string 2",
"UnitPrice": 3.0,
"Quantity": 4.0,
"DiscountPercent": 5.0,
"WarehouseCode": "sample string 6",
"Currency": "sample string 7",
"TaxCode": "sample string 8",
"TaxOnly": "sample string 9",
"TaxRate": 10.0,
"UoMEntry": 11,
"BaseType": 12,
"BaseEntry": 1,
"BaseLine": 1,
"LineNum": 13,
"LineStatus": "sample string 14",
"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"
}
],
"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 15",
"VATLiable": 16
}
],
"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"
}
],
"DocStatus": "sample string 13",
"DocObjectCode": "sample string 14",
"ConfirmationEntry": 15,
"AttachmentEntry": 1,
"WithholdingTaxDataCollection": [
{
"WTCode": "sample string 1"
},
{
"WTCode": "sample string 1"
}
]
}
application/xml, text/xml
Sample:
<PurchaseOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CLMLTEMA.MODELS.SAP">
<AttachmentEntry>1</AttachmentEntry>
<CardCode>sample string 3</CardCode>
<CardName>sample string 5</CardName>
<Comments>sample string 9</Comments>
<ConfirmationEntry>15</ConfirmationEntry>
<DocCurrency>sample string 12</DocCurrency>
<DocDate>2025-10-26T14:24:29.9100062-06:00</DocDate>
<DocDueDate>2025-10-26T14:24:29.9100062-06:00</DocDueDate>
<DocEntry>1</DocEntry>
<DocNum>2</DocNum>
<DocObjectCode>sample string 14</DocObjectCode>
<DocStatus>sample string 13</DocStatus>
<DocTotal>10</DocTotal>
<DocumentLines>
<PurchaseOrderRows>
<BaseEntry>1</BaseEntry>
<BaseLine>1</BaseLine>
<BaseType>12</BaseType>
<Currency>sample string 7</Currency>
<DiscountPercent>5</DiscountPercent>
<ItemCode>sample string 1</ItemCode>
<ItemDescription>sample string 2</ItemDescription>
<LineNum>13</LineNum>
<LineStatus>sample string 14</LineStatus>
<Quantity>4</Quantity>
<TaxCode>sample string 8</TaxCode>
<TaxOnly>sample string 9</TaxOnly>
<TaxRate>10</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>11</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>
<VATLiable>16</VATLiable>
<WarehouseCode>sample string 6</WarehouseCode>
<WhsName>sample string 15</WhsName>
</PurchaseOrderRows>
<PurchaseOrderRows>
<BaseEntry>1</BaseEntry>
<BaseLine>1</BaseLine>
<BaseType>12</BaseType>
<Currency>sample string 7</Currency>
<DiscountPercent>5</DiscountPercent>
<ItemCode>sample string 1</ItemCode>
<ItemDescription>sample string 2</ItemDescription>
<LineNum>13</LineNum>
<LineStatus>sample string 14</LineStatus>
<Quantity>4</Quantity>
<TaxCode>sample string 8</TaxCode>
<TaxOnly>sample string 9</TaxOnly>
<TaxRate>10</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>11</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>
<VATLiable>16</VATLiable>
<WarehouseCode>sample string 6</WarehouseCode>
<WhsName>sample string 15</WhsName>
</PurchaseOrderRows>
</DocumentLines>
<PriceList>4</PriceList>
<SalesPersonCode>11</SalesPersonCode>
<TaxDate>2025-10-26T14:24:29.9100062-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>
<WithholdingTaxDataCollection>
<WithholdingTaxCode>
<WTCode>sample string 1</WTCode>
</WithholdingTaxCode>
<WithholdingTaxCode>
<WTCode>sample string 1</WTCode>
</WithholdingTaxCode>
</WithholdingTaxDataCollection>
</PurchaseOrder>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | 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. |