GET api/PurchaseOrder/{id}
Get a specific Purchase order by PurchaseOrderID
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
PurchaseOrder| Name | Description | Type | Additional information |
|---|---|---|---|
| PurchaseOrderId |
Sedona internal autonumber for the Purchase Order record; created when adding a new purchase order, required when updating an existing record |
integer |
None. |
| PONumber |
Purchase Order Number shown in Sedona |
string |
None. |
| CategoryCode |
Category_Code from AR_Category table |
string |
String length: inclusive between 0 and 25 |
| VendorCode |
Vendor_Code from AP_Vendor; defaults to N/A if not supplied |
string |
String length: inclusive between 0 and 50 |
| JobCode |
Value from OE_Job table; defaults to 000 if not set explicitly |
string |
String length: inclusive between 0 and 25 |
| TicketNumber |
Service Ticket Number from SV_Service_Ticket table |
integer |
None. |
| OrderDate |
Date of Purchase Order |
date |
None. |
| Closed | boolean |
None. |
|
| DueDate |
Date the Purchase Order is due |
date |
None. |
| ShippingDate | date |
None. |
|
| ShippingMethod | string |
String length: inclusive between 0 and 25 |
|
| ShippingReference |
Shipping Company's Tracking Number |
string |
String length: inclusive between 0 and 25 |
| TotalCost | decimal number |
None. |
|
| Memo | string |
String length: inclusive between 0 and 225 |
|
| BranchCode |
Value from AR_Branch table; defaults to N/A if not supplied; list of valid options can be retrieved from GET: api/branch |
string |
String length: inclusive between 0 and 25 |
| WarehouseCode |
Abbreviated Warehouse code; defaults to N/A if not supplied; list of valid options can be retrieved from GET: api/warehouse |
string |
String length: inclusive between 0 and 25 |
| OnBackOrder | boolean |
None. |
|
| ShippingAddress |
Ship To address |
string |
String length: inclusive between 0 and 200 |
| PartTotal | decimal number |
None. |
|
| ExpenseTotal | decimal number |
None. |
|
| DirectExpense | boolean |
None. |
|
| UserCode |
The user making this change; defaults to UserCode value from config file if not set explicitly |
string |
String length: inclusive between 0 and 30 |
| Acknowledged | boolean |
None. |
|
| AcknowledgedBy | string |
String length: inclusive between 0 and 30 |
|
| AcknowledgedDate | date |
None. |
|
| ADIStatus |
For use with ADI integration only; R = Ready to transmit; S = Sent |
string |
String length: inclusive between 0 and 25 |
| ADIAcknowledged |
For use with ADI integration only; ADI has acknowledged the Purchase Order |
boolean |
None. |
| ADIAcknowledgedDate |
For use with ADI integration only; date ADI acknowledged the Purchase Order |
date |
None. |
| PickupLocation | string |
String length: inclusive between 0 and 50 |
|
| Parts |
list of PO Parts; only used when adding a new PO |
Collection of PurchaseOrderPart |
None. |
| Expenses |
list of PO Expenses; only used when adding a new PO |
Collection of PurchaseOrderExpense |
None. |
Response Formats
application/json, text/json
{
"PurchaseOrderId": 1,
"PONumber": "sample string 2",
"CategoryCode": "sample string 3",
"VendorCode": "sample string 4",
"JobCode": "sample string 5",
"TicketNumber": 1,
"OrderDate": "2025-11-29T14:33:49.9412915-06:00",
"Closed": true,
"DueDate": "2025-11-29T14:33:49.9412915-06:00",
"ShippingDate": "2025-11-29T14:33:49.9412915-06:00",
"ShippingMethod": "sample string 6",
"ShippingReference": "sample string 7",
"TotalCost": 1.0,
"Memo": "sample string 8",
"BranchCode": "sample string 9",
"WarehouseCode": "sample string 10",
"OnBackOrder": true,
"ShippingAddress": "sample string 11",
"PartTotal": 1.0,
"ExpenseTotal": 1.0,
"DirectExpense": true,
"UserCode": "sample string 12",
"Acknowledged": true,
"AcknowledgedBy": "sample string 13",
"AcknowledgedDate": "2025-11-29T14:33:49.9412915-06:00",
"ADIStatus": "sample string 14",
"ADIAcknowledged": true,
"ADIAcknowledgedDate": "2025-11-29T14:33:49.9412915-06:00",
"PickupLocation": "sample string 15",
"Parts": [
{
"PurchaseOrderPartId": 1,
"PurchaseOrderId": 2,
"PartId": 1,
"PartCode": "sample string 3",
"Quantity": 1,
"UnitOfMeasureCode": "sample string 4",
"Cost": 1.0,
"ExtendedCost": 1.0,
"OnBackOrder": true,
"Memo": "sample string 5",
"VendorPartCode": "sample string 6",
"VendorPartDescription": "sample string 7",
"VendorPackageCount": 1,
"PhaseCode": "sample string 8",
"Location": "sample string 9"
},
{
"PurchaseOrderPartId": 1,
"PurchaseOrderId": 2,
"PartId": 1,
"PartCode": "sample string 3",
"Quantity": 1,
"UnitOfMeasureCode": "sample string 4",
"Cost": 1.0,
"ExtendedCost": 1.0,
"OnBackOrder": true,
"Memo": "sample string 5",
"VendorPartCode": "sample string 6",
"VendorPartDescription": "sample string 7",
"VendorPackageCount": 1,
"PhaseCode": "sample string 8",
"Location": "sample string 9"
}
],
"Expenses": [
{
"PurchaseOrderExpenseId": 1,
"PurchaseOrderId": 2,
"AccountCode": "sample string 3",
"Quantity": 1,
"Rate": 1.0,
"Amount": 1.0,
"Description": "sample string 4",
"CustomerNumber": "sample string 5",
"JobCode": "sample string 6",
"TicketNumber": 1,
"CategoryCode": "sample string 7",
"ExpenseTypeCode": "sample string 8"
},
{
"PurchaseOrderExpenseId": 1,
"PurchaseOrderId": 2,
"AccountCode": "sample string 3",
"Quantity": 1,
"Rate": 1.0,
"Amount": 1.0,
"Description": "sample string 4",
"CustomerNumber": "sample string 5",
"JobCode": "sample string 6",
"TicketNumber": 1,
"CategoryCode": "sample string 7",
"ExpenseTypeCode": "sample string 8"
}
]
}
application/xml, text/xml
<PurchaseOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
<ADIAcknowledged>true</ADIAcknowledged>
<ADIAcknowledgedDate>2025-11-29T14:33:49.9412915-06:00</ADIAcknowledgedDate>
<ADIStatus>sample string 14</ADIStatus>
<Acknowledged>true</Acknowledged>
<AcknowledgedBy>sample string 13</AcknowledgedBy>
<AcknowledgedDate>2025-11-29T14:33:49.9412915-06:00</AcknowledgedDate>
<BranchCode>sample string 9</BranchCode>
<CategoryCode>sample string 3</CategoryCode>
<Closed>true</Closed>
<DirectExpense>true</DirectExpense>
<DueDate>2025-11-29T14:33:49.9412915-06:00</DueDate>
<ExpenseTotal>1</ExpenseTotal>
<Expenses>
<PurchaseOrderExpense>
<AccountCode>sample string 3</AccountCode>
<Amount>1</Amount>
<CategoryCode>sample string 7</CategoryCode>
<CustomerNumber>sample string 5</CustomerNumber>
<Description>sample string 4</Description>
<ExpenseTypeCode>sample string 8</ExpenseTypeCode>
<JobCode>sample string 6</JobCode>
<PurchaseOrderExpenseId>1</PurchaseOrderExpenseId>
<PurchaseOrderId>2</PurchaseOrderId>
<Quantity>1</Quantity>
<Rate>1</Rate>
<TicketNumber>1</TicketNumber>
</PurchaseOrderExpense>
<PurchaseOrderExpense>
<AccountCode>sample string 3</AccountCode>
<Amount>1</Amount>
<CategoryCode>sample string 7</CategoryCode>
<CustomerNumber>sample string 5</CustomerNumber>
<Description>sample string 4</Description>
<ExpenseTypeCode>sample string 8</ExpenseTypeCode>
<JobCode>sample string 6</JobCode>
<PurchaseOrderExpenseId>1</PurchaseOrderExpenseId>
<PurchaseOrderId>2</PurchaseOrderId>
<Quantity>1</Quantity>
<Rate>1</Rate>
<TicketNumber>1</TicketNumber>
</PurchaseOrderExpense>
</Expenses>
<JobCode>sample string 5</JobCode>
<Memo>sample string 8</Memo>
<OnBackOrder>true</OnBackOrder>
<OrderDate>2025-11-29T14:33:49.9412915-06:00</OrderDate>
<PONumber>sample string 2</PONumber>
<PartTotal>1</PartTotal>
<Parts>
<PurchaseOrderPart>
<Cost>1</Cost>
<ExtendedCost>1</ExtendedCost>
<Location>sample string 9</Location>
<Memo>sample string 5</Memo>
<OnBackOrder>true</OnBackOrder>
<PartCode>sample string 3</PartCode>
<PartId>1</PartId>
<PhaseCode>sample string 8</PhaseCode>
<PurchaseOrderId>2</PurchaseOrderId>
<PurchaseOrderPartId>1</PurchaseOrderPartId>
<Quantity>1</Quantity>
<UnitOfMeasureCode>sample string 4</UnitOfMeasureCode>
<VendorPackageCount>1</VendorPackageCount>
<VendorPartCode>sample string 6</VendorPartCode>
<VendorPartDescription>sample string 7</VendorPartDescription>
</PurchaseOrderPart>
<PurchaseOrderPart>
<Cost>1</Cost>
<ExtendedCost>1</ExtendedCost>
<Location>sample string 9</Location>
<Memo>sample string 5</Memo>
<OnBackOrder>true</OnBackOrder>
<PartCode>sample string 3</PartCode>
<PartId>1</PartId>
<PhaseCode>sample string 8</PhaseCode>
<PurchaseOrderId>2</PurchaseOrderId>
<PurchaseOrderPartId>1</PurchaseOrderPartId>
<Quantity>1</Quantity>
<UnitOfMeasureCode>sample string 4</UnitOfMeasureCode>
<VendorPackageCount>1</VendorPackageCount>
<VendorPartCode>sample string 6</VendorPartCode>
<VendorPartDescription>sample string 7</VendorPartDescription>
</PurchaseOrderPart>
</Parts>
<PickupLocation>sample string 15</PickupLocation>
<PurchaseOrderId>1</PurchaseOrderId>
<ShippingAddress>sample string 11</ShippingAddress>
<ShippingDate>2025-11-29T14:33:49.9412915-06:00</ShippingDate>
<ShippingMethod>sample string 6</ShippingMethod>
<ShippingReference>sample string 7</ShippingReference>
<TicketNumber>1</TicketNumber>
<TotalCost>1</TotalCost>
<UserCode>sample string 12</UserCode>
<VendorCode>sample string 4</VendorCode>
<WarehouseCode>sample string 10</WarehouseCode>
</PurchaseOrder>