JiwaAPI

<back to all web services

SupplierReturnCreditGETRequest

Requires Authentication
The following routes are available for this service:
GET/SupplierReturns/Credit/{CreditID}Retrieves a supplier return credit.
SupplierReturnCreditGETRequest Parameters:
NameParameterData TypeRequiredDescription
CreditIDpathstringNo
Credit Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
CreditNoformstringNo
CreditorRefformstringNo
StatusformCreditStatuses?No
LastSavedDateTimeformDateTime?No
CreatedByformStaffMemberNo
CreditDateformDateTime?No
CreditorIDformstringNo
CreditorAccountNoformstringNo
CreditorNameformstringNo
RowHashformbyte[]No
DocumentsformList<Document>No
NotesformList<Note>No
CustomFieldValuesformList<CustomFieldValue>No
LinesformList<Line>No
ShippingsformList<ShippingEntity>No
PurchaseOrdersformList<PurchaseOrder>No
StaffMember Parameters:
NameParameterData TypeRequiredDescription
StaffIDformstringNo
TitleformstringNo
FirstNameformstringNo
SurnameformstringNo
UsernameformstringNo
IsActiveformbool?No
IsEnabledformbool?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
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
CustomFieldValue Parameters:
NameParameterData TypeRequiredDescription
SettingIDformstringNo
SettingNameformstringNo
ContentsformstringNo
PluginIDformstringNo
PluginNameformstringNo
Line Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
ItemNoformint?No
LastSavedDateTimeformDateTime?No
RowHashformbyte[]No
InventoryIDformstringNo
PartNoformstringNo
DescriptionformstringNo
DecimalPlacesformshort?No
Quantityformdecimal?No
RemarkformstringNo
UnitCreditValueformdecimal?No
TotalCreditValueformdecimal?No
TaxAmountformdecimal?No
FXUnitCreditValueformdecimal?No
FXTotalCreditValueformdecimal?No
FXRateformdecimal?No
TaxRateIDformstringNo
TaxRateDescriptionformstringNo
TaxRateformdecimal?No
ReturnCodeformReturnCodeNo
CustomFieldValuesformList<CustomFieldValue>No
LineDetailsformList<InventorySOHLineDetail>No
PurchaseOrderLineIDformstringNo
ShippingLineIDformstringNo
IsCompletedformbool?No
ReturnCode Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
CodeformstringNo
DescriptionformstringNo
IsDefaultformbool?No
ReturnTypeformReturnTypes?No
InventorySOHLineDetail Parameters:
NameParameterData TypeRequiredDescription
IN_SOH_LinkIDformstringNo
Costformdecimal?No
DateInformDateTime?No
ExpiryDateformDateTime?No
SpecialPriceformdecimal?No
Quantityformdecimal?No
QuantityInformdecimal?No
QuantityLeftformdecimal?No
QuantityAllocatedformdecimal?No
LineDetailIDformstringNo
SerialNoformstringNo
IN_LogicalIDformstringNo
RefformstringNo
HistoryTextformstringNo
SourceIDformstringNo
BinLocationformInventoryBinLocationNo
InventoryBinLocation Parameters:
NameParameterData TypeRequiredDescription
BinLocationIDformstringNo
LogicalWarehouseIDformstringNo
LogicalWarehouseDescriptionformstringNo
PhysicalWarehouseIDformstringNo
PhysicalWarehouseDescriptionformstringNo
DescriptionformstringNo
ShortNameformstringNo
ItemNoformint?No
IsDefaultformbool?No
CustomFieldValuesformList<CustomFieldValue>No
ShippingEntity Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
ShippingNoformstringNo
RANumberformstringNo
ReferenceformstringNo
StatusformShippingEntityStatuses?No
ReturnCodeformReturnCodeNo
CreditorIDformstringNo
CreditorAccountNoformstringNo
CreditorNameformstringNo
ShippingDateformDateTime?No
PurchaseOrder Parameters:
NameParameterData TypeRequiredDescription
PurchaseOrderIDformstringNo
CreditorRecIDformstringNo
CreditorAccountNoformstringNo
CreditorNameformstringNo
CreditorWarehouseRecIDformstringNo
CreditorWarehouseDescriptionformstringNo
LogicalWarehouseResidingInRecIDformstringNo
LogicalWarehouseResidingInDescriptionformstringNo
PhysicalWarehouseResidingInRecIDformstringNo
PhysicalWarehouseResidingInDescriptionformstringNo
LogicalWarehouseOrderingFromRecIDformstringNo
LogicalWarehouseOrderingFromDescriptionformstringNo
PhysicalWarehouseOrderingFromRecIDformstringNo
PhysicalWarehouseOrderingFromDescriptionformstringNo
InTransitLogicalWarehouseRecIDformstringNo
InTransitLogicalWarehouseDescriptionformstringNo
InTransitPhysicalWarehouseRecIDformstringNo
InTransitPhysicalWarehouseDescriptionformstringNo
OrderNoformstringNo
OrderDateformDateTime?No
AttentionformstringNo
ContactByformstringNo
StaffIDformstringNo
StaffUserNameformstringNo
StaffTitleformstringNo
StaffFirstNameformstringNo
StaffSurnameformstringNo
OrderStatusformStatus?No
OrderTypeformPurchaseOrderType?No
OrderSupplierTypeformSupplierType?No
TaxTotalformdecimal?No
UseInTransitformbool?No
ReferenceformstringNo
TotalGrossformdecimal?No
TotalNetformdecimal?No
TotalFxformdecimal?No
NotesformList<Note>No
DocumentsformList<Document>No
CustomFieldValuesformList<CustomFieldValue>No
LinesformList<PurchaseOrderLine>No
ShippingAddressAddressLine1formstringNo
ShippingAddressAddressLine2formstringNo
ShippingAddressAddressLine3formstringNo
ShippingAddressAddressLine4formstringNo
ShippingAddressAddressLine5formstringNo
ShippingAddressCountryformstringNo
ShippingAddressPostCodeformstringNo
ShippingAddressContactNameformstringNo
ShippingAddressPhoneformstringNo
ShippingAddressFaxformstringNo
ShippingAddressSpare1formstringNo
ShippingAddressSpare2formstringNo
ShippingAddressSpare3formstringNo
ShippingAddressSpare4formstringNo
ShippingAddressSpare5formstringNo
Freightformdecimal?No
Dutyformdecimal?No
Insuranceformdecimal?No
FreightTaxIDformstringNo
FreightTaxRateformdecimal?No
FreightTaxAmountformdecimal?No
DutyTaxIDformstringNo
DutyTaxRateformdecimal?No
DutyTaxAmountformdecimal?No
InsuranceTaxIDformstringNo
InsuranceTaxRateformdecimal?No
InsuranceTaxAmountformdecimal?No
FreightIncformdecimal?No
DutyIncformdecimal?No
InsuranceIncformdecimal?No
PurchaseOrderLine Parameters:
NameParameterData TypeRequiredDescription
PurchaseOrderLineIDformstringNo
ItemNoformint?No
InventoryIDformstringNo
IsPhysicalformbool?No
PartNoformstringNo
DescriptionformstringNo
QuantityDecimalPlacesformint?No
MakeSupplierTheNewDefaultformbool?No
PurchaseOrderLineTypeformOrderLineType?No
Quantityformdecimal?No
IncPriceformdecimal?No
TaxAmountformdecimal?No
LineTotalformdecimal?No
LineTotalExTaxformdecimal?No
FxTotalformdecimal?No
CurrencyRateUsedformdecimal?No
FXDecimalPlacesformint?No
HomeCurrencyDecimalPlacesformint?No
DeliveryDateformDateTime?No
Deliveredformdecimal?No
HistoryText_CommentformstringNo
JobCostingStageRecIDformstringNo
JobCostingStageNoformstringNo
JobCostingStageNameformstringNo
JobCostingStageClassificationRecIDformstringNo
JobCostingStageClassificationDescriptionformstringNo
JobCostingCostCentreRecIDformstringNo
JobCostingCostCentreNoformstringNo
JobCostingCostCentreNameformstringNo
JobCostingJobRecIDformstringNo
JobCostingJobNoformstringNo
JobCostingJobDescriptionformstringNo
IN_OnBackOrder_OrdersOnBackIDformstringNo
IN_OnBackOrder_Quantityformdecimal?No
IN_OnBackOrder_EstBOValueformdecimal?No
IN_OnBackOrder_LastSavedDateTimeformDateTime?No
InvoiceLineIDformstringNo
UserDefinedFloat1formdecimal?No
UserDefinedFloat2formdecimal?No
UserDefinedFloat3formdecimal?No
UserDefinedDate1formDateTime?No
UserDefinedDate2formDateTime?No
UserDefinedDate3formDateTime?No
UserDefinedString1formstringNo
UserDefinedString2formstringNo
UserDefinedString3formstringNo
PurchasingClassificationRecIDformstringNo
PurchasingClassificationDescriptionformstringNo
PurchasingClassificationLedgerAccountRecIDformstringNo
PurchasingClassificationLedgerAccountAccountNoformstringNo
PurchasingClassificationLedgerAccountDescriptionformstringNo
ServiceManagerTaskRecIDformstringNo
ServiceManagerTaskNoformint?No
ServiceManagerTaskDescriptionformstringNo
ServiceManagerJobRecIDformstringNo
ServiceManagerJobNoformstringNo
ServiceManagerJobDescriptionformstringNo
IN_Creditor_RecIDformstringNo
SupplierPartNoformstringNo
IN_SupplierWarehouse_RecIDformstringNo
OrderUnitsformdecimal?No
DeliveryDaysformint?No
FXCostformdecimal?No
Costformdecimal?No
CostOriginalformdecimal?No
UnitsformstringNo
TaxRateRecIDformstringNo
TaxRateDescriptionformstringNo
TaxRateformdecimal?No
TaxRateBASCodeformint?No
InventoryExpectedLiabilityLedgerAccountRecIDformstringNo
InventoryExpectedLiabilityLedgerAccountAccountNoformstringNo
InventoryExpectedLiabilityLedgerAccountDescriptionformstringNo
InventoryExpectedAssetLedgerAccountRecIDformstringNo
InventoryExpectedAssetLedgerAccountAccountNoformstringNo
InventoryExpectedAssetLedgerAccountDescriptionformstringNo
ClassificationIDformstringNo
ClassificationDescriptionformstringNo
CustomFieldValuesformList<CustomFieldValue>No

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.

GET /SupplierReturns/Credit/{CreditID} HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"RecID":"String","CreditNo":"String","CreditorRef":"String","Status":"Open","LastSavedDateTime":"0001-01-01T00:00:00.0000000","CreatedBy":{"StaffID":"String","Title":"String","FirstName":"String","Surname":"String","Username":"String","IsActive":false,"IsEnabled":false},"CreditDate":"0001-01-01T00:00:00.0000000","CreditorID":"String","CreditorAccountNo":"String","CreditorName":"String","RowHash":"AA==","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=="}],"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"}],"CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}],"Lines":[{"RecID":"String","ItemNo":0,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","RowHash":"AA==","InventoryID":"String","PartNo":"String","Description":"String","DecimalPlaces":0,"Quantity":0,"Remark":"String","UnitCreditValue":0,"TotalCreditValue":0,"TaxAmount":0,"FXUnitCreditValue":0,"FXTotalCreditValue":0,"FXRate":0,"TaxRateID":"String","TaxRateDescription":"String","TaxRate":0,"ReturnCode":{"RecID":"String","Code":"String","Description":"String","IsDefault":false,"ReturnType":"Return"},"CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}],"LineDetails":[{"IN_SOH_LinkID":"String","Cost":0,"DateIn":"0001-01-01T00:00:00.0000000","ExpiryDate":"0001-01-01T00:00:00.0000000","SpecialPrice":0,"Quantity":0,"QuantityIn":0,"QuantityLeft":0,"QuantityAllocated":0,"LineDetailID":"String","SerialNo":"String","IN_LogicalID":"String","Ref":"String","HistoryText":"String","SourceID":"String","BinLocation":{"BinLocationID":"String","LogicalWarehouseID":"String","LogicalWarehouseDescription":"String","PhysicalWarehouseID":"String","PhysicalWarehouseDescription":"String","Description":"String","ShortName":"String","ItemNo":0,"IsDefault":false,"CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"String"}]}}],"PurchaseOrderLineID":"String","ShippingLineID":"String","IsCompleted":false}],"Shippings":[{"RecID":"String","ShippingNo":"String","RANumber":"String","Reference":"String","Status":"Open","ReturnCode":{"RecID":"String","Code":"String","Description":"String","IsDefault":false,"ReturnType":"Return"},"CreditorID":"String","CreditorAccountNo":"String","CreditorName":"String","ShippingDate":"0001-01-01T00:00:00.0000000"}],"PurchaseOrders":[{"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}]}