DELETE api/PurchaseOrder
Deletes a purchase order.
Request Information
URI Parameters
None.
Body Parameters
Purchase Order.
PurchaseOrder| Name | Description | Type | Additional information |
|---|---|---|---|
| UpdateType | string |
None. |
|
| PurchaseOrderId | integer |
None. |
|
| SupplierId | integer |
None. |
|
| SupplierName | string |
None. |
|
| SupplierGlobalId | string |
None. |
|
| OrganizationId | integer |
None. |
|
| OrderTotal | decimal number |
None. |
|
| PurchaseOrderDate | date |
None. |
|
| OrderNumber | string |
None. |
|
| GlobalId | string |
None. |
|
| IsPaid | boolean |
None. |
|
| Note | string |
None. |
|
| CreatedBy | string |
None. |
|
| CreatedByName | string |
None. |
|
| CreatedDate | date |
None. |
|
| UpdatedBy | string |
None. |
|
| UpdatedByName | string |
None. |
|
| UpdatedDate | date |
None. |
|
| Description | string |
None. |
|
| BillingPeriodId | integer |
None. |
|
| BillingPeriod | string |
None. |
|
| PurchaseOrderNumber | integer |
None. |
|
| AttachmentCount | integer |
None. |
|
| IsExpense | boolean |
None. |
|
| ReceivedDate | date |
None. |
|
| PaidDate | date |
None. |
|
| SubmittedDate | date |
None. |
|
| PurchaseOrderStatusId | integer |
None. |
|
| PurchaseOrderStatus | string |
None. |
|
| OrderSubTotal | decimal number |
None. |
|
| OrderShipping | decimal number |
None. |
|
| OrderTax | decimal number |
None. |
|
| OrderDiscount | decimal number |
None. |
|
| IsAutoPay | boolean |
None. |
|
| PaymentReferenceNumber | string |
None. |
|
| PaymentFinancialAccountId | integer |
None. |
|
| PaymentFinancialAccount | string |
None. |
|
| PurchaseOrderDateYear | integer |
None. |
|
| ExpenseCategoryId | integer |
None. |
|
| ExpenseCategoryName | string |
None. |
|
| ProjectId | integer |
None. |
|
| ProjectName | string |
None. |
|
| IsSubmitted | boolean |
None. |
|
| IsReceived | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"UpdateType": "sample string 1",
"PurchaseOrderId": 2,
"SupplierId": 1,
"SupplierName": "sample string 3",
"SupplierGlobalId": "sample string 4",
"OrganizationId": 1,
"OrderTotal": 1.0,
"PurchaseOrderDate": "2025-01-16T22:20:21.0862868+00:00",
"OrderNumber": "sample string 5",
"GlobalId": "sample string 6",
"IsPaid": true,
"Note": "sample string 7",
"CreatedBy": "sample string 8",
"CreatedByName": "sample string 9",
"CreatedDate": "2025-01-16T22:20:21.0862868+00:00",
"UpdatedBy": "sample string 10",
"UpdatedByName": "sample string 11",
"UpdatedDate": "2025-01-16T22:20:21.0862868+00:00",
"Description": "sample string 12",
"BillingPeriodId": 1,
"BillingPeriod": "sample string 13",
"PurchaseOrderNumber": 1,
"AttachmentCount": 1,
"IsExpense": true,
"ReceivedDate": "2025-01-16T22:20:21.0862868+00:00",
"PaidDate": "2025-01-16T22:20:21.0862868+00:00",
"SubmittedDate": "2025-01-16T22:20:21.0862868+00:00",
"PurchaseOrderStatusId": 1,
"PurchaseOrderStatus": "sample string 14",
"OrderSubTotal": 1.0,
"OrderShipping": 1.0,
"OrderTax": 1.0,
"OrderDiscount": 1.0,
"IsAutoPay": true,
"PaymentReferenceNumber": "sample string 15",
"PaymentFinancialAccountId": 1,
"PaymentFinancialAccount": "sample string 16",
"PurchaseOrderDateYear": 1,
"ExpenseCategoryId": 1,
"ExpenseCategoryName": "sample string 17",
"ProjectId": 1,
"ProjectName": "sample string 18",
"IsSubmitted": true,
"IsReceived": true
}
application/xml, text/xml
Sample:
<PurchaseOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CustomersdbWebShared.Models"> <AttachmentCount>1</AttachmentCount> <BillingPeriod>sample string 13</BillingPeriod> <BillingPeriodId>1</BillingPeriodId> <CreatedBy>sample string 8</CreatedBy> <CreatedByName>sample string 9</CreatedByName> <CreatedDate>2025-01-16T22:20:21.0862868+00:00</CreatedDate> <Description>sample string 12</Description> <ExpenseCategoryId>1</ExpenseCategoryId> <ExpenseCategoryName>sample string 17</ExpenseCategoryName> <GlobalId>sample string 6</GlobalId> <IsAutoPay>true</IsAutoPay> <IsExpense>true</IsExpense> <IsPaid>true</IsPaid> <IsReceived>true</IsReceived> <IsSubmitted>true</IsSubmitted> <Note>sample string 7</Note> <OrderDiscount>1</OrderDiscount> <OrderNumber>sample string 5</OrderNumber> <OrderShipping>1</OrderShipping> <OrderSubTotal>1</OrderSubTotal> <OrderTax>1</OrderTax> <OrderTotal>1</OrderTotal> <OrganizationId>1</OrganizationId> <PaidDate>2025-01-16T22:20:21.0862868+00:00</PaidDate> <PaymentFinancialAccount>sample string 16</PaymentFinancialAccount> <PaymentFinancialAccountId>1</PaymentFinancialAccountId> <PaymentReferenceNumber>sample string 15</PaymentReferenceNumber> <ProjectId>1</ProjectId> <ProjectName>sample string 18</ProjectName> <PurchaseOrderDate>2025-01-16T22:20:21.0862868+00:00</PurchaseOrderDate> <PurchaseOrderDateYear>1</PurchaseOrderDateYear> <PurchaseOrderId>2</PurchaseOrderId> <PurchaseOrderNumber>1</PurchaseOrderNumber> <PurchaseOrderStatus>sample string 14</PurchaseOrderStatus> <PurchaseOrderStatusId>1</PurchaseOrderStatusId> <ReceivedDate>2025-01-16T22:20:21.0862868+00:00</ReceivedDate> <SubmittedDate>2025-01-16T22:20:21.0862868+00:00</SubmittedDate> <SupplierGlobalId>sample string 4</SupplierGlobalId> <SupplierId>1</SupplierId> <SupplierName>sample string 3</SupplierName> <UpdateType>sample string 1</UpdateType> <UpdatedBy>sample string 10</UpdatedBy> <UpdatedByName>sample string 11</UpdatedByName> <UpdatedDate>2025-01-16T22:20:21.0862868+00:00</UpdatedDate> </PurchaseOrder>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
PurchaseOrder| Name | Description | Type | Additional information |
|---|---|---|---|
| UpdateType | string |
None. |
|
| PurchaseOrderId | integer |
None. |
|
| SupplierId | integer |
None. |
|
| SupplierName | string |
None. |
|
| SupplierGlobalId | string |
None. |
|
| OrganizationId | integer |
None. |
|
| OrderTotal | decimal number |
None. |
|
| PurchaseOrderDate | date |
None. |
|
| OrderNumber | string |
None. |
|
| GlobalId | string |
None. |
|
| IsPaid | boolean |
None. |
|
| Note | string |
None. |
|
| CreatedBy | string |
None. |
|
| CreatedByName | string |
None. |
|
| CreatedDate | date |
None. |
|
| UpdatedBy | string |
None. |
|
| UpdatedByName | string |
None. |
|
| UpdatedDate | date |
None. |
|
| Description | string |
None. |
|
| BillingPeriodId | integer |
None. |
|
| BillingPeriod | string |
None. |
|
| PurchaseOrderNumber | integer |
None. |
|
| AttachmentCount | integer |
None. |
|
| IsExpense | boolean |
None. |
|
| ReceivedDate | date |
None. |
|
| PaidDate | date |
None. |
|
| SubmittedDate | date |
None. |
|
| PurchaseOrderStatusId | integer |
None. |
|
| PurchaseOrderStatus | string |
None. |
|
| OrderSubTotal | decimal number |
None. |
|
| OrderShipping | decimal number |
None. |
|
| OrderTax | decimal number |
None. |
|
| OrderDiscount | decimal number |
None. |
|
| IsAutoPay | boolean |
None. |
|
| PaymentReferenceNumber | string |
None. |
|
| PaymentFinancialAccountId | integer |
None. |
|
| PaymentFinancialAccount | string |
None. |
|
| PurchaseOrderDateYear | integer |
None. |
|
| ExpenseCategoryId | integer |
None. |
|
| ExpenseCategoryName | string |
None. |
|
| ProjectId | integer |
None. |
|
| ProjectName | string |
None. |
|
| IsSubmitted | boolean |
None. |
|
| IsReceived | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"UpdateType": "sample string 1",
"PurchaseOrderId": 2,
"SupplierId": 1,
"SupplierName": "sample string 3",
"SupplierGlobalId": "sample string 4",
"OrganizationId": 1,
"OrderTotal": 1.0,
"PurchaseOrderDate": "2025-01-16T22:20:21.1019082+00:00",
"OrderNumber": "sample string 5",
"GlobalId": "sample string 6",
"IsPaid": true,
"Note": "sample string 7",
"CreatedBy": "sample string 8",
"CreatedByName": "sample string 9",
"CreatedDate": "2025-01-16T22:20:21.1019082+00:00",
"UpdatedBy": "sample string 10",
"UpdatedByName": "sample string 11",
"UpdatedDate": "2025-01-16T22:20:21.1019082+00:00",
"Description": "sample string 12",
"BillingPeriodId": 1,
"BillingPeriod": "sample string 13",
"PurchaseOrderNumber": 1,
"AttachmentCount": 1,
"IsExpense": true,
"ReceivedDate": "2025-01-16T22:20:21.1019082+00:00",
"PaidDate": "2025-01-16T22:20:21.1019082+00:00",
"SubmittedDate": "2025-01-16T22:20:21.1019082+00:00",
"PurchaseOrderStatusId": 1,
"PurchaseOrderStatus": "sample string 14",
"OrderSubTotal": 1.0,
"OrderShipping": 1.0,
"OrderTax": 1.0,
"OrderDiscount": 1.0,
"IsAutoPay": true,
"PaymentReferenceNumber": "sample string 15",
"PaymentFinancialAccountId": 1,
"PaymentFinancialAccount": "sample string 16",
"PurchaseOrderDateYear": 1,
"ExpenseCategoryId": 1,
"ExpenseCategoryName": "sample string 17",
"ProjectId": 1,
"ProjectName": "sample string 18",
"IsSubmitted": true,
"IsReceived": true
}
application/xml, text/xml
Sample:
<PurchaseOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CustomersdbWebShared.Models"> <AttachmentCount>1</AttachmentCount> <BillingPeriod>sample string 13</BillingPeriod> <BillingPeriodId>1</BillingPeriodId> <CreatedBy>sample string 8</CreatedBy> <CreatedByName>sample string 9</CreatedByName> <CreatedDate>2025-01-16T22:20:21.1019082+00:00</CreatedDate> <Description>sample string 12</Description> <ExpenseCategoryId>1</ExpenseCategoryId> <ExpenseCategoryName>sample string 17</ExpenseCategoryName> <GlobalId>sample string 6</GlobalId> <IsAutoPay>true</IsAutoPay> <IsExpense>true</IsExpense> <IsPaid>true</IsPaid> <IsReceived>true</IsReceived> <IsSubmitted>true</IsSubmitted> <Note>sample string 7</Note> <OrderDiscount>1</OrderDiscount> <OrderNumber>sample string 5</OrderNumber> <OrderShipping>1</OrderShipping> <OrderSubTotal>1</OrderSubTotal> <OrderTax>1</OrderTax> <OrderTotal>1</OrderTotal> <OrganizationId>1</OrganizationId> <PaidDate>2025-01-16T22:20:21.1019082+00:00</PaidDate> <PaymentFinancialAccount>sample string 16</PaymentFinancialAccount> <PaymentFinancialAccountId>1</PaymentFinancialAccountId> <PaymentReferenceNumber>sample string 15</PaymentReferenceNumber> <ProjectId>1</ProjectId> <ProjectName>sample string 18</ProjectName> <PurchaseOrderDate>2025-01-16T22:20:21.1019082+00:00</PurchaseOrderDate> <PurchaseOrderDateYear>1</PurchaseOrderDateYear> <PurchaseOrderId>2</PurchaseOrderId> <PurchaseOrderNumber>1</PurchaseOrderNumber> <PurchaseOrderStatus>sample string 14</PurchaseOrderStatus> <PurchaseOrderStatusId>1</PurchaseOrderStatusId> <ReceivedDate>2025-01-16T22:20:21.1019082+00:00</ReceivedDate> <SubmittedDate>2025-01-16T22:20:21.1019082+00:00</SubmittedDate> <SupplierGlobalId>sample string 4</SupplierGlobalId> <SupplierId>1</SupplierId> <SupplierName>sample string 3</SupplierName> <UpdateType>sample string 1</UpdateType> <UpdatedBy>sample string 10</UpdatedBy> <UpdatedByName>sample string 11</UpdatedByName> <UpdatedDate>2025-01-16T22:20:21.1019082+00:00</UpdatedDate> </PurchaseOrder>