JiwaAPI

<back to all web services

PurchaseInvoicePATCHRequest

Requires Authentication
The following routes are available for this service:
PATCH/PurchaseInvoices/{PurchaseInvoiceID}Updates a purchase invoice.
PurchaseInvoicePATCHRequest Parameters:
NameParameterData TypeRequiredDescription
PurchaseInvoiceIDpathstringNo
PurchaseInvoice Parameters:
NameParameterData TypeRequiredDescription
PurchaseInvoiceIDformstringNo
CreditorIDformstringNo
CreditorAccountNoformstringNo
CreditorNameformstringNo
LastSavedDateTimeformDateTime?No
InvoiceNoformstringNo
InvoiceDateformDateTime?No
StatusformStatuses?No
Freightformdecimal?No
Dutyformdecimal?No
Insuranceformdecimal?No
TaxTotalformdecimal?No
FreightTaxIDformstringNo
FreightTaxRateformdecimal?No
FreightTaxAmountformdecimal?No
DutyTaxIDformstringNo
DutyTaxRateformdecimal?No
DutyTaxAmountformdecimal?No
InsuranceTaxIDformstringNo
InsuranceTaxRateformdecimal?No
InsuranceTaxAmountformdecimal?No
LinesformList<PurchaseInvoiceLine>No
GoodsReceivedNotesformList<PurchaseInvoiceGoodsReceivedNoteInvoiced>No
TotalGrossformdecimal?No
TotalNetformdecimal?No
TotalFxformdecimal?No
FreightIncformdecimal?No
DutyIncformdecimal?No
InsuranceIncformdecimal?No
HomeDecimalPlacesformint?No
FXDecimalPlacesformint?No
TaxAdjustmentformdecimal?No
DueDateformDateTime?No
CurrencyIDformstringNo
TotalNetOnInventoryReceivalsformdecimal?No
CustomFieldValuesformList<CustomFieldValue>No
NotesformList<Note>No
DocumentsformList<Document>No
LogicalWarehouseIDformstringNo
LogicalWarehouseDescriptionformstringNo
PhysicalWarehouseIDformstringNo
PhysicalWarehouseDescriptionformstringNo
PurchaseInvoiceLine Parameters:
NameParameterData TypeRequiredDescription
PurchaseInvoiceLineIDformstringNo
Quantityformdecimal?No
InventoryIDformstringNo
PartNoformstringNo
Aux2formstringNo
DescriptionformstringNo
SupplierPartNoformstringNo
PurchaseInvoiceLineTypeformInvoiceLineType?No
QuantityDecimalPlacesformint?No
LastSavedDateTimeformDateTime?No
TaxAmountformdecimal?No
TaxIDformstringNo
TaxRateformdecimal?No
Costformdecimal?No
CurrencyRateUsedformdecimal?No
PurchasingClassificationIDformstringNo
PurchasingClassificationDescriptionformstringNo
LineDetailsformList<PurchaseInvoiceLineDetail>No
UseSerialNoformbool?No
FXCostformdecimal?No
PhysicalItemformbool?No
InventoryExpectedLiability_LedgerAccountIDformstringNo
InventoryExpectedLiability_LedgerAccountNoformstringNo
InventoryExpectedLiability_LedgerAccountDescriptionformstringNo
InventoryExpectedAsset_LedgerAccountIDformstringNo
InventoryExpectedAsset_LedgerAccountNoformstringNo
InventoryExpectedAsset_LedgerAccountDescriptionformstringNo
InventoryDeliveredAsset_LedgerAccountIDformstringNo
InventoryDeliveredAsset_LedgerAccountNoformstringNo
InventoryDeliveredAsset_LedgerAccountDescriptionformstringNo
InventoryValue_LedgerAccountIDformstringNo
InventoryValue_LedgerAccountNoformstringNo
InventoryValue_LedgerAccountDescriptionformstringNo
InventoryDeliveredLiability_LedgerAccountIDformstringNo
InventoryDeliveredLiability_LedgerAccountNoformstringNo
InventoryDeliveredLiability_LedgerAccountDescriptionformstringNo
InventoryCreditorPurchases_LedgerAccountIDformstringNo
InventoryCreditorPurchases_LedgerAccountNoformstringNo
InventoryCreditorPurchases_LedgerAccountDescriptionformstringNo
InventoryCostOfGoodsVariance_LedgerAccountIDformstringNo
InventoryCostOfGoodsVariance_LedgerAccountNoformstringNo
InventoryCostOfGoodsVariance_LedgerAccountDescriptionformstringNo
InventoryStockMovement_LedgerAccountIDformstringNo
InventoryStockMovement_LedgerAccountNoformstringNo
InventoryStockMovement_LedgerAccountDescriptionformstringNo
InventoryLastSavedDateTimeformDateTime?No
OrderUnitsformdecimal?No
ItemNoformint?No
IN_SupplierWarehouse_RecIDformstringNo
IncPriceformdecimal?No
LineTotalformdecimal?No
FXTotalformdecimal?No
FXDecimalPlacesformint?No
HomeDecimalPlacesformint?No
UseExpiryDateformbool?No
PostedToWIPformbool?No
JobCostingStageIDformstringNo
JobCostingStageNoformstringNo
JobCostingStageNameformstringNo
JobCostingCostCentreIDformstringNo
JobCostingCostCentreNoformstringNo
JobCostingCostCentreNameformstringNo
JobCostingJobIDformstringNo
JobCostingJobNoformstringNo
OrderNoformstringNo
OrderIDformstringNo
PurchaseOrderLineNoformint?No
PurchaseOrderTypeformPurchaseOrderType?No
CustomFieldValuesformList<CustomFieldValue>No
LineTotalExTaxformdecimal?No
RE_Lines_SourceIDformstringNo
PurchaseInvoiceLineDetail Parameters:
NameParameterData TypeRequiredDescription
LineDetailIDformstringNo
LinkIDformstringNo
Quantityformdecimal?No
LastSavedDateTimeformDateTime?No
SerialNoformstringNo
BinLocationIDformstringNo
BinLocationDescriptionformstringNo
ExpiryDateformDateTime?No
RE_LineDetails_RecIDformstringNo
CustomFieldValue Parameters:
NameParameterData TypeRequiredDescription
SettingIDformstringNo
SettingNameformstringNo
ContentsformstringNo
PluginIDformstringNo
PluginNameformstringNo
PurchaseInvoiceGoodsReceivedNoteInvoiced Parameters:
NameParameterData TypeRequiredDescription
GoodsReceivedNoteInvoicedIDformstringNo
GRNIDformstringNo
SlipNoformstringNo
ReceivedDateformDateTime?No
FreightTaxIDformstringNo
Freightformdecimal?No
FreightTaxAmountformdecimal?No
DutyTaxIDformstringNo
Dutyformdecimal?No
DutyTaxAmountformdecimal?No
InsuranceTaxIDformstringNo
Insuranceformdecimal?No
InsuranceTaxAmountformdecimal?No
RE_Main_LastSavedDateTimeformDateTime?No
Note Parameters:
NameParameterData TypeRequiredDescription
NoteIDformstringNo
NoteTypeformNoteTypeNo
LineNoformint?No
LastSavedDateTimeformDateTime?No
LastModifiedByStaffIDformstringNo
LastModifiedByStaffUsernameformstringNo
LastModifiedByStaffTitleformstringNo
LastModifiedByStaffFirstNameformstringNo
LastModifiedByStaffSurnameformstringNo
NoteTextformstringNo
NoteType Parameters:
NameParameterData TypeRequiredDescription
NoteTypeIDformstringNo
DescriptionformstringNo
DefaultTypeformbool?No
ItemNoformint?No
Document Parameters:
NameParameterData TypeRequiredDescription
DocumentIDformstringNo
DocumentTypeformDocumentTypeNo
FileIDformstringNo
PhysicalFileNameformstringNo
FullPhysicalFileNameformstringNo
DescriptionformstringNo
LastSavedDateTimeformDateTime?No
LastModifiedByStaffIDformstringNo
LastModifiedByStaffUsernameformstringNo
LastModifiedByStaffTitleformstringNo
LastModifiedByStaffFirstNameformstringNo
LastModifiedByStaffSurnameformstringNo
FileBinaryformbyte[]No
DocumentType Parameters:
NameParameterData TypeRequiredDescription
DocumentTypeIDformstringNo
DescriptionformstringNo
DefaultTypeformbool?No
ItemNoformint?No
PurchaseInvoice Parameters:
NameParameterData TypeRequiredDescription
PurchaseInvoiceIDformstringNo
CreditorIDformstringNo
CreditorAccountNoformstringNo
CreditorNameformstringNo
LastSavedDateTimeformDateTime?No
InvoiceNoformstringNo
InvoiceDateformDateTime?No
StatusformStatuses?No
Freightformdecimal?No
Dutyformdecimal?No
Insuranceformdecimal?No
TaxTotalformdecimal?No
FreightTaxIDformstringNo
FreightTaxRateformdecimal?No
FreightTaxAmountformdecimal?No
DutyTaxIDformstringNo
DutyTaxRateformdecimal?No
DutyTaxAmountformdecimal?No
InsuranceTaxIDformstringNo
InsuranceTaxRateformdecimal?No
InsuranceTaxAmountformdecimal?No
LinesformList<PurchaseInvoiceLine>No
GoodsReceivedNotesformList<PurchaseInvoiceGoodsReceivedNoteInvoiced>No
TotalGrossformdecimal?No
TotalNetformdecimal?No
TotalFxformdecimal?No
FreightIncformdecimal?No
DutyIncformdecimal?No
InsuranceIncformdecimal?No
HomeDecimalPlacesformint?No
FXDecimalPlacesformint?No
TaxAdjustmentformdecimal?No
DueDateformDateTime?No
CurrencyIDformstringNo
TotalNetOnInventoryReceivalsformdecimal?No
CustomFieldValuesformList<CustomFieldValue>No
NotesformList<Note>No
DocumentsformList<Document>No
LogicalWarehouseIDformstringNo
LogicalWarehouseDescriptionformstringNo
PhysicalWarehouseIDformstringNo
PhysicalWarehouseDescriptionformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PATCH /PurchaseInvoices/{PurchaseInvoiceID} HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"PurchaseInvoiceID":"String","CreditorID":"String","CreditorAccountNo":"String","CreditorName":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","InvoiceNo":"String","InvoiceDate":"0001-01-01T00:00:00.0000000","Status":"UnActivated","Freight":0,"Duty":0,"Insurance":0,"TaxTotal":0,"FreightTaxID":"String","FreightTaxRate":0,"FreightTaxAmount":0,"DutyTaxID":"String","DutyTaxRate":0,"DutyTaxAmount":0,"InsuranceTaxID":"String","InsuranceTaxRate":0,"InsuranceTaxAmount":0,"Lines":[{"PurchaseInvoiceLineID":"String","Quantity":0,"InventoryID":"String","PartNo":"String","Aux2":"String","Description":"String","SupplierPartNo":"String","PurchaseInvoiceLineType":"0","QuantityDecimalPlaces":0,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","TaxAmount":0,"TaxID":"String","TaxRate":0,"Cost":0,"CurrencyRateUsed":0,"PurchasingClassificationID":"String","PurchasingClassificationDescription":"String","LineDetails":[{"LineDetailID":"String","LinkID":"String","Quantity":0,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","SerialNo":"String","BinLocationID":"String","BinLocationDescription":"String","ExpiryDate":"0001-01-01T00:00:00.0000000","RE_LineDetails_RecID":"String"}],"UseSerialNo":false,"FXCost":0,"PhysicalItem":false,"InventoryExpectedLiability_LedgerAccountID":"String","InventoryExpectedLiability_LedgerAccountNo":"String","InventoryExpectedLiability_LedgerAccountDescription":"String","InventoryExpectedAsset_LedgerAccountID":"String","InventoryExpectedAsset_LedgerAccountNo":"String","InventoryExpectedAsset_LedgerAccountDescription":"String","InventoryDeliveredAsset_LedgerAccountID":"String","InventoryDeliveredAsset_LedgerAccountNo":"String","InventoryDeliveredAsset_LedgerAccountDescription":"String","InventoryValue_LedgerAccountID":"String","InventoryValue_LedgerAccountNo":"String","InventoryValue_LedgerAccountDescription":"String","InventoryDeliveredLiability_LedgerAccountID":"String","InventoryDeliveredLiability_LedgerAccountNo":"String","InventoryDeliveredLiability_LedgerAccountDescription":"String","InventoryCreditorPurchases_LedgerAccountID":"String","InventoryCreditorPurchases_LedgerAccountNo":"String","InventoryCreditorPurchases_LedgerAccountDescription":"String","InventoryCostOfGoodsVariance_LedgerAccountID":"String","InventoryCostOfGoodsVariance_LedgerAccountNo":"String","InventoryCostOfGoodsVariance_LedgerAccountDescription":"String","InventoryStockMovement_LedgerAccountID":"String","InventoryStockMovement_LedgerAccountNo":"String","InventoryStockMovement_LedgerAccountDescription":"String","InventoryLastSavedDateTime":"0001-01-01T00:00:00.0000000","OrderUnits":0,"ItemNo":0,"IN_SupplierWarehouse_RecID":"String","IncPrice":0,"LineTotal":0,"FXTotal":0,"FXDecimalPlaces":0,"HomeDecimalPlaces":0,"UseExpiryDate":false,"PostedToWIP":false,"JobCostingStageID":"String","JobCostingStageNo":"String","JobCostingStageName":"String","JobCostingCostCentreID":"String","JobCostingCostCentreNo":"String","JobCostingCostCentreName":"String","JobCostingJobID":"String","JobCostingJobNo":"String","OrderNo":"String","OrderID":"String","PurchaseOrderLineNo":0,"PurchaseOrderType":"DefaultOrderType","CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}],"LineTotalExTax":0,"RE_Lines_SourceID":"String"}],"GoodsReceivedNotes":[{"GoodsReceivedNoteInvoicedID":"String","GRNID":"String","SlipNo":"String","ReceivedDate":"0001-01-01T00:00:00.0000000","FreightTaxID":"String","Freight":0,"FreightTaxAmount":0,"DutyTaxID":"String","Duty":0,"DutyTaxAmount":0,"InsuranceTaxID":"String","Insurance":0,"InsuranceTaxAmount":0,"RE_Main_LastSavedDateTime":"0001-01-01T00:00:00.0000000"}],"TotalGross":0,"TotalNet":0,"TotalFx":0,"FreightInc":0,"DutyInc":0,"InsuranceInc":0,"HomeDecimalPlaces":0,"FXDecimalPlaces":0,"TaxAdjustment":0,"DueDate":"0001-01-01T00:00:00.0000000","CurrencyID":"String","TotalNetOnInventoryReceivals":0,"CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}],"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=="}],"LogicalWarehouseID":"String","LogicalWarehouseDescription":"String","PhysicalWarehouseID":"String","PhysicalWarehouseDescription":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"PurchaseInvoiceID":"String","CreditorID":"String","CreditorAccountNo":"String","CreditorName":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","InvoiceNo":"String","InvoiceDate":"0001-01-01T00:00:00.0000000","Status":"UnActivated","Freight":0,"Duty":0,"Insurance":0,"TaxTotal":0,"FreightTaxID":"String","FreightTaxRate":0,"FreightTaxAmount":0,"DutyTaxID":"String","DutyTaxRate":0,"DutyTaxAmount":0,"InsuranceTaxID":"String","InsuranceTaxRate":0,"InsuranceTaxAmount":0,"Lines":[{"PurchaseInvoiceLineID":"String","Quantity":0,"InventoryID":"String","PartNo":"String","Aux2":"String","Description":"String","SupplierPartNo":"String","PurchaseInvoiceLineType":"0","QuantityDecimalPlaces":0,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","TaxAmount":0,"TaxID":"String","TaxRate":0,"Cost":0,"CurrencyRateUsed":0,"PurchasingClassificationID":"String","PurchasingClassificationDescription":"String","LineDetails":[{"LineDetailID":"String","LinkID":"String","Quantity":0,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","SerialNo":"String","BinLocationID":"String","BinLocationDescription":"String","ExpiryDate":"0001-01-01T00:00:00.0000000","RE_LineDetails_RecID":"String"}],"UseSerialNo":false,"FXCost":0,"PhysicalItem":false,"InventoryExpectedLiability_LedgerAccountID":"String","InventoryExpectedLiability_LedgerAccountNo":"String","InventoryExpectedLiability_LedgerAccountDescription":"String","InventoryExpectedAsset_LedgerAccountID":"String","InventoryExpectedAsset_LedgerAccountNo":"String","InventoryExpectedAsset_LedgerAccountDescription":"String","InventoryDeliveredAsset_LedgerAccountID":"String","InventoryDeliveredAsset_LedgerAccountNo":"String","InventoryDeliveredAsset_LedgerAccountDescription":"String","InventoryValue_LedgerAccountID":"String","InventoryValue_LedgerAccountNo":"String","InventoryValue_LedgerAccountDescription":"String","InventoryDeliveredLiability_LedgerAccountID":"String","InventoryDeliveredLiability_LedgerAccountNo":"String","InventoryDeliveredLiability_LedgerAccountDescription":"String","InventoryCreditorPurchases_LedgerAccountID":"String","InventoryCreditorPurchases_LedgerAccountNo":"String","InventoryCreditorPurchases_LedgerAccountDescription":"String","InventoryCostOfGoodsVariance_LedgerAccountID":"String","InventoryCostOfGoodsVariance_LedgerAccountNo":"String","InventoryCostOfGoodsVariance_LedgerAccountDescription":"String","InventoryStockMovement_LedgerAccountID":"String","InventoryStockMovement_LedgerAccountNo":"String","InventoryStockMovement_LedgerAccountDescription":"String","InventoryLastSavedDateTime":"0001-01-01T00:00:00.0000000","OrderUnits":0,"ItemNo":0,"IN_SupplierWarehouse_RecID":"String","IncPrice":0,"LineTotal":0,"FXTotal":0,"FXDecimalPlaces":0,"HomeDecimalPlaces":0,"UseExpiryDate":false,"PostedToWIP":false,"JobCostingStageID":"String","JobCostingStageNo":"String","JobCostingStageName":"String","JobCostingCostCentreID":"String","JobCostingCostCentreNo":"String","JobCostingCostCentreName":"String","JobCostingJobID":"String","JobCostingJobNo":"String","OrderNo":"String","OrderID":"String","PurchaseOrderLineNo":0,"PurchaseOrderType":"DefaultOrderType","CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}],"LineTotalExTax":0,"RE_Lines_SourceID":"String"}],"GoodsReceivedNotes":[{"GoodsReceivedNoteInvoicedID":"String","GRNID":"String","SlipNo":"String","ReceivedDate":"0001-01-01T00:00:00.0000000","FreightTaxID":"String","Freight":0,"FreightTaxAmount":0,"DutyTaxID":"String","Duty":0,"DutyTaxAmount":0,"InsuranceTaxID":"String","Insurance":0,"InsuranceTaxAmount":0,"RE_Main_LastSavedDateTime":"0001-01-01T00:00:00.0000000"}],"TotalGross":0,"TotalNet":0,"TotalFx":0,"FreightInc":0,"DutyInc":0,"InsuranceInc":0,"HomeDecimalPlaces":0,"FXDecimalPlaces":0,"TaxAdjustment":0,"DueDate":"0001-01-01T00:00:00.0000000","CurrencyID":"String","TotalNetOnInventoryReceivals":0,"CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}],"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=="}],"LogicalWarehouseID":"String","LogicalWarehouseDescription":"String","PhysicalWarehouseID":"String","PhysicalWarehouseDescription":"String"}