JiwaAPI

<back to all web services

CreditorGETRequest

Requires Authentication
The following routes are available for this service:
GET/Creditors/{CreditorID}Retrieves a creditor.
CreditorGETRequest Parameters:
NameParameterData TypeRequiredDescription
CreditorIDpathstringNo
Creditor Parameters:
NameParameterData TypeRequiredDescription
CreditorIDformstringNo
AccountNoformstringNo
AltAccountNoformstringNo
NameformstringNo
WarehouseAddressesformList<CreditorWarehouseAddress>No
LastSavedDateTimeformDateTime?No
CreditorWarehouseAddress Parameters:
NameParameterData TypeRequiredDescription
WarehouseAddressIDformstringNo
DescriptionformstringNo
Address1formstringNo
Address2formstringNo
Address3formstringNo
Address4formstringNo
PostcodeformstringNo
CountryformstringNo
NotesformstringNo
CourierDetailsformstringNo
DefaultDeliveryDaysformint?No
IsDefaultformbool?No

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

{"CreditorID":"String","AccountNo":"String","AltAccountNo":"String","Name":"String","WarehouseAddresses":[{"WarehouseAddressID":"String","Description":"String","Address1":"String","Address2":"String","Address3":"String","Address4":"String","Postcode":"String","Country":"String","Notes":"String","CourierDetails":"String","DefaultDeliveryDays":0,"IsDefault":false}],"LastSavedDateTime":"0001-01-01T00:00:00.0000000"}