Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TransID | query | string | No | |
TransIDStartsWith | query | string | No | |
TransIDEndsWith | query | string | No | |
TransIDContains | query | string | No | |
TransIDLike | query | string | No | |
TransIDBetween | query | string[] | No | |
TransIDIn | query | string[] | No | |
DebtorID | query | string | No | |
DebtorIDStartsWith | query | string | No | |
DebtorIDEndsWith | query | string | No | |
DebtorIDContains | query | string | No | |
DebtorIDLike | query | string | No | |
DebtorIDBetween | query | string[] | No | |
DebtorIDIn | query | string[] | No | |
AccountNo | query | string | No | |
AccountNoStartsWith | query | string | No | |
AccountNoEndsWith | query | string | No | |
AccountNoContains | query | string | No | |
AccountNoLike | query | string | No | |
AccountNoBetween | query | string[] | No | |
AccountNoIn | query | string[] | No | |
Name | query | string | No | |
NameStartsWith | query | string | No | |
NameEndsWith | query | string | No | |
NameContains | query | string | No | |
NameLike | query | string | No | |
NameBetween | query | string[] | No | |
NameIn | query | string[] | No | |
TranDate | query | DateTime? | No | |
TranDateGreaterThanOrEqualTo | query | DateTime? | No | |
TranDateGreaterThan | query | DateTime? | No | |
TranDateLessThan | query | DateTime? | No | |
TranDateLessThanOrEqualTo | query | DateTime? | No | |
TranDateNotEqualTo | query | DateTime? | No | |
TranDateBetween | query | Nullable<DateTime>[] | No | |
TranDateIn | query | Nullable<DateTime>[] | No | |
DueDate | query | DateTime? | No | |
DueDateGreaterThanOrEqualTo | query | DateTime? | No | |
DueDateGreaterThan | query | DateTime? | No | |
DueDateLessThan | query | DateTime? | No | |
DueDateLessThanOrEqualTo | query | DateTime? | No | |
DueDateNotEqualTo | query | DateTime? | No | |
DueDateBetween | query | Nullable<DateTime>[] | No | |
DueDateIn | query | Nullable<DateTime>[] | No | |
InvRemitNo | query | string | No | |
InvRemitNoStartsWith | query | string | No | |
InvRemitNoEndsWith | query | string | No | |
InvRemitNoContains | query | string | No | |
InvRemitNoLike | query | string | No | |
InvRemitNoBetween | query | string[] | No | |
InvRemitNoIn | query | string[] | No | |
DebitCredit | query | bool? | No | |
Amount | query | decimal? | No | |
AmountGreaterThanOrEqualTo | query | decimal? | No | |
AmountGreaterThan | query | decimal? | No | |
AmountLessThan | query | decimal? | No | |
AmountLessThanOrEqualTo | query | decimal? | No | |
AmountNotEqualTo | query | decimal? | No | |
AmountBetween | query | Nullable<Decimal>[] | No | |
AmountIn | query | Nullable<Decimal>[] | No | |
AllocatedAmount | query | decimal? | No | |
AllocatedAmountGreaterThanOrEqualTo | query | decimal? | No | |
AllocatedAmountGreaterThan | query | decimal? | No | |
AllocatedAmountLessThan | query | decimal? | No | |
AllocatedAmountLessThanOrEqualTo | query | decimal? | No | |
AllocatedAmountNotEqualTo | query | decimal? | No | |
AllocatedAmountBetween | query | Nullable<Decimal>[] | No | |
AllocatedAmountIn | query | Nullable<Decimal>[] | No | |
GSTAmount | query | decimal? | No | |
GSTAmountGreaterThanOrEqualTo | query | decimal? | No | |
GSTAmountGreaterThan | query | decimal? | No | |
GSTAmountLessThan | query | decimal? | No | |
GSTAmountLessThanOrEqualTo | query | decimal? | No | |
GSTAmountNotEqualTo | query | decimal? | No | |
GSTAmountBetween | query | Nullable<Decimal>[] | No | |
GSTAmountIn | query | Nullable<Decimal>[] | No | |
OutstandingAmount | query | decimal? | No | |
OutstandingAmountGreaterThanOrEqualTo | query | decimal? | No | |
OutstandingAmountGreaterThan | query | decimal? | No | |
OutstandingAmountLessThan | query | decimal? | No | |
OutstandingAmountLessThanOrEqualTo | query | decimal? | No | |
OutstandingAmountNotEqualTo | query | decimal? | No | |
OutstandingAmountBetween | query | Nullable<Decimal>[] | No | |
OutstandingAmountIn | query | Nullable<Decimal>[] | No | |
Description | query | string | No | |
DescriptionStartsWith | query | string | No | |
DescriptionEndsWith | query | string | No | |
DescriptionContains | query | string | No | |
DescriptionLike | query | string | No | |
DescriptionBetween | query | string[] | No | |
DescriptionIn | query | string[] | No | |
SourceID | query | string | No | |
SourceIDStartsWith | query | string | No | |
SourceIDEndsWith | query | string | No | |
SourceIDContains | query | string | No | |
SourceIDLike | query | string | No | |
SourceIDBetween | query | string[] | No | |
SourceIDIn | query | string[] | No | |
Ref | query | string | No | |
RefStartsWith | query | string | No | |
RefEndsWith | query | string | No | |
RefContains | query | string | No | |
RefLike | query | string | No | |
RefBetween | query | string[] | No | |
RefIn | query | string[] | No | |
Remark | query | string | No | |
RemarkStartsWith | query | string | No | |
RemarkEndsWith | query | string | No | |
RemarkContains | query | string | No | |
RemarkLike | query | string | No | |
RemarkBetween | query | string[] | No | |
RemarkIn | query | string[] | No | |
Note | query | string | No | |
NoteStartsWith | query | string | No | |
NoteEndsWith | query | string | No | |
NoteContains | query | string | No | |
NoteLike | query | string | No | |
NoteBetween | query | string[] | No | |
NoteIn | query | string[] | No | |
AgedOut | query | bool? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TransID | form | string | No | |
DebtorID | form | string | No | |
AccountNo | form | string | No | |
Name | form | string | No | |
TranDate | form | DateTime? | No | |
DueDate | form | DateTime? | No | |
InvRemitNo | form | string | No | |
DebitCredit | form | bool | No | |
Amount | form | decimal? | No | |
AllocatedAmount | form | decimal? | No | |
GSTAmount | form | decimal? | No | |
OutstandingAmount | form | decimal? | No | |
Description | form | string | No | |
SourceID | form | string | No | |
Ref | form | string | No | |
Remark | form | string | No | |
Note | form | string | No | |
AgedOut | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /xml/reply/v_Jiwa_Debtor_Transactions_ListQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<v_Jiwa_Debtor_Transactions_ListQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables">
<Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
<Include xmlns="http://schemas.servicestack.net/types">String</Include>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
<OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
<OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
<Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
<Take xmlns="http://schemas.servicestack.net/types">0</Take>
<AccountNo>String</AccountNo>
<AccountNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</AccountNoBetween>
<AccountNoContains>String</AccountNoContains>
<AccountNoEndsWith>String</AccountNoEndsWith>
<AccountNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</AccountNoIn>
<AccountNoLike>String</AccountNoLike>
<AccountNoStartsWith>String</AccountNoStartsWith>
<AgedOut>false</AgedOut>
<AllocatedAmount>0</AllocatedAmount>
<AllocatedAmountBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</AllocatedAmountBetween>
<AllocatedAmountGreaterThan>0</AllocatedAmountGreaterThan>
<AllocatedAmountGreaterThanOrEqualTo>0</AllocatedAmountGreaterThanOrEqualTo>
<AllocatedAmountIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</AllocatedAmountIn>
<AllocatedAmountLessThan>0</AllocatedAmountLessThan>
<AllocatedAmountLessThanOrEqualTo>0</AllocatedAmountLessThanOrEqualTo>
<AllocatedAmountNotEqualTo>0</AllocatedAmountNotEqualTo>
<Amount>0</Amount>
<AmountBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</AmountBetween>
<AmountGreaterThan>0</AmountGreaterThan>
<AmountGreaterThanOrEqualTo>0</AmountGreaterThanOrEqualTo>
<AmountIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</AmountIn>
<AmountLessThan>0</AmountLessThan>
<AmountLessThanOrEqualTo>0</AmountLessThanOrEqualTo>
<AmountNotEqualTo>0</AmountNotEqualTo>
<DebitCredit>false</DebitCredit>
<DebtorID>String</DebtorID>
<DebtorIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</DebtorIDBetween>
<DebtorIDContains>String</DebtorIDContains>
<DebtorIDEndsWith>String</DebtorIDEndsWith>
<DebtorIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</DebtorIDIn>
<DebtorIDLike>String</DebtorIDLike>
<DebtorIDStartsWith>String</DebtorIDStartsWith>
<Description>String</Description>
<DescriptionBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</DescriptionBetween>
<DescriptionContains>String</DescriptionContains>
<DescriptionEndsWith>String</DescriptionEndsWith>
<DescriptionIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</DescriptionIn>
<DescriptionLike>String</DescriptionLike>
<DescriptionStartsWith>String</DescriptionStartsWith>
<DueDate>0001-01-01T00:00:00</DueDate>
<DueDateBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</DueDateBetween>
<DueDateGreaterThan>0001-01-01T00:00:00</DueDateGreaterThan>
<DueDateGreaterThanOrEqualTo>0001-01-01T00:00:00</DueDateGreaterThanOrEqualTo>
<DueDateIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</DueDateIn>
<DueDateLessThan>0001-01-01T00:00:00</DueDateLessThan>
<DueDateLessThanOrEqualTo>0001-01-01T00:00:00</DueDateLessThanOrEqualTo>
<DueDateNotEqualTo>0001-01-01T00:00:00</DueDateNotEqualTo>
<GSTAmount>0</GSTAmount>
<GSTAmountBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</GSTAmountBetween>
<GSTAmountGreaterThan>0</GSTAmountGreaterThan>
<GSTAmountGreaterThanOrEqualTo>0</GSTAmountGreaterThanOrEqualTo>
<GSTAmountIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</GSTAmountIn>
<GSTAmountLessThan>0</GSTAmountLessThan>
<GSTAmountLessThanOrEqualTo>0</GSTAmountLessThanOrEqualTo>
<GSTAmountNotEqualTo>0</GSTAmountNotEqualTo>
<InvRemitNo>String</InvRemitNo>
<InvRemitNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</InvRemitNoBetween>
<InvRemitNoContains>String</InvRemitNoContains>
<InvRemitNoEndsWith>String</InvRemitNoEndsWith>
<InvRemitNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</InvRemitNoIn>
<InvRemitNoLike>String</InvRemitNoLike>
<InvRemitNoStartsWith>String</InvRemitNoStartsWith>
<Name>String</Name>
<NameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</NameBetween>
<NameContains>String</NameContains>
<NameEndsWith>String</NameEndsWith>
<NameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</NameIn>
<NameLike>String</NameLike>
<NameStartsWith>String</NameStartsWith>
<Note>String</Note>
<NoteBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</NoteBetween>
<NoteContains>String</NoteContains>
<NoteEndsWith>String</NoteEndsWith>
<NoteIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</NoteIn>
<NoteLike>String</NoteLike>
<NoteStartsWith>String</NoteStartsWith>
<OutstandingAmount>0</OutstandingAmount>
<OutstandingAmountBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</OutstandingAmountBetween>
<OutstandingAmountGreaterThan>0</OutstandingAmountGreaterThan>
<OutstandingAmountGreaterThanOrEqualTo>0</OutstandingAmountGreaterThanOrEqualTo>
<OutstandingAmountIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>0</d2p1:decimal>
</OutstandingAmountIn>
<OutstandingAmountLessThan>0</OutstandingAmountLessThan>
<OutstandingAmountLessThanOrEqualTo>0</OutstandingAmountLessThanOrEqualTo>
<OutstandingAmountNotEqualTo>0</OutstandingAmountNotEqualTo>
<Ref>String</Ref>
<RefBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</RefBetween>
<RefContains>String</RefContains>
<RefEndsWith>String</RefEndsWith>
<RefIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</RefIn>
<RefLike>String</RefLike>
<RefStartsWith>String</RefStartsWith>
<Remark>String</Remark>
<RemarkBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</RemarkBetween>
<RemarkContains>String</RemarkContains>
<RemarkEndsWith>String</RemarkEndsWith>
<RemarkIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</RemarkIn>
<RemarkLike>String</RemarkLike>
<RemarkStartsWith>String</RemarkStartsWith>
<SourceID>String</SourceID>
<SourceIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</SourceIDBetween>
<SourceIDContains>String</SourceIDContains>
<SourceIDEndsWith>String</SourceIDEndsWith>
<SourceIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</SourceIDIn>
<SourceIDLike>String</SourceIDLike>
<SourceIDStartsWith>String</SourceIDStartsWith>
<TranDate>0001-01-01T00:00:00</TranDate>
<TranDateBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</TranDateBetween>
<TranDateGreaterThan>0001-01-01T00:00:00</TranDateGreaterThan>
<TranDateGreaterThanOrEqualTo>0001-01-01T00:00:00</TranDateGreaterThanOrEqualTo>
<TranDateIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
</TranDateIn>
<TranDateLessThan>0001-01-01T00:00:00</TranDateLessThan>
<TranDateLessThanOrEqualTo>0001-01-01T00:00:00</TranDateLessThanOrEqualTo>
<TranDateNotEqualTo>0001-01-01T00:00:00</TranDateNotEqualTo>
<TransID>String</TransID>
<TransIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</TransIDBetween>
<TransIDContains>String</TransIDContains>
<TransIDEndsWith>String</TransIDEndsWith>
<TransIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</TransIDIn>
<TransIDLike>String</TransIDLike>
<TransIDStartsWith>String</TransIDStartsWith>
</v_Jiwa_Debtor_Transactions_ListQuery>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfv_Jiwa_Debtor_Transactions_List7kRqkrSv xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types"> <Offset>0</Offset> <Total>0</Total> <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables"> <d2p1:v_Jiwa_Debtor_Transactions_List> <d2p1:_x003C_AccountNo_x003E_k__BackingField>String</d2p1:_x003C_AccountNo_x003E_k__BackingField> <d2p1:_x003C_AgedOut_x003E_k__BackingField>false</d2p1:_x003C_AgedOut_x003E_k__BackingField> <d2p1:_x003C_AllocatedAmount_x003E_k__BackingField>0</d2p1:_x003C_AllocatedAmount_x003E_k__BackingField> <d2p1:_x003C_Amount_x003E_k__BackingField>0</d2p1:_x003C_Amount_x003E_k__BackingField> <d2p1:_x003C_DebitCredit_x003E_k__BackingField>false</d2p1:_x003C_DebitCredit_x003E_k__BackingField> <d2p1:_x003C_DebtorID_x003E_k__BackingField>String</d2p1:_x003C_DebtorID_x003E_k__BackingField> <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField> <d2p1:_x003C_DueDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_DueDate_x003E_k__BackingField> <d2p1:_x003C_GSTAmount_x003E_k__BackingField>0</d2p1:_x003C_GSTAmount_x003E_k__BackingField> <d2p1:_x003C_InvRemitNo_x003E_k__BackingField>String</d2p1:_x003C_InvRemitNo_x003E_k__BackingField> <d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_x003E_k__BackingField> <d2p1:_x003C_Note_x003E_k__BackingField>String</d2p1:_x003C_Note_x003E_k__BackingField> <d2p1:_x003C_OutstandingAmount_x003E_k__BackingField>0</d2p1:_x003C_OutstandingAmount_x003E_k__BackingField> <d2p1:_x003C_Ref_x003E_k__BackingField>String</d2p1:_x003C_Ref_x003E_k__BackingField> <d2p1:_x003C_Remark_x003E_k__BackingField>String</d2p1:_x003C_Remark_x003E_k__BackingField> <d2p1:_x003C_SourceID_x003E_k__BackingField>String</d2p1:_x003C_SourceID_x003E_k__BackingField> <d2p1:_x003C_TranDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_TranDate_x003E_k__BackingField> <d2p1:_x003C_TransID_x003E_k__BackingField>String</d2p1:_x003C_TransID_x003E_k__BackingField> </d2p1:v_Jiwa_Debtor_Transactions_List> </Results> <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>String</d2p1:Key> <d2p1:Value>String</d2p1:Value> </d2p1:KeyValueOfstringstring> </Meta> <ResponseStatus> <ErrorCode>String</ErrorCode> <Message>String</Message> <StackTrace>String</StackTrace> <Errors> <ResponseError> <ErrorCode>String</ErrorCode> <FieldName>String</FieldName> <Message>String</Message> <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </Meta> </ResponseError> </Errors> <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </Meta> </ResponseStatus> </QueryResponseOfv_Jiwa_Debtor_Transactions_List7kRqkrSv>