JiwaAPI

JournalSetGETRequest

The following routes are available for this service:
GET	/JournalSets/{JournalSetID}	Retrieves a journal set.

**JournalSetGETRequest** Parameters:
Name	Parameter	Data Type	Required	Description
JournalSetID	path	string	No

**JournalSet** Parameters:
Name	Parameter	Data Type	Required
JournalSetID	form	string	No
SetNo	form	string	No
SetType	form	SetTypes?	No
Description	form	string	No
Source	form	string	No
SourceID	form	string	No
PostedDate	form	DateTime?	No
IsReversed	form	bool?	No
ReverseType	form	ReverseTypes?	No
ReverseDate	form	DateTime?	No
RepeatingUnits	form	int?	No
RepeatingType	form	RepeatingTypes?	No
NextRepeatingDate	form	DateTime?	No
RepeatingWillEnd	form	bool?	No
RepeatingEndDate	form	DateTime?	No
LastSavedDateTime	form	DateTime?	No
Staff	form	StaffMember	No
Lines	form	List<JournalSetLine>	No
Notes	form	List<Note>	No
Documents	form	List<Document>	No
PostedToPeriodNo	form	int?	No
PostedToPeriodName	form	string	No
PostedToYearType	form	YearTypes?	No
PostedToYearNo	form	int?	No
PostedToPeriodNoIsGloballyLocked	form	bool?	No
PostedToPeriodNoIsExternallyLocked	form	bool?	No

**StaffMember** Parameters:
Name	Parameter	Data Type	Required
StaffID	form	string	No
Title	form	string	No
FirstName	form	string	No
Surname	form	string	No
Username	form	string	No
IsActive	form	bool?	No
IsEnabled	form	bool?	No

**JournalSetLine** Parameters:
Name	Parameter	Data Type	Required
JournalSetLineID	form	string	No
ItemNo	form	int?	No
Reference	form	string	No
Remark	form	string	No
TransCode1ID	form	string	No
TransCode1Description	form	string	No
TransCode2ID	form	string	No
TransCode2Description	form	string	No
BASCode	form	BASCodes?	No
TransPostDateTime	form	DateTime?	No
DebitAmount	form	decimal?	No
CreditAmount	form	decimal?	No
AllowGroup	form	bool?	No
Staff	form	StaffMember	No
JobCostingStageID	form	string	No
JobCostingFullJobNo	form	string	No
GeneralLedgerAccountRecID	form	string	No
GeneralLedgerAccountAccountNo	form	string	No
GeneralLedgerAccountDescription	form	string	No

**Note** Parameters:
Name	Parameter	Data Type	Required
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

**NoteType** Parameters:
Name	Parameter	Data Type	Required
NoteTypeID	form	string	No
Description	form	string	No
DefaultType	form	bool?	No
ItemNo	form	int?	No

**Document** Parameters:
Name	Parameter	Data Type	Required
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

**DocumentType** Parameters:
Name	Parameter	Data Type	Required
DocumentTypeID	form	string	No
Description	form	string	No
DefaultType	form	bool?	No
ItemNo	form	int?	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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /JournalSets/{JournalSetID} HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"JournalSetID":"String","SetNo":"String","SetType":"Normal","Description":"String","Source":"String","SourceID":"String","PostedDate":"0001-01-01T00:00:00.0000000","IsReversed":false,"ReverseType":"None","ReverseDate":"0001-01-01T00:00:00.0000000","RepeatingUnits":0,"RepeatingType":"None","NextRepeatingDate":"0001-01-01T00:00:00.0000000","RepeatingWillEnd":false,"RepeatingEndDate":"0001-01-01T00:00:00.0000000","LastSavedDateTime":"0001-01-01T00:00:00.0000000","Staff":{"StaffID":"String","Title":"String","FirstName":"String","Surname":"String","Username":"String","IsActive":false,"IsEnabled":false},"Lines":[{"JournalSetLineID":"String","ItemNo":0,"Reference":"String","Remark":"String","TransCode1ID":"String","TransCode1Description":"String","TransCode2ID":"String","TransCode2Description":"String","BASCode":"No_Code","TransPostDateTime":"0001-01-01T00:00:00.0000000","DebitAmount":0,"CreditAmount":0,"AllowGroup":false,"Staff":{"StaffID":"String","Title":"String","FirstName":"String","Surname":"String","Username":"String","IsActive":false,"IsEnabled":false},"JobCostingStageID":"String","JobCostingFullJobNo":"String","GeneralLedgerAccountRecID":"String","GeneralLedgerAccountAccountNo":"String","GeneralLedgerAccountDescription":"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"}],"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=="}],"PostedToPeriodNo":0,"PostedToPeriodName":"String","PostedToYearType":"LastYear","PostedToYearNo":0,"PostedToPeriodNoIsGloballyLocked":false,"PostedToPeriodNoIsExternallyLocked":false}