JiwaAPI

<back to all web services

JournalSetGETRequest

Requires Authentication
The following routes are available for this service:
GET/JournalSets/{JournalSetID}Retrieves a journal set.
JournalSetGETRequest Parameters:
NameParameterData TypeRequiredDescription
JournalSetIDpathstringNo
JournalSet Parameters:
NameParameterData TypeRequiredDescription
JournalSetIDformstringNo
SetNoformstringNo
SetTypeformSetTypes?No
DescriptionformstringNo
SourceformstringNo
SourceIDformstringNo
PostedDateformDateTime?No
IsReversedformbool?No
ReverseTypeformReverseTypes?No
ReverseDateformDateTime?No
RepeatingUnitsformint?No
RepeatingTypeformRepeatingTypes?No
NextRepeatingDateformDateTime?No
RepeatingWillEndformbool?No
RepeatingEndDateformDateTime?No
LastSavedDateTimeformDateTime?No
StaffformStaffMemberNo
LinesformList<JournalSetLine>No
NotesformList<Note>No
DocumentsformList<Document>No
PostedToPeriodNoformint?No
PostedToPeriodNameformstringNo
PostedToYearTypeformYearTypes?No
PostedToYearNoformint?No
PostedToPeriodNoIsGloballyLockedformbool?No
PostedToPeriodNoIsExternallyLockedformbool?No
StaffMember Parameters:
NameParameterData TypeRequiredDescription
StaffIDformstringNo
TitleformstringNo
FirstNameformstringNo
SurnameformstringNo
UsernameformstringNo
IsActiveformbool?No
IsEnabledformbool?No
JournalSetLine Parameters:
NameParameterData TypeRequiredDescription
JournalSetLineIDformstringNo
ItemNoformint?No
ReferenceformstringNo
RemarkformstringNo
TransCode1IDformstringNo
TransCode1DescriptionformstringNo
TransCode2IDformstringNo
TransCode2DescriptionformstringNo
BASCodeformBASCodes?No
TransPostDateTimeformDateTime?No
DebitAmountformdecimal?No
CreditAmountformdecimal?No
AllowGroupformbool?No
StaffformStaffMemberNo
JobCostingStageIDformstringNo
JobCostingFullJobNoformstringNo
GeneralLedgerAccountRecIDformstringNo
GeneralLedgerAccountAccountNoformstringNo
GeneralLedgerAccountDescriptionformstringNo
Note Parameters:
NameParameterData TypeRequiredDescription
NoteIDformstringNo
NoteTypeformNoteTypeNo
LineNoformint?No
LastSavedDateTimeformDateTime?No
LastModifiedByStaffIDformstringNo
LastModifiedByStaffUsernameformstringNo
LastModifiedByStaffTitleformstringNo
LastModifiedByStaffFirstNameformstringNo
LastModifiedByStaffSurnameformstringNo
NoteTextformstringNo
NoteType Parameters:
NameParameterData TypeRequiredDescription
NoteTypeIDformstringNo
DescriptionformstringNo
DefaultTypeformbool?No
ItemNoformint?No
Document Parameters:
NameParameterData TypeRequiredDescription
DocumentIDformstringNo
DocumentTypeformDocumentTypeNo
FileIDformstringNo
PhysicalFileNameformstringNo
FullPhysicalFileNameformstringNo
DescriptionformstringNo
LastSavedDateTimeformDateTime?No
LastModifiedByStaffIDformstringNo
LastModifiedByStaffUsernameformstringNo
LastModifiedByStaffTitleformstringNo
LastModifiedByStaffFirstNameformstringNo
LastModifiedByStaffSurnameformstringNo
FileBinaryformbyte[]No
DocumentType Parameters:
NameParameterData TypeRequiredDescription
DocumentTypeIDformstringNo
DescriptionformstringNo
DefaultTypeformbool?No
ItemNoformint?No
LastSavedDateTimeformDateTime?No
RowHashformbyte[]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 /JournalSets/{JournalSetID} HTTP/1.1 
Host: localhost 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","RowHash":"AA=="},"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}