| GET | /Debtors | Retrieves a debtor for a API Key authenticated customer. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CreditLimit | form | decimal? | No | |
| EarlyPaymentDiscountDays | form | int? | No | |
| EarlyPaymentDiscountAmount | form | decimal? | No | |
| LastPurchaseDate | form | DateTime? | No | |
| LastPaymentDate | form | DateTime? | No | |
| StandingDiscountOnInvoices | form | decimal? | No | |
| AccountOnHold | form | bool? | No | |
| CurrentBalance | form | decimal? | No | |
| Period1Balance | form | decimal? | No | |
| Period2Balance | form | decimal? | No | |
| Period3Balance | form | decimal? | No | |
| Period4Balance | form | decimal? | No | |
| FXCurrentBalance | form | decimal? | No | |
| FXPeriod1Balance | form | decimal? | No | |
| FXPeriod2Balance | form | decimal? | No | |
| FXPeriod3Balance | form | decimal? | No | |
| FXPeriod4Balance | form | decimal? | No | |
| NotifyRequired | form | bool? | No | |
| WebAccess | form | bool? | No | |
| CommenceDate | form | DateTime? | No | |
| TradingStatus | form | TradingStatuses? | No | |
| PeriodType | form | PeriodTypes? | No | |
| UsesFX | form | bool? | No | |
| IsCashOnly | form | bool? | No | |
| TermsDays | form | int? | No | |
| TermsType | form | TermsTypes? | No | |
| ExcludeFromAging | form | bool? | No | |
| DebtorIsBranchAccount | form | bool? | No | |
| RemainingNormalPrepaidLabourPackHours | form | decimal? | No | |
| RemainingSpecialPrepaidLabourPackHours | form | decimal? | No | |
| FXDecimalPlaces | form | int? | No | |
| DebtorID | form | string | No | |
| ProspectID | form | string | No | |
| LastSavedDateTime | form | DateTime? | No | |
| AccountNo | form | string | No | |
| AltAccountNo | form | string | No | |
| Name | form | string | No | |
| Address1 | form | string | No | |
| Address2 | form | string | No | |
| Address3 | form | string | No | |
| Address4 | form | string | No | |
| Postcode | form | string | No | |
| Phone | form | string | No | |
| Fax | form | string | No | |
| EmailAddress | form | string | No | |
| ACN | form | string | No | |
| ABN | form | string | No | |
| AustPostDPID | form | string | No | |
| AustPostBCSP | form | string | No | |
| BankName | form | string | No | |
| BankAccountNo | form | string | No | |
| BankBSBN | form | string | No | |
| BankAccountName | form | string | No | |
| TaxExemptionNo | form | string | No | |
| NotifyAddress | form | string | No | |
| ParentDebtorID | form | string | No | |
| ParentDebtorAccountNo | form | string | No | |
| ParentDebtorName | form | string | No | |
| PriceSchemeID | form | string | No | |
| PriceSchemeDescription | form | string | No | |
| TradingName | form | string | No | |
| CompanyName | form | string | No | |
| ProprietorsName | form | string | No | |
| FaxHeader | form | string | No | |
| FXID | form | string | No | |
| FXName | form | string | No | |
| FXShortName | form | string | No | |
| BPayReference | form | string | No | |
| Classification | form | DebtorClassification | No | |
| Category1 | form | DebtorCategory | No | |
| Category2 | form | DebtorCategory | No | |
| Category3 | form | DebtorCategory | No | |
| Category4 | form | DebtorCategory | No | |
| Category5 | form | DebtorCategory | No | |
| ContactNames | form | List<DebtorContactName> | No | |
| GroupMemberships | form | List<DebtorGroupMembership> | No | |
| BranchDebtors | form | List<DebtorBranchDebtor> | No | |
| DeliveryAddresses | form | List<DebtorDeliveryAddress> | No | |
| FreightForwarderAddresses | form | List<DebtorFreightForwarderAddress> | No | |
| Notes | form | List<Note> | No | |
| CreditNotes | form | List<Note> | No | |
| Directors | form | List<DebtorDirector> | No | |
| Budgets | form | List<DebtorBudget> | No | |
| DebtorPartNumbers | form | List<DebtorPartNumber> | No | |
| CustomFieldValues | form | List<CustomFieldValue> | No | |
| Documents | form | List<Document> | No | |
| DebtorSystems | form | List<DebtorSystem> | No | |
| DebtorLedgers | form | List<DebtorLedger> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClassificationID | form | string | No | |
| Description | form | string | No | |
| LastSavedDateTime | form | DateTime? | No | |
| IsDefault | form | bool? | No | |
| TermsDays | form | int? | No | |
| TermsType | form | DebtorTermsTypes? | No | |
| PricingGroupID | form | string | No | |
| PricingGroupDescription | form | string | No | |
| SellPricingSchemeID | form | string | No | |
| SellPricingSchemeDescription | form | string | No | |
| DebtorLedgers | form | List<DebtorLedger> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LedgerID | form | string | No | |
| Name | form | string | No | |
| LedgerAccountID | form | string | No | |
| LedgerAccountNo | form | string | No | |
| LedgerAccountDescription | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CategoryID | form | string | No | |
| Description | form | string | No | |
| CategoryNo | form | int? | No | |
| IsDefault | form | bool? | No | |
| LastSavedDateTime | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DefaultContact | form | bool? | No | |
| DebtorContact | form | bool? | No | |
| CreditorContact | form | bool? | No | |
| ContactNameID | form | string | No | |
| ContactID | form | string | No | |
| AccountNo | form | string | No | |
| Title | form | string | No | |
| FirstName | form | string | No | |
| Surname | form | string | No | |
| PrimaryPositionID | form | string | No | |
| PrimaryPositionName | form | string | No | |
| SecondaryPositionID | form | string | No | |
| SecondaryPositionName | form | string | No | |
| TertiaryPositionID | form | string | No | |
| TertiaryPositionName | form | string | No | |
| Phone | form | string | No | |
| Mobile | form | string | No | |
| Fax | form | string | No | |
| EmailAddress | form | string | No | |
| ProspectID | form | string | No | |
| LogonCode | form | string | No | |
| LogonPassword | form | string | No | |
| ExternalAppRecID | form | string | No | |
| LastSavedDateTime | form | DateTime? | No | |
| LogonCodeChangedByUser | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IsDefault | form | bool? | No | |
| GroupMembershipID | form | string | No | |
| GroupRecID | form | string | No | |
| GroupDescription | form | string | No | |
| StaffID | form | string | No | |
| StaffUsername | form | string | No | |
| StaffTitle | form | string | No | |
| StaffFirstName | form | string | No | |
| StaffSurname | form | string | No | |
| LastSavedDateTime | form | DateTime? | No | |
| ItemNo | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DebtorID | form | string | No | |
| AccountNo | form | string | No | |
| Name | form | string | No | |
| LastSavedDateTime | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IsDefault | form | bool? | No | |
| DeliveryAddressID | form | string | No | |
| DeliveryAddressName | form | string | No | |
| DeliveryAddressCode | form | string | No | |
| Address1 | form | string | No | |
| Address2 | form | string | No | |
| Address3 | form | string | No | |
| Address4 | form | string | No | |
| Postcode | form | string | No | |
| Country | form | string | No | |
| Notes | form | string | No | |
| CourierDetails | form | string | No | |
| EDIStoreLocationCode | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IsDefault | form | bool? | No | |
| FreightForwarderAddressID | form | string | No | |
| Address1 | form | string | No | |
| Address2 | form | string | No | |
| Address3 | form | string | No | |
| Address4 | form | string | No | |
| Country | form | string | No | |
| Notes | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| NoteID | form | string | No | |
| NoteType | form | NoteType | No | |
| LineNo | form | int? | No | |
| LastSavedDateTime | form | DateTime? | No | |
| LastModifiedByStaffID | form | string | No | |
| LastModifiedByStaffUsername | form | string | No | |
| LastModifiedByStaffTitle | form | string | No | |
| LastModifiedByStaffFirstName | form | string | No | |
| LastModifiedByStaffSurname | form | string | No | |
| NoteText | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| NoteTypeID | form | string | No | |
| Description | form | string | No | |
| DefaultType | form | bool? | No | |
| ItemNo | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DirectorID | form | string | No | |
| Name | form | string | No | |
| Address | form | string | No | |
| OfficeHeld | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BudgetID | form | string | No | |
| Month | form | DebtorMonth | No | |
| LastBudget | form | decimal? | No | |
| CurrentBudget | form | decimal? | No | |
| NextBudget | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StartDate | form | DateTime? | No | |
| EndDate | form | DateTime? | No | |
| FinancialYearMonthNo | form | int? | No | |
| MonthID | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PartNumberID | form | string | No | |
| InventoryID | form | string | No | |
| PartNo | form | string | No | |
| DebtorPartNo | form | string | No | |
| DebtorBarcode | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SettingID | form | string | No | |
| SettingName | form | string | No | |
| Contents | form | string | No | |
| PluginID | form | string | No | |
| PluginName | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentID | form | string | No | |
| DocumentType | form | DocumentType | No | |
| FileID | form | string | No | |
| PhysicalFileName | form | string | No | |
| FullPhysicalFileName | form | string | No | |
| Description | form | string | No | |
| LastSavedDateTime | form | DateTime? | No | |
| LastModifiedByStaffID | form | string | No | |
| LastModifiedByStaffUsername | form | string | No | |
| LastModifiedByStaffTitle | form | string | No | |
| LastModifiedByStaffFirstName | form | string | No | |
| LastModifiedByStaffSurname | form | string | No | |
| FileBinary | form | byte[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentTypeID | form | string | No | |
| Description | form | string | No | |
| DefaultType | form | bool? | No | |
| ItemNo | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Template | form | DebtorSystemTemplate | No | |
| SystemID | form | string | No | |
| LastSavedDateTime | form | DateTime? | No | |
| Description | form | string | No | |
| Fields | form | List<DebtorSystemField> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SystemTemplateID | form | string | No | |
| Name | form | string | No | |
| Enabled | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TemplateField | form | DebtorSystemTemplateField | No | |
| SystemFieldID | form | string | No | |
| LastSavedDateTime | form | DateTime? | No | |
| Contents | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FieldType | form | int? | No | |
| LineNumber | form | int? | No | |
| SystemTemplateFieldID | form | string | No | |
| Name | form | string | No | |
| ComboText | form | string | No | |
| ScriptFormatCell | form | string | No | |
| ScriptButtonClicked | form | string | No | |
| ScriptReadData | form | string | No | |
| DefaultValue | form | string | No | |
| GridHandlerCode | form | string | No |
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Debtors HTTP/1.1 Host: api.jiwa.com.au 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},"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"}]}