JiwaAPI

<back to all web services

DebtorGETRequest

Requires Authentication
The following routes are available for this service:
GET/Debtors/{DebtorID}Retrieves a debtor.
DebtorGETRequest Parameters:
NameParameterData TypeRequiredDescription
DebtorIDpathstringNo
Debtor Parameters:
NameParameterData TypeRequiredDescription
CreditLimitformdecimal?No
EarlyPaymentDiscountDaysformint?No
EarlyPaymentDiscountAmountformdecimal?No
LastPurchaseDateformDateTime?No
LastPaymentDateformDateTime?No
StandingDiscountOnInvoicesformdecimal?No
AccountOnHoldformbool?No
CurrentBalanceformdecimal?No
Period1Balanceformdecimal?No
Period2Balanceformdecimal?No
Period3Balanceformdecimal?No
Period4Balanceformdecimal?No
FXCurrentBalanceformdecimal?No
FXPeriod1Balanceformdecimal?No
FXPeriod2Balanceformdecimal?No
FXPeriod3Balanceformdecimal?No
FXPeriod4Balanceformdecimal?No
NotifyRequiredformbool?No
WebAccessformbool?No
CommenceDateformDateTime?No
TradingStatusformTradingStatuses?No
PeriodTypeformPeriodTypes?No
UsesFXformbool?No
IsCashOnlyformbool?No
TermsDaysformint?No
TermsTypeformTermsTypes?No
ExcludeFromAgingformbool?No
DebtorIsBranchAccountformbool?No
RemainingNormalPrepaidLabourPackHoursformdecimal?No
RemainingSpecialPrepaidLabourPackHoursformdecimal?No
FXDecimalPlacesformint?No
DebtorIDformstringNo
ProspectIDformstringNo
LastSavedDateTimeformDateTime?No
AccountNoformstringNo
AltAccountNoformstringNo
NameformstringNo
Address1formstringNo
Address2formstringNo
Address3formstringNo
Address4formstringNo
PostcodeformstringNo
PhoneformstringNo
FaxformstringNo
EmailAddressformstringNo
ACNformstringNo
ABNformstringNo
AustPostDPIDformstringNo
AustPostBCSPformstringNo
BankNameformstringNo
BankAccountNoformstringNo
BankBSBNformstringNo
BankAccountNameformstringNo
TaxExemptionNoformstringNo
NotifyAddressformstringNo
ParentDebtorIDformstringNo
ParentDebtorAccountNoformstringNo
ParentDebtorNameformstringNo
PriceSchemeIDformstringNo
PriceSchemeDescriptionformstringNo
TradingNameformstringNo
CompanyNameformstringNo
ProprietorsNameformstringNo
FaxHeaderformstringNo
FXIDformstringNo
FXNameformstringNo
FXShortNameformstringNo
BPayReferenceformstringNo
ClassificationformDebtorClassificationNo
Category1formDebtorCategoryNo
Category2formDebtorCategoryNo
Category3formDebtorCategoryNo
Category4formDebtorCategoryNo
Category5formDebtorCategoryNo
ContactNamesformList<DebtorContactName>No
GroupMembershipsformList<DebtorGroupMembership>No
BranchDebtorsformList<DebtorBranchDebtor>No
DeliveryAddressesformList<DebtorDeliveryAddress>No
FreightForwarderAddressesformList<DebtorFreightForwarderAddress>No
NotesformList<Note>No
CreditNotesformList<Note>No
DirectorsformList<DebtorDirector>No
BudgetsformList<DebtorBudget>No
DebtorPartNumbersformList<DebtorPartNumber>No
CustomFieldValuesformList<CustomFieldValue>No
DocumentsformList<Document>No
DebtorSystemsformList<DebtorSystem>No
DebtorLedgersformList<DebtorLedger>No
DebtorClassification Parameters:
NameParameterData TypeRequiredDescription
ClassificationIDformstringNo
DescriptionformstringNo
LastSavedDateTimeformDateTime?No
IsDefaultformbool?No
TermsDaysformint?No
TermsTypeformDebtorTermsTypes?No
PricingGroupIDformstringNo
PricingGroupDescriptionformstringNo
SellPricingSchemeIDformstringNo
SellPricingSchemeDescriptionformstringNo
DebtorLedgersformList<DebtorLedger>No
DebtorLedger Parameters:
NameParameterData TypeRequiredDescription
LedgerIDformstringNo
NameformstringNo
LedgerAccountIDformstringNo
LedgerAccountNoformstringNo
LedgerAccountDescriptionformstringNo
DebtorCategory Parameters:
NameParameterData TypeRequiredDescription
CategoryIDformstringNo
DescriptionformstringNo
CategoryNoformint?No
IsDefaultformbool?No
LastSavedDateTimeformDateTime?No
DebtorContactName Parameters:
NameParameterData TypeRequiredDescription
DefaultContactformbool?No
DebtorContactformbool?No
CreditorContactformbool?No
ContactNameIDformstringNo
ContactIDformstringNo
AccountNoformstringNo
TitleformstringNo
FirstNameformstringNo
SurnameformstringNo
PrimaryPositionIDformstringNo
PrimaryPositionNameformstringNo
SecondaryPositionIDformstringNo
SecondaryPositionNameformstringNo
TertiaryPositionIDformstringNo
TertiaryPositionNameformstringNo
PhoneformstringNo
MobileformstringNo
FaxformstringNo
EmailAddressformstringNo
ProspectIDformstringNo
LogonCodeformstringNo
LogonPasswordformstringNo
ExternalAppRecIDformstringNo
LastSavedDateTimeformDateTime?No
LogonCodeChangedByUserformbool?No
DebtorGroupMembership Parameters:
NameParameterData TypeRequiredDescription
IsDefaultformbool?No
GroupMembershipIDformstringNo
GroupRecIDformstringNo
GroupDescriptionformstringNo
StaffIDformstringNo
StaffUsernameformstringNo
StaffTitleformstringNo
StaffFirstNameformstringNo
StaffSurnameformstringNo
LastSavedDateTimeformDateTime?No
ItemNoformint?No
DebtorBranchDebtor Parameters:
NameParameterData TypeRequiredDescription
DebtorIDformstringNo
AccountNoformstringNo
NameformstringNo
LastSavedDateTimeformDateTime?No
DebtorDeliveryAddress Parameters:
NameParameterData TypeRequiredDescription
IsDefaultformbool?No
DeliveryAddressIDformstringNo
DeliveryAddressNameformstringNo
DeliveryAddressCodeformstringNo
Address1formstringNo
Address2formstringNo
Address3formstringNo
Address4formstringNo
PostcodeformstringNo
CountryformstringNo
NotesformstringNo
CourierDetailsformstringNo
EDIStoreLocationCodeformstringNo
DebtorFreightForwarderAddress Parameters:
NameParameterData TypeRequiredDescription
IsDefaultformbool?No
FreightForwarderAddressIDformstringNo
Address1formstringNo
Address2formstringNo
Address3formstringNo
Address4formstringNo
CountryformstringNo
NotesformstringNo
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
DebtorDirector Parameters:
NameParameterData TypeRequiredDescription
DirectorIDformstringNo
NameformstringNo
AddressformstringNo
OfficeHeldformstringNo
DebtorBudget Parameters:
NameParameterData TypeRequiredDescription
BudgetIDformstringNo
MonthformDebtorMonthNo
LastBudgetformdecimal?No
CurrentBudgetformdecimal?No
NextBudgetformdecimal?No
DebtorMonth Parameters:
NameParameterData TypeRequiredDescription
StartDateformDateTime?No
EndDateformDateTime?No
FinancialYearMonthNoformint?No
MonthIDformstringNo
DebtorPartNumber Parameters:
NameParameterData TypeRequiredDescription
PartNumberIDformstringNo
InventoryIDformstringNo
PartNoformstringNo
DebtorPartNoformstringNo
DebtorBarcodeformstringNo
CustomFieldValue Parameters:
NameParameterData TypeRequiredDescription
SettingIDformstringNo
SettingNameformstringNo
ContentsformstringNo
PluginIDformstringNo
PluginNameformstringNo
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
LastSavedDateTimeformDateTime?No
RowHashformbyte[]No
DebtorSystem Parameters:
NameParameterData TypeRequiredDescription
TemplateformDebtorSystemTemplateNo
SystemIDformstringNo
LastSavedDateTimeformDateTime?No
DescriptionformstringNo
FieldsformList<DebtorSystemField>No
DebtorSystemTemplate Parameters:
NameParameterData TypeRequiredDescription
SystemTemplateIDformstringNo
NameformstringNo
Enabledformbool?No
DebtorSystemField Parameters:
NameParameterData TypeRequiredDescription
TemplateFieldformDebtorSystemTemplateFieldNo
SystemFieldIDformstringNo
LastSavedDateTimeformDateTime?No
ContentsformstringNo
DebtorSystemTemplateField Parameters:
NameParameterData TypeRequiredDescription
FieldTypeformint?No
LineNumberformint?No
SystemTemplateFieldIDformstringNo
NameformstringNo
ComboTextformstringNo
ScriptFormatCellformstringNo
ScriptButtonClickedformstringNo
ScriptReadDataformstringNo
DefaultValueformstringNo
GridHandlerCodeformstringNo

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

HTTP + JSON

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

GET /Debtors/{DebtorID} HTTP/1.1 
Host: localhost 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","RowHash":"AA=="},"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"}]}