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 .xml suffix or ?format=xml

HTTP + XML

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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreditorClassification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Creditors.Classification">
  <_x003C_ClassificationID_x003E_k__BackingField>String</_x003C_ClassificationID_x003E_k__BackingField>
  <_x003C_CreditorLedgers_x003E_k__BackingField xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Creditors">
    <d2p1:CreditorLedger>
      <d2p1:_x003C_LedgerAccountDescription_x003E_k__BackingField>String</d2p1:_x003C_LedgerAccountDescription_x003E_k__BackingField>
      <d2p1:_x003C_LedgerAccountID_x003E_k__BackingField>String</d2p1:_x003C_LedgerAccountID_x003E_k__BackingField>
      <d2p1:_x003C_LedgerAccountNo_x003E_k__BackingField>String</d2p1:_x003C_LedgerAccountNo_x003E_k__BackingField>
      <d2p1:_x003C_LedgerID_x003E_k__BackingField>String</d2p1:_x003C_LedgerID_x003E_k__BackingField>
      <d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_x003E_k__BackingField>
    </d2p1:CreditorLedger>
  </_x003C_CreditorLedgers_x003E_k__BackingField>
  <_x003C_Description_x003E_k__BackingField>String</_x003C_Description_x003E_k__BackingField>
  <_x003C_IsDefault_x003E_k__BackingField>false</_x003C_IsDefault_x003E_k__BackingField>
  <_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_LastSavedDateTime_x003E_k__BackingField>
  <_x003C_PO_Workflows_Description_x003E_k__BackingField>String</_x003C_PO_Workflows_Description_x003E_k__BackingField>
  <_x003C_PO_Workflows_Name_x003E_k__BackingField>String</_x003C_PO_Workflows_Name_x003E_k__BackingField>
  <_x003C_PO_Workflows_RecID_x003E_k__BackingField>String</_x003C_PO_Workflows_RecID_x003E_k__BackingField>
  <_x003C_TermsDays_x003E_k__BackingField>0</_x003C_TermsDays_x003E_k__BackingField>
  <_x003C_TermsType_x003E_k__BackingField>Invoice</_x003C_TermsType_x003E_k__BackingField>
</CreditorClassification>