HTTP + CSV
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
PATCH /Debtors/{DebtorID} HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"DebtorID":"String","CreditLimit":0,"EarlyPaymentDiscountDays":0,"EarlyPaymentDiscountAmount":0,"LastPurchaseDate":"0001-01-01T00:00:00.0000000","LastPaymentDate":"0001-01-01T00:00:00.0000000","StandingDiscountOnInvoices":0,"AccountOnHold":false,"CurrentBalance":0,"Period1Balance":0,"Period2Balance":0,"Period3Balance":0,"Period4Balance":0,"FXCurrentBalance":0,"FXPeriod1Balance":0,"FXPeriod2Balance":0,"FXPeriod3Balance":0,"FXPeriod4Balance":0,"NotifyRequired":false,"WebAccess":false,"CommenceDate":"0001-01-01T00:00:00.0000000","TradingStatus":"e_DebtorTradingStatusInActive","PeriodType":"Weekly","UsesFX":false,"IsCashOnly":false,"TermsDays":0,"TermsType":"Invoice","ExcludeFromAging":false,"DebtorIsBranchAccount":false,"RemainingNormalPrepaidLabourPackHours":0,"RemainingSpecialPrepaidLabourPackHours":0,"FXDecimalPlaces":0,"ProspectID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","AccountNo":"String","AltAccountNo":"String","Name":"String","Address1":"String","Address2":"String","Address3":"String","Address4":"String","Postcode":"String","Phone":"String","Fax":"String","EmailAddress":"String","ACN":"String","ABN":"String","AustPostDPID":"String","AustPostBCSP":"String","BankName":"String","BankAccountNo":"String","BankBSBN":"String","BankAccountName":"String","TaxExemptionNo":"String","NotifyAddress":"String","ParentDebtorID":"String","ParentDebtorAccountNo":"String","ParentDebtorName":"String","PriceSchemeID":"String","PriceSchemeDescription":"String","TradingName":"String","CompanyName":"String","ProprietorsName":"String","FaxHeader":"String","FXID":"String","FXName":"String","FXShortName":"String","BPayReference":"String","Classification":{"ClassificationID":"String","Description":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","IsDefault":false,"TermsDays":0,"TermsType":"Invoice","PricingGroupID":"String","PricingGroupDescription":"String","SellPricingSchemeID":"String","SellPricingSchemeDescription":"String","DebtorLedgers":[{"LedgerID":"String","Name":"String","LedgerAccountID":"String","LedgerAccountNo":"String","LedgerAccountDescription":"String"}]},"Category1":{"CategoryID":"String","Description":"String","CategoryNo":0,"IsDefault":false,"LastSavedDateTime":"0001-01-01T00:00:00.0000000"},"Category2":{"CategoryID":"String","Description":"String","CategoryNo":0,"IsDefault":false,"LastSavedDateTime":"0001-01-01T00:00:00.0000000"},"Category3":{"CategoryID":"String","Description":"String","CategoryNo":0,"IsDefault":false,"LastSavedDateTime":"0001-01-01T00:00:00.0000000"},"Category4":{"CategoryID":"String","Description":"String","CategoryNo":0,"IsDefault":false,"LastSavedDateTime":"0001-01-01T00:00:00.0000000"},"Category5":{"CategoryID":"String","Description":"String","CategoryNo":0,"IsDefault":false,"LastSavedDateTime":"0001-01-01T00:00:00.0000000"},"ContactNames":[{"DefaultContact":false,"DebtorContact":false,"CreditorContact":false,"ContactNameID":"String","ContactID":"String","AccountNo":"String","Title":"String","FirstName":"String","Surname":"String","PrimaryPositionID":"String","PrimaryPositionName":"String","SecondaryPositionID":"String","SecondaryPositionName":"String","TertiaryPositionID":"String","TertiaryPositionName":"String","Phone":"String","Mobile":"String","Fax":"String","EmailAddress":"String","ProspectID":"String","LogonCode":"String","LogonPassword":"String","ExternalAppRecID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","LogonCodeChangedByUser":false}],"GroupMemberships":[{"IsDefault":false,"GroupMembershipID":"String","GroupRecID":"String","GroupDescription":"String","StaffID":"String","StaffUsername":"String","StaffTitle":"String","StaffFirstName":"String","StaffSurname":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","ItemNo":0}],"BranchDebtors":[{"DebtorID":"String","AccountNo":"String","Name":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000"}],"DeliveryAddresses":[{"IsDefault":false,"DeliveryAddressID":"String","DeliveryAddressName":"String","DeliveryAddressCode":"String","Address1":"String","Address2":"String","Address3":"String","Address4":"String","Postcode":"String","Country":"String","Notes":"String","CourierDetails":"String","EDIStoreLocationCode":"String"}],"FreightForwarderAddresses":[{"IsDefault":false,"FreightForwarderAddressID":"String","Address1":"String","Address2":"String","Address3":"String","Address4":"String","Country":"String","Notes":"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"}],"CreditNotes":[{"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"}],"Directors":[{"DirectorID":"String","Name":"String","Address":"String","OfficeHeld":"String"}],"Budgets":[{"BudgetID":"String","Month":{"StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","FinancialYearMonthNo":0,"MonthID":"String"},"LastBudget":0,"CurrentBudget":0,"NextBudget":0}],"DebtorPartNumbers":[{"PartNumberID":"String","InventoryID":"String","PartNo":"String","DebtorPartNo":"String","DebtorBarcode":"String"}],"CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"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=="}],"DebtorSystems":[{"Template":{"SystemTemplateID":"String","Name":"String","Enabled":false},"SystemID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","Description":"String","Fields":[{"TemplateField":{"FieldType":0,"LineNumber":0,"SystemTemplateFieldID":"String","Name":"String","ComboText":"String","ScriptFormatCell":"String","ScriptButtonClicked":"String","ScriptReadData":"String","DefaultValue":"String","GridHandlerCode":"String"},"SystemFieldID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","Contents":"String"}]}],"DebtorLedgers":[{"LedgerID":"String","Name":"String","LedgerAccountID":"String","LedgerAccountNo":"String","LedgerAccountDescription":"String"}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"CreditLimit":0,"EarlyPaymentDiscountDays":0,"EarlyPaymentDiscountAmount":0,"LastPurchaseDate":"0001-01-01T00:00:00.0000000","LastPaymentDate":"0001-01-01T00:00:00.0000000","StandingDiscountOnInvoices":0,"AccountOnHold":false,"CurrentBalance":0,"Period1Balance":0,"Period2Balance":0,"Period3Balance":0,"Period4Balance":0,"FXCurrentBalance":0,"FXPeriod1Balance":0,"FXPeriod2Balance":0,"FXPeriod3Balance":0,"FXPeriod4Balance":0,"NotifyRequired":false,"WebAccess":false,"CommenceDate":"0001-01-01T00:00:00.0000000","TradingStatus":"e_DebtorTradingStatusInActive","PeriodType":"Weekly","UsesFX":false,"IsCashOnly":false,"TermsDays":0,"TermsType":"Invoice","ExcludeFromAging":false,"DebtorIsBranchAccount":false,"RemainingNormalPrepaidLabourPackHours":0,"RemainingSpecialPrepaidLabourPackHours":0,"FXDecimalPlaces":0,"DebtorID":"String","ProspectID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","AccountNo":"String","AltAccountNo":"String","Name":"String","Address1":"String","Address2":"String","Address3":"String","Address4":"String","Postcode":"String","Phone":"String","Fax":"String","EmailAddress":"String","ACN":"String","ABN":"String","AustPostDPID":"String","AustPostBCSP":"String","BankName":"String","BankAccountNo":"String","BankBSBN":"String","BankAccountName":"String","TaxExemptionNo":"String","NotifyAddress":"String","ParentDebtorID":"String","ParentDebtorAccountNo":"String","ParentDebtorName":"String","PriceSchemeID":"String","PriceSchemeDescription":"String","TradingName":"String","CompanyName":"String","ProprietorsName":"String","FaxHeader":"String","FXID":"String","FXName":"String","FXShortName":"String","BPayReference":"String","Classification":{"ClassificationID":"String","Description":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","IsDefault":false,"TermsDays":0,"TermsType":"Invoice","PricingGroupID":"String","PricingGroupDescription":"String","SellPricingSchemeID":"String","SellPricingSchemeDescription":"String","DebtorLedgers":[{"LedgerID":"String","Name":"String","LedgerAccountID":"String","LedgerAccountNo":"String","LedgerAccountDescription":"String"}]},"Category1":{"CategoryID":"String","Description":"String","CategoryNo":0,"IsDefault":false,"LastSavedDateTime":"0001-01-01T00:00:00.0000000"},"Category2":{"CategoryID":"String","Description":"String","CategoryNo":0,"IsDefault":false,"LastSavedDateTime":"0001-01-01T00:00:00.0000000"},"Category3":{"CategoryID":"String","Description":"String","CategoryNo":0,"IsDefault":false,"LastSavedDateTime":"0001-01-01T00:00:00.0000000"},"Category4":{"CategoryID":"String","Description":"String","CategoryNo":0,"IsDefault":false,"LastSavedDateTime":"0001-01-01T00:00:00.0000000"},"Category5":{"CategoryID":"String","Description":"String","CategoryNo":0,"IsDefault":false,"LastSavedDateTime":"0001-01-01T00:00:00.0000000"},"ContactNames":[{"DefaultContact":false,"DebtorContact":false,"CreditorContact":false,"ContactNameID":"String","ContactID":"String","AccountNo":"String","Title":"String","FirstName":"String","Surname":"String","PrimaryPositionID":"String","PrimaryPositionName":"String","SecondaryPositionID":"String","SecondaryPositionName":"String","TertiaryPositionID":"String","TertiaryPositionName":"String","Phone":"String","Mobile":"String","Fax":"String","EmailAddress":"String","ProspectID":"String","LogonCode":"String","LogonPassword":"String","ExternalAppRecID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","LogonCodeChangedByUser":false}],"GroupMemberships":[{"IsDefault":false,"GroupMembershipID":"String","GroupRecID":"String","GroupDescription":"String","StaffID":"String","StaffUsername":"String","StaffTitle":"String","StaffFirstName":"String","StaffSurname":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","ItemNo":0}],"BranchDebtors":[{"DebtorID":"String","AccountNo":"String","Name":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000"}],"DeliveryAddresses":[{"IsDefault":false,"DeliveryAddressID":"String","DeliveryAddressName":"String","DeliveryAddressCode":"String","Address1":"String","Address2":"String","Address3":"String","Address4":"String","Postcode":"String","Country":"String","Notes":"String","CourierDetails":"String","EDIStoreLocationCode":"String"}],"FreightForwarderAddresses":[{"IsDefault":false,"FreightForwarderAddressID":"String","Address1":"String","Address2":"String","Address3":"String","Address4":"String","Country":"String","Notes":"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"}],"CreditNotes":[{"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"}],"Directors":[{"DirectorID":"String","Name":"String","Address":"String","OfficeHeld":"String"}],"Budgets":[{"BudgetID":"String","Month":{"StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","FinancialYearMonthNo":0,"MonthID":"String"},"LastBudget":0,"CurrentBudget":0,"NextBudget":0}],"DebtorPartNumbers":[{"PartNumberID":"String","InventoryID":"String","PartNo":"String","DebtorPartNo":"String","DebtorBarcode":"String"}],"CustomFieldValues":[{"SettingID":"String","SettingName":"String","Contents":"String","PluginID":"String","PluginName":"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=="}],"DebtorSystems":[{"Template":{"SystemTemplateID":"String","Name":"String","Enabled":false},"SystemID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","Description":"String","Fields":[{"TemplateField":{"FieldType":0,"LineNumber":0,"SystemTemplateFieldID":"String","Name":"String","ComboText":"String","ScriptFormatCell":"String","ScriptButtonClicked":"String","ScriptReadData":"String","DefaultValue":"String","GridHandlerCode":"String"},"SystemFieldID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","Contents":"String"}]}],"DebtorLedgers":[{"LedgerID":"String","Name":"String","LedgerAccountID":"String","LedgerAccountNo":"String","LedgerAccountDescription":"String"}]}