POST ApPurchaseOrder/PostApPurchaseOrder
Creates an AP Purchase Order.
Request Information
URI Parameters
Body Parameters
The AP Purchase Order object used to create the transaction.
ClsApPoAddName | Description | Type | Additional Information |
---|---|---|---|
VendorId |
The Vendor ID the AP Purchase Order is for |
string |
Required Max length: 10 |
PODate |
The date of the purchase order. |
string |
Required Data type: DateTime Format must be MM/dd/yyyy |
Description |
User entered description or short note about the AP Purchase Order. |
string |
Max length: 40 |
PONumber |
The Purchase Order Number |
string |
Max length: 10 |
PONumberLocationIdOverride |
Optional LocationId to override Purchase Order Numbering |
string |
Max length: 6 |
Notes |
User entered notes on the Purchase Order. |
string |
Max length: 250 |
PayByEFTYN |
'True' or 'False' value indicating if Purchase Order will be paid by Electronic Fund Transfer. |
boolean |
Must be 0, 1, True, or False |
PaidByDate1 |
The date to pay the Purchase Order by in order to receive discount1. |
string |
Data type: DateTime Format must be MM/dd/yyyy |
PaidByDate2 |
The date to pay the Purchase Order by in order to receive discount2. |
string |
Data type: DateTime Format must be MM/dd/yyyy |
PaidByDate3 |
The date to pay the Purchase Order by in order to receive discount3. |
string |
Data type: DateTime Format must be MM/dd/yyyy |
PaidByDate4 |
The date to pay the Purchase Order by in order to receive discount4. |
string |
Data type: DateTime Format must be MM/dd/yyyy |
PaidByDate5 |
The date to pay the Purchase Order by in order to receive discount5. |
string |
Data type: DateTime Format must be MM/dd/yyyy |
DeductionPercent1 |
The Discount percentage given if the Purchase Order is paid by PaidBy1 date. |
decimal number |
Max of 2 decimal places Must be numeric |
DeductionPercent2 |
The Discount percentage given if the Purchase Order is paid by PaidBy2 date. |
decimal number |
Max of 2 decimal places Must be numeric |
DeductionPercent3 |
The Discount percentage given if the Purchase Order is paid by PaidBy3 date. |
decimal number |
Max of 2 decimal places Must be numeric |
DeductionPercent4 |
The Discount percentage given if the Purchase Order is paid by PaidBy4 date. |
decimal number |
Max of 2 decimal places Must be numeric |
DeductionPercent5 |
The Discount percentage given if the Purchase Order is paid by PaidBy5 date. |
decimal number |
Max of 2 decimal places Must be numeric |
DiscountAmount1 |
The Discount amount for the Purchase Order if paid by PaidBy1. |
decimal number |
Max of 2 decimal places Must be numeric |
DiscountAmount2 |
The Discount amount for the Purchase Order if paid by PaidBy2. |
decimal number |
Max of 2 decimal places Must be numeric |
DiscountAmount3 |
The Discount amount for the Purchase Order if paid by PaidBy3. |
decimal number |
Max of 2 decimal places Must be numeric |
DiscountAmount4 |
The Discount amount for the Purchase Order if paid by PaidBy4. |
decimal number |
Max of 2 decimal places Must be numeric |
DiscountAmount5 |
The Discount amount for the Purchase Order if paid by PaidBy5. |
decimal number |
Max of 2 decimal places Must be numeric |
DiscountGL |
The General Ledger account to post the Purchase Order discount to. |
string |
Max length: 10 |
PODetailsAdd |
A list that displays the amounts to be paid and supporting information on the Purchase Order. |
Collection of ClsApPoDtAdd |
Required List cannot be empty |
Request Formats
application/json, text/json
{ "VendorId": "sample string 1", "PODate": "sample string 2", "Description": "sample string 3", "PONumber": "sample string 4", "PONumberLocationIdOverride": "sample string 5", "Notes": "sample string 6", "PayByEFTYN": true, "PaidByDate1": "sample string 8", "PaidByDate2": "sample string 9", "PaidByDate3": "sample string 10", "PaidByDate4": "sample string 11", "PaidByDate5": "sample string 12", "DeductionPercent1": 13.1, "DeductionPercent2": 14.1, "DeductionPercent3": 15.1, "DeductionPercent4": 16.1, "DeductionPercent5": 17.1, "DiscountAmount1": 18.1, "DiscountAmount2": 19.1, "DiscountAmount3": 20.1, "DiscountAmount4": 21.1, "DiscountAmount5": 22.1, "DiscountGL": "sample string 23", "PODetailsAdd": [ { "GLAccount": "sample string 1", "Amount": 2.1, "Comment": "sample string 3", "PartNumber": "sample string 4", "UnitPrice": 5.1, "Quantity": 6.1, "VehicleID": "sample string 7" }, { "GLAccount": "sample string 1", "Amount": 2.1, "Comment": "sample string 3", "PartNumber": "sample string 4", "UnitPrice": 5.1, "Quantity": 6.1, "VehicleID": "sample string 7" } ] }
application/xml, text/xml
<APPurchaseOrderAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.AP"> <DeductionPercent1>13.1</DeductionPercent1> <DeductionPercent2>14.1</DeductionPercent2> <DeductionPercent3>15.1</DeductionPercent3> <DeductionPercent4>16.1</DeductionPercent4> <DeductionPercent5>17.1</DeductionPercent5> <Description>sample string 3</Description> <DiscountAmount1>18.1</DiscountAmount1> <DiscountAmount2>19.1</DiscountAmount2> <DiscountAmount3>20.1</DiscountAmount3> <DiscountAmount4>21.1</DiscountAmount4> <DiscountAmount5>22.1</DiscountAmount5> <DiscountGL>sample string 23</DiscountGL> <Notes>sample string 6</Notes> <PODate>sample string 2</PODate> <PODetailsAdd> <PODetailAdd> <Amount>2.1</Amount> <Comment>sample string 3</Comment> <GLAccount>sample string 1</GLAccount> <PartNumber>sample string 4</PartNumber> <Quantity>6.1</Quantity> <UnitPrice>5.1</UnitPrice> <VehicleID>sample string 7</VehicleID> </PODetailAdd> <PODetailAdd> <Amount>2.1</Amount> <Comment>sample string 3</Comment> <GLAccount>sample string 1</GLAccount> <PartNumber>sample string 4</PartNumber> <Quantity>6.1</Quantity> <UnitPrice>5.1</UnitPrice> <VehicleID>sample string 7</VehicleID> </PODetailAdd> </PODetailsAdd> <PONumber>sample string 4</PONumber> <PONumberLocationIdOverride>sample string 5</PONumberLocationIdOverride> <PaidByDate1>sample string 8</PaidByDate1> <PaidByDate2>sample string 9</PaidByDate2> <PaidByDate3>sample string 10</PaidByDate3> <PaidByDate4>sample string 11</PaidByDate4> <PaidByDate5>sample string 12</PaidByDate5> <PayByEFTYN>true</PayByEFTYN> <VendorId>sample string 1</VendorId> </APPurchaseOrderAdd>
application/x-www-form-urlencoded
Response Information
Resource Description
Creates an AP Purchase Order.
AgvApPoName | Description | Type | Additional Information |
---|---|---|---|
Status |
0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful. |
string | |
Message |
Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know. |
string | |
ErrorList |
List of error messages of the API call. |
Collection of string | |
WarningList |
List of warning messages of the API call. |
Collection of string | |
Count |
Number of results returned. |
string | |
Data |
List of Properties and Values returned for each AP Purchase Order that matches request |
Collection of clsApBill |
Response Formats
application/json, text/json
{ "Status": "sample string 1", "Message": "sample string 2", "ErrorList": [ "sample string 1", "sample string 2" ], "WarningList": [ "sample string 1", "sample string 2" ], "Count": "2", "Data": [ { "Vendor": "sample string 1", "InvoiceNumber": "sample string 2", "Description": "sample string 3", "EntryDate": "sample string 4", "BillDate": "sample string 5", "DueDate": "sample string 6", "Source": "sample string 7", "UserName": "sample string 8", "PONumber": "sample string 9", "OnHoldYN": true, "PaidByDate1": "sample string 11", "PaidByDate2": "sample string 12", "PaidByDate3": "sample string 13", "PaidByDate4": "sample string 14", "PaidByDate5": "sample string 15", "DeductionPercent1": 16.1, "DeductionPercent2": 17.1, "DeductionPercent3": 18.1, "DeductionPercent4": 19.1, "DeductionPercent5": 20.1, "DiscountAmount1": 21.1, "DiscountAmount2": 22.1, "DiscountAmount3": 23.1, "DiscountAmount4": 24.1, "DiscountAmount5": 25.1, "DiscountGL": "sample string 26", "Gross": 27.1, "Discount": 28.1, "Net": 29.1, "DatePaid": "sample string 30", "AmountPaid": 31.1, "PaidYN": true, "VoidedYN": true, "ReversedYN": true, "Amount1099": 35.1, "CheckNumber": "sample string 36", "FiscalMonth": 37, "UsePrepayYN": true, "Transferred": true, "LocationID": "sample string 40", "SpecialHandling": "sample string 41", "PayByEFTYN": true, "Notes": "sample string 43", "POInvoice": "sample string 44", "APPurchaseOrder": true, "UserID": "sample string 46", "ApBillGuid": "725787f1-ab48-44b1-8a8e-a4138caae2eb", "BillDetail": [ { "Vendor": "sample string 1", "Invoice": "sample string 2", "LineItem": 3, "GLAccount": "sample string 4", "Amount": 5.1, "Comment": "sample string 6", "Quantity": 8.1, "UnitPrice": 9.1, "VehicleID": "sample string 10", "GLAccountDescription": "sample string 11" }, { "Vendor": "sample string 1", "Invoice": "sample string 2", "LineItem": 3, "GLAccount": "sample string 4", "Amount": 5.1, "Comment": "sample string 6", "Quantity": 8.1, "UnitPrice": 9.1, "VehicleID": "sample string 10", "GLAccountDescription": "sample string 11" } ] }, { "Vendor": "sample string 1", "InvoiceNumber": "sample string 2", "Description": "sample string 3", "EntryDate": "sample string 4", "BillDate": "sample string 5", "DueDate": "sample string 6", "Source": "sample string 7", "UserName": "sample string 8", "PONumber": "sample string 9", "OnHoldYN": true, "PaidByDate1": "sample string 11", "PaidByDate2": "sample string 12", "PaidByDate3": "sample string 13", "PaidByDate4": "sample string 14", "PaidByDate5": "sample string 15", "DeductionPercent1": 16.1, "DeductionPercent2": 17.1, "DeductionPercent3": 18.1, "DeductionPercent4": 19.1, "DeductionPercent5": 20.1, "DiscountAmount1": 21.1, "DiscountAmount2": 22.1, "DiscountAmount3": 23.1, "DiscountAmount4": 24.1, "DiscountAmount5": 25.1, "DiscountGL": "sample string 26", "Gross": 27.1, "Discount": 28.1, "Net": 29.1, "DatePaid": "sample string 30", "AmountPaid": 31.1, "PaidYN": true, "VoidedYN": true, "ReversedYN": true, "Amount1099": 35.1, "CheckNumber": "sample string 36", "FiscalMonth": 37, "UsePrepayYN": true, "Transferred": true, "LocationID": "sample string 40", "SpecialHandling": "sample string 41", "PayByEFTYN": true, "Notes": "sample string 43", "POInvoice": "sample string 44", "APPurchaseOrder": true, "UserID": "sample string 46", "ApBillGuid": "725787f1-ab48-44b1-8a8e-a4138caae2eb", "BillDetail": [ { "Vendor": "sample string 1", "Invoice": "sample string 2", "LineItem": 3, "GLAccount": "sample string 4", "Amount": 5.1, "Comment": "sample string 6", "Quantity": 8.1, "UnitPrice": 9.1, "VehicleID": "sample string 10", "GLAccountDescription": "sample string 11" }, { "Vendor": "sample string 1", "Invoice": "sample string 2", "LineItem": 3, "GLAccount": "sample string 4", "Amount": 5.1, "Comment": "sample string 6", "Quantity": 8.1, "UnitPrice": 9.1, "VehicleID": "sample string 10", "GLAccountDescription": "sample string 11" } ] } ] }
application/xml, text/xml
<AgvApPo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Vendor"> <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.AP"> <d2p1:APBill> <d2p1:APPurchaseOrder>true</d2p1:APPurchaseOrder> <d2p1:Amount1099>35.1</d2p1:Amount1099> <d2p1:AmountPaid>31.1</d2p1:AmountPaid> <d2p1:ApBillGuid>725787f1-ab48-44b1-8a8e-a4138caae2eb</d2p1:ApBillGuid> <d2p1:BillDate>sample string 5</d2p1:BillDate> <d2p1:BillDetail> <d2p1:BillDetail> <d2p1:Amount>5.1</d2p1:Amount> <d2p1:Comment>sample string 6</d2p1:Comment> <d2p1:GLAccount>sample string 4</d2p1:GLAccount> <d2p1:GLAccountDescription>sample string 11</d2p1:GLAccountDescription> <d2p1:Invoice>sample string 2</d2p1:Invoice> <d2p1:LineItem>3</d2p1:LineItem> <d2p1:Quantity>8.1</d2p1:Quantity> <d2p1:UnitPrice>9.1</d2p1:UnitPrice> <d2p1:VehicleID>sample string 10</d2p1:VehicleID> <d2p1:Vendor>sample string 1</d2p1:Vendor> </d2p1:BillDetail> <d2p1:BillDetail> <d2p1:Amount>5.1</d2p1:Amount> <d2p1:Comment>sample string 6</d2p1:Comment> <d2p1:GLAccount>sample string 4</d2p1:GLAccount> <d2p1:GLAccountDescription>sample string 11</d2p1:GLAccountDescription> <d2p1:Invoice>sample string 2</d2p1:Invoice> <d2p1:LineItem>3</d2p1:LineItem> <d2p1:Quantity>8.1</d2p1:Quantity> <d2p1:UnitPrice>9.1</d2p1:UnitPrice> <d2p1:VehicleID>sample string 10</d2p1:VehicleID> <d2p1:Vendor>sample string 1</d2p1:Vendor> </d2p1:BillDetail> </d2p1:BillDetail> <d2p1:CheckNumber>sample string 36</d2p1:CheckNumber> <d2p1:DatePaid>sample string 30</d2p1:DatePaid> <d2p1:DeductionPercent1>16.1</d2p1:DeductionPercent1> <d2p1:DeductionPercent2>17.1</d2p1:DeductionPercent2> <d2p1:DeductionPercent3>18.1</d2p1:DeductionPercent3> <d2p1:DeductionPercent4>19.1</d2p1:DeductionPercent4> <d2p1:DeductionPercent5>20.1</d2p1:DeductionPercent5> <d2p1:Description>sample string 3</d2p1:Description> <d2p1:Discount>28.1</d2p1:Discount> <d2p1:DiscountAmount1>21.1</d2p1:DiscountAmount1> <d2p1:DiscountAmount2>22.1</d2p1:DiscountAmount2> <d2p1:DiscountAmount3>23.1</d2p1:DiscountAmount3> <d2p1:DiscountAmount4>24.1</d2p1:DiscountAmount4> <d2p1:DiscountAmount5>25.1</d2p1:DiscountAmount5> <d2p1:DiscountGL>sample string 26</d2p1:DiscountGL> <d2p1:DueDate>sample string 6</d2p1:DueDate> <d2p1:EntryDate>sample string 4</d2p1:EntryDate> <d2p1:FiscalMonth>37</d2p1:FiscalMonth> <d2p1:Gross>27.1</d2p1:Gross> <d2p1:InvoiceNumber>sample string 2</d2p1:InvoiceNumber> <d2p1:LocationID>sample string 40</d2p1:LocationID> <d2p1:Net>29.1</d2p1:Net> <d2p1:Notes>sample string 43</d2p1:Notes> <d2p1:OnHoldYN>true</d2p1:OnHoldYN> <d2p1:POInvoice>sample string 44</d2p1:POInvoice> <d2p1:PONumber>sample string 9</d2p1:PONumber> <d2p1:PaidByDate1>sample string 11</d2p1:PaidByDate1> <d2p1:PaidByDate2>sample string 12</d2p1:PaidByDate2> <d2p1:PaidByDate3>sample string 13</d2p1:PaidByDate3> <d2p1:PaidByDate4>sample string 14</d2p1:PaidByDate4> <d2p1:PaidByDate5>sample string 15</d2p1:PaidByDate5> <d2p1:PaidYN>true</d2p1:PaidYN> <d2p1:PayByEFTYN>true</d2p1:PayByEFTYN> <d2p1:ReversedYN>true</d2p1:ReversedYN> <d2p1:Source>sample string 7</d2p1:Source> <d2p1:SpecialHandling>sample string 41</d2p1:SpecialHandling> <d2p1:Transferred>true</d2p1:Transferred> <d2p1:UsePrepayYN>true</d2p1:UsePrepayYN> <d2p1:UserID>sample string 46</d2p1:UserID> <d2p1:UserName>sample string 8</d2p1:UserName> <d2p1:Vendor>sample string 1</d2p1:Vendor> <d2p1:VoidedYN>true</d2p1:VoidedYN> </d2p1:APBill> <d2p1:APBill> <d2p1:APPurchaseOrder>true</d2p1:APPurchaseOrder> <d2p1:Amount1099>35.1</d2p1:Amount1099> <d2p1:AmountPaid>31.1</d2p1:AmountPaid> <d2p1:ApBillGuid>725787f1-ab48-44b1-8a8e-a4138caae2eb</d2p1:ApBillGuid> <d2p1:BillDate>sample string 5</d2p1:BillDate> <d2p1:BillDetail> <d2p1:BillDetail> <d2p1:Amount>5.1</d2p1:Amount> <d2p1:Comment>sample string 6</d2p1:Comment> <d2p1:GLAccount>sample string 4</d2p1:GLAccount> <d2p1:GLAccountDescription>sample string 11</d2p1:GLAccountDescription> <d2p1:Invoice>sample string 2</d2p1:Invoice> <d2p1:LineItem>3</d2p1:LineItem> <d2p1:Quantity>8.1</d2p1:Quantity> <d2p1:UnitPrice>9.1</d2p1:UnitPrice> <d2p1:VehicleID>sample string 10</d2p1:VehicleID> <d2p1:Vendor>sample string 1</d2p1:Vendor> </d2p1:BillDetail> <d2p1:BillDetail> <d2p1:Amount>5.1</d2p1:Amount> <d2p1:Comment>sample string 6</d2p1:Comment> <d2p1:GLAccount>sample string 4</d2p1:GLAccount> <d2p1:GLAccountDescription>sample string 11</d2p1:GLAccountDescription> <d2p1:Invoice>sample string 2</d2p1:Invoice> <d2p1:LineItem>3</d2p1:LineItem> <d2p1:Quantity>8.1</d2p1:Quantity> <d2p1:UnitPrice>9.1</d2p1:UnitPrice> <d2p1:VehicleID>sample string 10</d2p1:VehicleID> <d2p1:Vendor>sample string 1</d2p1:Vendor> </d2p1:BillDetail> </d2p1:BillDetail> <d2p1:CheckNumber>sample string 36</d2p1:CheckNumber> <d2p1:DatePaid>sample string 30</d2p1:DatePaid> <d2p1:DeductionPercent1>16.1</d2p1:DeductionPercent1> <d2p1:DeductionPercent2>17.1</d2p1:DeductionPercent2> <d2p1:DeductionPercent3>18.1</d2p1:DeductionPercent3> <d2p1:DeductionPercent4>19.1</d2p1:DeductionPercent4> <d2p1:DeductionPercent5>20.1</d2p1:DeductionPercent5> <d2p1:Description>sample string 3</d2p1:Description> <d2p1:Discount>28.1</d2p1:Discount> <d2p1:DiscountAmount1>21.1</d2p1:DiscountAmount1> <d2p1:DiscountAmount2>22.1</d2p1:DiscountAmount2> <d2p1:DiscountAmount3>23.1</d2p1:DiscountAmount3> <d2p1:DiscountAmount4>24.1</d2p1:DiscountAmount4> <d2p1:DiscountAmount5>25.1</d2p1:DiscountAmount5> <d2p1:DiscountGL>sample string 26</d2p1:DiscountGL> <d2p1:DueDate>sample string 6</d2p1:DueDate> <d2p1:EntryDate>sample string 4</d2p1:EntryDate> <d2p1:FiscalMonth>37</d2p1:FiscalMonth> <d2p1:Gross>27.1</d2p1:Gross> <d2p1:InvoiceNumber>sample string 2</d2p1:InvoiceNumber> <d2p1:LocationID>sample string 40</d2p1:LocationID> <d2p1:Net>29.1</d2p1:Net> <d2p1:Notes>sample string 43</d2p1:Notes> <d2p1:OnHoldYN>true</d2p1:OnHoldYN> <d2p1:POInvoice>sample string 44</d2p1:POInvoice> <d2p1:PONumber>sample string 9</d2p1:PONumber> <d2p1:PaidByDate1>sample string 11</d2p1:PaidByDate1> <d2p1:PaidByDate2>sample string 12</d2p1:PaidByDate2> <d2p1:PaidByDate3>sample string 13</d2p1:PaidByDate3> <d2p1:PaidByDate4>sample string 14</d2p1:PaidByDate4> <d2p1:PaidByDate5>sample string 15</d2p1:PaidByDate5> <d2p1:PaidYN>true</d2p1:PaidYN> <d2p1:PayByEFTYN>true</d2p1:PayByEFTYN> <d2p1:ReversedYN>true</d2p1:ReversedYN> <d2p1:Source>sample string 7</d2p1:Source> <d2p1:SpecialHandling>sample string 41</d2p1:SpecialHandling> <d2p1:Transferred>true</d2p1:Transferred> <d2p1:UsePrepayYN>true</d2p1:UsePrepayYN> <d2p1:UserID>sample string 46</d2p1:UserID> <d2p1:UserName>sample string 8</d2p1:UserName> <d2p1:Vendor>sample string 1</d2p1:Vendor> <d2p1:VoidedYN>true</d2p1:VoidedYN> </d2p1:APBill> </Data> <ErrorList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </ErrorList> <Message>sample string 2</Message> <Status>sample string 1</Status> <WarningList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </WarningList> </AgvApPo>