HTTP + CSV
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
POST /PurchaseOrders/ HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"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}
HTTP/1.1 200 OK
Content-Type: text/csv
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}