JiwaAPI

<back to all web services

CreditorClassificationGETRequest

Requires Authentication
The following routes are available for this service:
GET/Creditors/Classifications/{ClassificationID}Retrieves a creditor classification.
CreditorClassificationGETRequest Parameters:
NameParameterData TypeRequiredDescription
ClassificationIDpathstringNo
CreditorClassification Parameters:
NameParameterData TypeRequiredDescription
ClassificationIDformstringNo
DescriptionformstringNo
LastSavedDateTimeformDateTime?No
IsDefaultformbool?No
TermsDaysformint?No
TermsTypeformCreditorTermsTypes?No
PO_Workflows_RecIDformstringNo
PO_Workflows_NameformstringNo
PO_Workflows_DescriptionformstringNo
CreditorLedgersformList<CreditorLedger>No
CreditorLedger Parameters:
NameParameterData TypeRequiredDescription
LedgerIDformstringNo
NameformstringNo
LedgerAccountIDformstringNo
LedgerAccountNoformstringNo
LedgerAccountDescriptionformstringNo

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

{"ClassificationID":"String","Description":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","IsDefault":false,"TermsDays":0,"TermsType":"Invoice","PO_Workflows_RecID":"String","PO_Workflows_Name":"String","PO_Workflows_Description":"String","CreditorLedgers":[{"LedgerID":"String","Name":"String","LedgerAccountID":"String","LedgerAccountNo":"String","LedgerAccountDescription":"String"}]}