JiwaAPI

<back to all web services

DebtorClassificationGETRequest

Requires Authentication
The following routes are available for this service:
GET/Debtors/Classifications/{ClassificationID}Retrieves a debtor classification.
DebtorClassificationGETRequest Parameters:
NameParameterData TypeRequiredDescription
ClassificationIDpathstringNo
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

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 /Debtors/Classifications/{ClassificationID} HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"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"}]}