POST
api/v1/save-purchase-order?clientId={clientId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientId | integer |
Required |
Body Parameters
PurchaseOrder| Name | Description | Type | Additional information |
|---|---|---|---|
| DocEntry | integer |
None. |
|
| DocNum | string |
None. |
|
| BPCode | string |
None. |
|
| BPName | string |
None. |
|
| DocDate | date |
None. |
|
| UpdateDate | date |
None. |
|
| DocDueDate | date |
None. |
|
| DocType | string |
None. |
|
| DocStatus | string |
None. |
|
| DocStatusDesc | string |
None. |
|
| BillToId | string |
None. |
|
| BillToAddress | string |
None. |
|
| ShipToId | string |
None. |
|
| ShipToAddress | string |
None. |
|
| VendorRefNo | string |
None. |
|
| PaymentTermsCode | integer |
None. |
|
| PaymentTermsList | Collection of VendorPaymentTerms |
None. |
|
| Remarks | string |
None. |
|
| DiscPrcnt | decimal number |
None. |
|
| TotalDiscount | decimal number |
None. |
|
| TaxRate | decimal number |
None. |
|
| TotalTax | decimal number |
None. |
|
| DocTotal | decimal number |
None. |
|
| GrosProfit | decimal number |
None. |
|
| PaidToDate | decimal number |
None. |
|
| DRFTStatus | string |
None. |
|
| AStatus | string |
None. |
|
| Items | Collection of PurchaseOrderItem |
None. |
|
| hItems | string |
None. |
|
| WhsList | Collection of WareHouse |
None. |
|
| DocTotalBeforeDiscount | decimal number |
None. |
|
| IsCancelled | boolean |
None. |
|
| IsLogicalDeleted | boolean |
None. |
|
| BaseDocs | string |
None. |
|
| TargetDocs | string |
None. |
Request Formats
application/json
Sample not available.
text/json
Sample not available.
text/html
Sample not available.
application/xml, text/xml
<PurchaseOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models.Purchase">
<AStatus>sample string 19</AStatus>
<BPCode>sample string 3</BPCode>
<BPName>sample string 4</BPName>
<BaseDocs>sample string 24</BaseDocs>
<BillToAddress>sample string 8</BillToAddress>
<BillToId>sample string 7</BillToId>
<DRFTStatus>sample string 18</DRFTStatus>
<DiscPrcnt>1</DiscPrcnt>
<DocDate>2026-11-20T20:33:06.6538694-06:00</DocDate>
<DocDueDate>2026-11-20T20:33:06.6538694-06:00</DocDueDate>
<DocEntry>1</DocEntry>
<DocNum>sample string 2</DocNum>
<DocStatus>sample string 6</DocStatus>
<DocTotal>16</DocTotal>
<DocTotalBeforeDiscount>21</DocTotalBeforeDiscount>
<DocType>sample string 5</DocType>
<GrosProfit>17</GrosProfit>
<IsCancelled>true</IsCancelled>
<IsLogicalDeleted>true</IsLogicalDeleted>
<Items>
<PurchaseOrderItem>
<BaseEntry>1</BaseEntry>
<BaseLine>1</BaseLine>
<BaseType>sample string 9</BaseType>
<DiscPrcnt>1</DiscPrcnt>
<DocEntry>1</DocEntry>
<Dscription>sample string 3</Dscription>
<FreeTxt>sample string 6</FreeTxt>
<Height1>1</Height1>
<Hght1Unit>1</Hght1Unit>
<ItemCode>sample string 2</ItemCode>
<Len1Unit>1</Len1Unit>
<Length1>1</Length1>
<LineNum>1</LineNum>
<LineStatus>sample string 1</LineStatus>
<LineTotal>1</LineTotal>
<MnfId>1</MnfId>
<OpenQty>1</OpenQty>
<Price>1</Price>
<Quantity>1</Quantity>
<ShipDate>2026-11-20T20:33:06.6538694-06:00</ShipDate>
<TargetEntry>1</TargetEntry>
<TargetLine>1</TargetLine>
<TargetType>sample string 8</TargetType>
<TaxCode>sample string 7</TaxCode>
<UnitPrice>1</UnitPrice>
<UoM>sample string 5</UoM>
<Wdth1Unit>1</Wdth1Unit>
<Weight1>1</Weight1>
<Wght1Unit>1</Wght1Unit>
<WhsCode>sample string 4</WhsCode>
<Width1>1</Width1>
</PurchaseOrderItem>
<PurchaseOrderItem>
<BaseEntry>1</BaseEntry>
<BaseLine>1</BaseLine>
<BaseType>sample string 9</BaseType>
<DiscPrcnt>1</DiscPrcnt>
<DocEntry>1</DocEntry>
<Dscription>sample string 3</Dscription>
<FreeTxt>sample string 6</FreeTxt>
<Height1>1</Height1>
<Hght1Unit>1</Hght1Unit>
<ItemCode>sample string 2</ItemCode>
<Len1Unit>1</Len1Unit>
<Length1>1</Length1>
<LineNum>1</LineNum>
<LineStatus>sample string 1</LineStatus>
<LineTotal>1</LineTotal>
<MnfId>1</MnfId>
<OpenQty>1</OpenQty>
<Price>1</Price>
<Quantity>1</Quantity>
<ShipDate>2026-11-20T20:33:06.6538694-06:00</ShipDate>
<TargetEntry>1</TargetEntry>
<TargetLine>1</TargetLine>
<TargetType>sample string 8</TargetType>
<TaxCode>sample string 7</TaxCode>
<UnitPrice>1</UnitPrice>
<UoM>sample string 5</UoM>
<Wdth1Unit>1</Wdth1Unit>
<Weight1>1</Weight1>
<Wght1Unit>1</Wght1Unit>
<WhsCode>sample string 4</WhsCode>
<Width1>1</Width1>
</PurchaseOrderItem>
</Items>
<PaidToDate>1</PaidToDate>
<PaymentTermsCode>1</PaymentTermsCode>
<PaymentTermsList xmlns:d2p1="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models.Vendor">
<d2p1:VendorPaymentTerms>
<d2p1:Id>1</d2p1:Id>
<d2p1:IsLogicalDeleted>true</d2p1:IsLogicalDeleted>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:isActive>true</d2p1:isActive>
</d2p1:VendorPaymentTerms>
<d2p1:VendorPaymentTerms>
<d2p1:Id>1</d2p1:Id>
<d2p1:IsLogicalDeleted>true</d2p1:IsLogicalDeleted>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:isActive>true</d2p1:isActive>
</d2p1:VendorPaymentTerms>
</PaymentTermsList>
<Remarks>sample string 12</Remarks>
<ShipToAddress>sample string 10</ShipToAddress>
<ShipToId>sample string 9</ShipToId>
<TargetDocs>sample string 25</TargetDocs>
<TaxRate>14</TaxRate>
<TotalDiscount>13</TotalDiscount>
<TotalTax>15</TotalTax>
<UpdateDate>2026-11-20T20:33:06.6538694-06:00</UpdateDate>
<VendorRefNo>sample string 11</VendorRefNo>
<WhsList xmlns:d2p1="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models.Inventory">
<d2p1:WareHouse>
<First xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models">1</First>
<Last xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models">1</Last>
<Next xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models">1</Next>
<Prev xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models">1</Prev>
<d2p1:Address1>sample string 10</d2p1:Address1>
<d2p1:Address2>sample string 11</d2p1:Address2>
<d2p1:BinCodeFrom>sample string 24</d2p1:BinCodeFrom>
<d2p1:BinCodeTo>sample string 25</d2p1:BinCodeTo>
<d2p1:City>sample string 12</d2p1:City>
<d2p1:ClientId>23</d2p1:ClientId>
<d2p1:ContactName>sample string 18</d2p1:ContactName>
<d2p1:CountryCode>sample string 16</d2p1:CountryCode>
<d2p1:CountryName>sample string 17</d2p1:CountryName>
<d2p1:CreatedBy>22</d2p1:CreatedBy>
<d2p1:CreatedOn>2026-11-20T20:33:06.6538694-06:00</d2p1:CreatedOn>
<d2p1:Email>sample string 4</d2p1:Email>
<d2p1:FaxNumber>sample string 6</d2p1:FaxNumber>
<d2p1:IsActive>true</d2p1:IsActive>
<d2p1:IsDefault>true</d2p1:IsDefault>
<d2p1:IsLogicalDeleted>true</d2p1:IsLogicalDeleted>
<d2p1:Latitude>sample string 7</d2p1:Latitude>
<d2p1:Location>sample string 9</d2p1:Location>
<d2p1:Longitude>sample string 8</d2p1:Longitude>
<d2p1:ModifiedBy>1</d2p1:ModifiedBy>
<d2p1:ModifiedOn>2026-11-20T20:33:06.6538694-06:00</d2p1:ModifiedOn>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:PhoneNumber>sample string 5</d2p1:PhoneNumber>
<d2p1:StateCode>sample string 14</d2p1:StateCode>
<d2p1:StateName>sample string 15</d2p1:StateName>
<d2p1:WareHouseCode>sample string 2</d2p1:WareHouseCode>
<d2p1:WareHouseId>1</d2p1:WareHouseId>
<d2p1:ZipCode>sample string 13</d2p1:ZipCode>
</d2p1:WareHouse>
<d2p1:WareHouse>
<First xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models">1</First>
<Last xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models">1</Last>
<Next xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models">1</Next>
<Prev xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models">1</Prev>
<d2p1:Address1>sample string 10</d2p1:Address1>
<d2p1:Address2>sample string 11</d2p1:Address2>
<d2p1:BinCodeFrom>sample string 24</d2p1:BinCodeFrom>
<d2p1:BinCodeTo>sample string 25</d2p1:BinCodeTo>
<d2p1:City>sample string 12</d2p1:City>
<d2p1:ClientId>23</d2p1:ClientId>
<d2p1:ContactName>sample string 18</d2p1:ContactName>
<d2p1:CountryCode>sample string 16</d2p1:CountryCode>
<d2p1:CountryName>sample string 17</d2p1:CountryName>
<d2p1:CreatedBy>22</d2p1:CreatedBy>
<d2p1:CreatedOn>2026-11-20T20:33:06.6538694-06:00</d2p1:CreatedOn>
<d2p1:Email>sample string 4</d2p1:Email>
<d2p1:FaxNumber>sample string 6</d2p1:FaxNumber>
<d2p1:IsActive>true</d2p1:IsActive>
<d2p1:IsDefault>true</d2p1:IsDefault>
<d2p1:IsLogicalDeleted>true</d2p1:IsLogicalDeleted>
<d2p1:Latitude>sample string 7</d2p1:Latitude>
<d2p1:Location>sample string 9</d2p1:Location>
<d2p1:Longitude>sample string 8</d2p1:Longitude>
<d2p1:ModifiedBy>1</d2p1:ModifiedBy>
<d2p1:ModifiedOn>2026-11-20T20:33:06.6538694-06:00</d2p1:ModifiedOn>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:PhoneNumber>sample string 5</d2p1:PhoneNumber>
<d2p1:StateCode>sample string 14</d2p1:StateCode>
<d2p1:StateName>sample string 15</d2p1:StateName>
<d2p1:WareHouseCode>sample string 2</d2p1:WareHouseCode>
<d2p1:WareHouseId>1</d2p1:WareHouseId>
<d2p1:ZipCode>sample string 13</d2p1:ZipCode>
</d2p1:WareHouse>
</WhsList>
<hItems>sample string 20</hItems>
</PurchaseOrder>
application/x-www-form-urlencoded
Sample not available.
Response Information
Description:
Return type: boolean
Response Formats
application/json, text/json, text/html
true
application/xml, text/xml
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>
