| POST | /PurchaseOrders/Activate/{PurchaseOrderID} | Sets the status of a purchase order to 'Sent'. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PurchaseOrderID | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PurchaseOrderID | form | string | No | |
| CreditorRecID | form | string | No | |
| CreditorAccountNo | form | string | No | |
| CreditorName | form | string | No | |
| CreditorWarehouseRecID | form | string | No | |
| CreditorWarehouseDescription | form | string | No | |
| LogicalWarehouseResidingInRecID | form | string | No | |
| LogicalWarehouseResidingInDescription | form | string | No | |
| PhysicalWarehouseResidingInRecID | form | string | No | |
| PhysicalWarehouseResidingInDescription | form | string | No | |
| LogicalWarehouseOrderingFromRecID | form | string | No | |
| LogicalWarehouseOrderingFromDescription | form | string | No | |
| PhysicalWarehouseOrderingFromRecID | form | string | No | |
| PhysicalWarehouseOrderingFromDescription | form | string | No | |
| InTransitLogicalWarehouseRecID | form | string | No | |
| InTransitLogicalWarehouseDescription | form | string | No | |
| InTransitPhysicalWarehouseRecID | form | string | No | |
| InTransitPhysicalWarehouseDescription | form | string | No | |
| OrderNo | form | string | No | |
| OrderDate | form | DateTime? | No | |
| Attention | form | string | No | |
| ContactBy | form | string | No | |
| StaffID | form | string | No | |
| StaffUserName | form | string | No | |
| StaffTitle | form | string | No | |
| StaffFirstName | form | string | No | |
| StaffSurname | form | string | No | |
| OrderStatus | form | Status? | No | |
| OrderType | form | PurchaseOrderType? | No | |
| OrderSupplierType | form | SupplierType? | No | |
| TaxTotal | form | decimal? | No | |
| UseInTransit | form | bool? | No | |
| Reference | form | string | No | |
| TotalGross | form | decimal? | No | |
| TotalNet | form | decimal? | No | |
| TotalFx | form | decimal? | No | |
| Notes | form | List<Note> | No | |
| Documents | form | List<Document> | No | |
| CustomFieldValues | form | List<CustomFieldValue> | No | |
| Lines | form | List<PurchaseOrderLine> | No | |
| ShippingAddressAddressLine1 | form | string | No | |
| ShippingAddressAddressLine2 | form | string | No | |
| ShippingAddressAddressLine3 | form | string | No | |
| ShippingAddressAddressLine4 | form | string | No | |
| ShippingAddressAddressLine5 | form | string | No | |
| ShippingAddressCountry | form | string | No | |
| ShippingAddressPostCode | form | string | No | |
| ShippingAddressContactName | form | string | No | |
| ShippingAddressPhone | form | string | No | |
| ShippingAddressFax | form | string | No | |
| ShippingAddressSpare1 | form | string | No | |
| ShippingAddressSpare2 | form | string | No | |
| ShippingAddressSpare3 | form | string | No | |
| ShippingAddressSpare4 | form | string | No | |
| ShippingAddressSpare5 | form | string | No | |
| Freight | form | decimal? | No | |
| Duty | form | decimal? | No | |
| Insurance | form | decimal? | No | |
| FreightTaxID | form | string | No | |
| FreightTaxRate | form | decimal? | No | |
| FreightTaxAmount | form | decimal? | No | |
| DutyTaxID | form | string | No | |
| DutyTaxRate | form | decimal? | No | |
| DutyTaxAmount | form | decimal? | No | |
| InsuranceTaxID | form | string | No | |
| InsuranceTaxRate | form | decimal? | No | |
| InsuranceTaxAmount | form | decimal? | No | |
| FreightInc | form | decimal? | No | |
| DutyInc | form | decimal? | No | |
| InsuranceInc | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| NoteID | form | string | No | |
| NoteType | form | NoteType | No | |
| LineNo | form | int? | No | |
| LastSavedDateTime | form | DateTime? | No | |
| LastModifiedByStaffID | form | string | No | |
| LastModifiedByStaffUsername | form | string | No | |
| LastModifiedByStaffTitle | form | string | No | |
| LastModifiedByStaffFirstName | form | string | No | |
| LastModifiedByStaffSurname | form | string | No | |
| NoteText | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| NoteTypeID | form | string | No | |
| Description | form | string | No | |
| DefaultType | form | bool? | No | |
| ItemNo | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentID | form | string | No | |
| DocumentType | form | DocumentType | No | |
| FileID | form | string | No | |
| PhysicalFileName | form | string | No | |
| FullPhysicalFileName | form | string | No | |
| Description | form | string | No | |
| LastSavedDateTime | form | DateTime? | No | |
| LastModifiedByStaffID | form | string | No | |
| LastModifiedByStaffUsername | form | string | No | |
| LastModifiedByStaffTitle | form | string | No | |
| LastModifiedByStaffFirstName | form | string | No | |
| LastModifiedByStaffSurname | form | string | No | |
| FileBinary | form | byte[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentTypeID | form | string | No | |
| Description | form | string | No | |
| DefaultType | form | bool? | No | |
| ItemNo | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SettingID | form | string | No | |
| SettingName | form | string | No | |
| Contents | form | string | No | |
| PluginID | form | string | No | |
| PluginName | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PurchaseOrderLineID | form | string | No | |
| ItemNo | form | int? | No | |
| InventoryID | form | string | No | |
| IsPhysical | form | bool? | No | |
| PartNo | form | string | No | |
| Description | form | string | No | |
| QuantityDecimalPlaces | form | int? | No | |
| MakeSupplierTheNewDefault | form | bool? | No | |
| PurchaseOrderLineType | form | OrderLineType? | No | |
| Quantity | form | decimal? | No | |
| IncPrice | form | decimal? | No | |
| TaxAmount | form | decimal? | No | |
| LineTotal | form | decimal? | No | |
| LineTotalExTax | form | decimal? | No | |
| FxTotal | form | decimal? | No | |
| CurrencyRateUsed | form | decimal? | No | |
| FXDecimalPlaces | form | int? | No | |
| HomeCurrencyDecimalPlaces | form | int? | No | |
| DeliveryDate | form | DateTime? | No | |
| Delivered | form | decimal? | No | |
| HistoryText_Comment | form | string | No | |
| JobCostingStageRecID | form | string | No | |
| JobCostingStageNo | form | string | No | |
| JobCostingStageName | form | string | No | |
| JobCostingStageClassificationRecID | form | string | No | |
| JobCostingStageClassificationDescription | form | string | No | |
| JobCostingCostCentreRecID | form | string | No | |
| JobCostingCostCentreNo | form | string | No | |
| JobCostingCostCentreName | form | string | No | |
| JobCostingJobRecID | form | string | No | |
| JobCostingJobNo | form | string | No | |
| JobCostingJobDescription | form | string | No | |
| IN_OnBackOrder_OrdersOnBackID | form | string | No | |
| IN_OnBackOrder_Quantity | form | decimal? | No | |
| IN_OnBackOrder_EstBOValue | form | decimal? | No | |
| IN_OnBackOrder_LastSavedDateTime | form | DateTime? | No | |
| InvoiceLineID | form | string | No | |
| UserDefinedFloat1 | form | decimal? | No | |
| UserDefinedFloat2 | form | decimal? | No | |
| UserDefinedFloat3 | form | decimal? | No | |
| UserDefinedDate1 | form | DateTime? | No | |
| UserDefinedDate2 | form | DateTime? | No | |
| UserDefinedDate3 | form | DateTime? | No | |
| UserDefinedString1 | form | string | No | |
| UserDefinedString2 | form | string | No | |
| UserDefinedString3 | form | string | No | |
| PurchasingClassificationRecID | form | string | No | |
| PurchasingClassificationDescription | form | string | No | |
| PurchasingClassificationLedgerAccountRecID | form | string | No | |
| PurchasingClassificationLedgerAccountAccountNo | form | string | No | |
| PurchasingClassificationLedgerAccountDescription | form | string | No | |
| ServiceManagerTaskRecID | form | string | No | |
| ServiceManagerTaskNo | form | int? | No | |
| ServiceManagerTaskDescription | form | string | No | |
| ServiceManagerJobRecID | form | string | No | |
| ServiceManagerJobNo | form | string | No | |
| ServiceManagerJobDescription | form | string | No | |
| IN_Creditor_RecID | form | string | No | |
| SupplierPartNo | form | string | No | |
| IN_SupplierWarehouse_RecID | form | string | No | |
| OrderUnits | form | decimal? | No | |
| DeliveryDays | form | int? | No | |
| FXCost | form | decimal? | No | |
| Cost | form | decimal? | No | |
| CostOriginal | form | decimal? | No | |
| Units | form | string | No | |
| TaxRateRecID | form | string | No | |
| TaxRateDescription | form | string | No | |
| TaxRate | form | decimal? | No | |
| TaxRateBASCode | form | int? | No | |
| InventoryExpectedLiabilityLedgerAccountRecID | form | string | No | |
| InventoryExpectedLiabilityLedgerAccountAccountNo | form | string | No | |
| InventoryExpectedLiabilityLedgerAccountDescription | form | string | No | |
| InventoryExpectedAssetLedgerAccountRecID | form | string | No | |
| InventoryExpectedAssetLedgerAccountAccountNo | form | string | No | |
| InventoryExpectedAssetLedgerAccountDescription | form | string | No | |
| ClassificationID | form | string | No | |
| ClassificationDescription | form | string | No | |
| CustomFieldValues | form | List<CustomFieldValue> | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /PurchaseOrders/Activate/{PurchaseOrderID} HTTP/1.1
Host: api.jiwa.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"PurchaseOrderID":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"PurchaseOrderID":"String","CreditorRecID":"String","CreditorAccountNo":"String","CreditorName":"String","CreditorWarehouseRecID":"String","CreditorWarehouseDescription":"String","LogicalWarehouseResidingInRecID":"String","LogicalWarehouseResidingInDescription":"String","PhysicalWarehouseResidingInRecID":"String","PhysicalWarehouseResidingInDescription":"String","LogicalWarehouseOrderingFromRecID":"String","LogicalWarehouseOrderingFromDescription":"String","PhysicalWarehouseOrderingFromRecID":"String","PhysicalWarehouseOrderingFromDescription":"String","InTransitLogicalWarehouseRecID":"String","InTransitLogicalWarehouseDescription":"String","InTransitPhysicalWarehouseRecID":"String","InTransitPhysicalWarehouseDescription":"String","OrderNo":"String","OrderDate":"0001-01-01T00:00:00.0000000","Attention":"String","ContactBy":"String","StaffID":"String","StaffUserName":"String","StaffTitle":"String","StaffFirstName":"String","StaffSurname":"String","OrderStatus":"NotSent","OrderType":"DefaultOrderType","OrderSupplierType":"Creditor","TaxTotal":0,"UseInTransit":false,"Reference":"String","TotalGross":0,"TotalNet":0,"TotalFx":0,"Notes":[{"NoteID":"String","NoteType":{"NoteTypeID":"String","Description":"String","DefaultType":false,"ItemNo":0},"LineNo":0,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastModifiedByStaffID":"String","LastModifiedByStaffUsername":"String","LastModifiedByStaffTitle":"String","LastModifiedByStaffFirstName":"String","LastModifiedByStaffSurname":"String","NoteText":"String"}],"Documents":[{"DocumentID":"String","DocumentType":{"DocumentTypeID":"String","Description":"String","DefaultType":false,"ItemNo":0},"FileID":"String","PhysicalFileName":"String","FullPhysicalFileName":"String","Description":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastModifiedByStaffID":"String","LastModifiedByStaffUsername":"String","LastModifiedByStaffTitle":"String","LastModifiedByStaffFirstName":"String","LastModifiedByStaffSurname":"String","FileBinary":"AA=="}],"CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}],"Lines":[{"PurchaseOrderLineID":"String","ItemNo":0,"InventoryID":"String","IsPhysical":false,"PartNo":"String","Description":"String","QuantityDecimalPlaces":0,"MakeSupplierTheNewDefault":false,"PurchaseOrderLineType":"Unknown","Quantity":0,"IncPrice":0,"TaxAmount":0,"LineTotal":0,"LineTotalExTax":0,"FxTotal":0,"CurrencyRateUsed":0,"FXDecimalPlaces":0,"HomeCurrencyDecimalPlaces":0,"DeliveryDate":"0001-01-01T00:00:00.0000000","Delivered":0,"HistoryText_Comment":"String","JobCostingStageRecID":"String","JobCostingStageNo":"String","JobCostingStageName":"String","JobCostingStageClassificationRecID":"String","JobCostingStageClassificationDescription":"String","JobCostingCostCentreRecID":"String","JobCostingCostCentreNo":"String","JobCostingCostCentreName":"String","JobCostingJobRecID":"String","JobCostingJobNo":"String","JobCostingJobDescription":"String","IN_OnBackOrder_OrdersOnBackID":"String","IN_OnBackOrder_Quantity":0,"IN_OnBackOrder_EstBOValue":0,"IN_OnBackOrder_LastSavedDateTime":"0001-01-01T00:00:00.0000000","InvoiceLineID":"String","UserDefinedFloat1":0,"UserDefinedFloat2":0,"UserDefinedFloat3":0,"UserDefinedDate1":"0001-01-01T00:00:00.0000000","UserDefinedDate2":"0001-01-01T00:00:00.0000000","UserDefinedDate3":"0001-01-01T00:00:00.0000000","UserDefinedString1":"String","UserDefinedString2":"String","UserDefinedString3":"String","PurchasingClassificationRecID":"String","PurchasingClassificationDescription":"String","PurchasingClassificationLedgerAccountRecID":"String","PurchasingClassificationLedgerAccountAccountNo":"String","PurchasingClassificationLedgerAccountDescription":"String","ServiceManagerTaskRecID":"String","ServiceManagerTaskNo":0,"ServiceManagerTaskDescription":"String","ServiceManagerJobRecID":"String","ServiceManagerJobNo":"String","ServiceManagerJobDescription":"String","IN_Creditor_RecID":"String","SupplierPartNo":"String","IN_SupplierWarehouse_RecID":"String","OrderUnits":0,"DeliveryDays":0,"FXCost":0,"Cost":0,"CostOriginal":0,"Units":"String","TaxRateRecID":"String","TaxRateDescription":"String","TaxRate":0,"TaxRateBASCode":0,"InventoryExpectedLiabilityLedgerAccountRecID":"String","InventoryExpectedLiabilityLedgerAccountAccountNo":"String","InventoryExpectedLiabilityLedgerAccountDescription":"String","InventoryExpectedAssetLedgerAccountRecID":"String","InventoryExpectedAssetLedgerAccountAccountNo":"String","InventoryExpectedAssetLedgerAccountDescription":"String","ClassificationID":"String","ClassificationDescription":"String","CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}]}],"ShippingAddressAddressLine1":"String","ShippingAddressAddressLine2":"String","ShippingAddressAddressLine3":"String","ShippingAddressAddressLine4":"String","ShippingAddressAddressLine5":"String","ShippingAddressCountry":"String","ShippingAddressPostCode":"String","ShippingAddressContactName":"String","ShippingAddressPhone":"String","ShippingAddressFax":"String","ShippingAddressSpare1":"String","ShippingAddressSpare2":"String","ShippingAddressSpare3":"String","ShippingAddressSpare4":"String","ShippingAddressSpare5":"String","Freight":0,"Duty":0,"Insurance":0,"FreightTaxID":"String","FreightTaxRate":0,"FreightTaxAmount":0,"DutyTaxID":"String","DutyTaxRate":0,"DutyTaxAmount":0,"InsuranceTaxID":"String","InsuranceTaxRate":0,"InsuranceTaxAmount":0,"FreightInc":0,"DutyInc":0,"InsuranceInc":0}