JiwaAPI

<back to all web services

TX_MainQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/TX_MainRetrieves a list of tax rates.
TX_MainQuery Parameters:
NameParameterData TypeRequiredDescription
TaxIDquerystringNo
TaxIDStartsWithquerystringNo
TaxIDEndsWithquerystringNo
TaxIDContainsquerystringNo
TaxIDLikequerystringNo
TaxIDBetweenquerystring[]No
TaxIDInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
TaxRatequerydecimal?No
TaxRateGreaterThanOrEqualToquerydecimal?No
TaxRateGreaterThanquerydecimal?No
TaxRateLessThanquerydecimal?No
TaxRateLessThanOrEqualToquerydecimal?No
TaxRateNotEqualToquerydecimal?No
TaxRateBetweenqueryNullable<Decimal>[]No
TaxRateInqueryNullable<Decimal>[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
S1querystringNo
S1StartsWithquerystringNo
S1EndsWithquerystringNo
S1ContainsquerystringNo
S1LikequerystringNo
S1Betweenquerystring[]No
S1Inquerystring[]No
S2querystringNo
S2StartsWithquerystringNo
S2EndsWithquerystringNo
S2ContainsquerystringNo
S2LikequerystringNo
S2Betweenquerystring[]No
S2Inquerystring[]No
S3querystringNo
S3StartsWithquerystringNo
S3EndsWithquerystringNo
S3ContainsquerystringNo
S3LikequerystringNo
S3Betweenquerystring[]No
S3Inquerystring[]No
S4querystringNo
S4StartsWithquerystringNo
S4EndsWithquerystringNo
S4ContainsquerystringNo
S4LikequerystringNo
S4Betweenquerystring[]No
S4Inquerystring[]No
DefaultRatequeryint?No
DefaultRateGreaterThanOrEqualToqueryint?No
DefaultRateGreaterThanqueryint?No
DefaultRateLessThanqueryint?No
DefaultRateLessThanOrEqualToqueryint?No
DefaultRateNotEqualToqueryint?No
DefaultRateBetweenqueryNullable<Int32>[]No
DefaultRateInqueryNullable<Int32>[]No
GSTTaxGroupqueryint?No
GSTTaxGroupGreaterThanOrEqualToqueryint?No
GSTTaxGroupGreaterThanqueryint?No
GSTTaxGroupLessThanqueryint?No
GSTTaxGroupLessThanOrEqualToqueryint?No
GSTTaxGroupNotEqualToqueryint?No
GSTTaxGroupBetweenqueryint[]No
GSTTaxGroupInqueryint[]No
DefaultRateInGroupquerybool?No
BASCodequeryint?No
BASCodeGreaterThanOrEqualToqueryint?No
BASCodeGreaterThanqueryint?No
BASCodeLessThanqueryint?No
BASCodeLessThanOrEqualToqueryint?No
BASCodeNotEqualToqueryint?No
BASCodeBetweenqueryNullable<Int32>[]No
BASCodeInqueryNullable<Int32>[]No
Disabledquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
TX_Main Parameters:
NameParameterData TypeRequiredDescription
TaxIDformstringNo
DescriptionformstringNo
TaxRateformdecimal?No
LastSavedDateTimeformDateTime?No
S1formstringNo
S2formstringNo
S3formstringNo
S4formstringNo
DefaultRateformint?No
GSTTaxGroupformintNo
DefaultRateInGroupformboolNo
BASCodeformint?No
DisabledformboolNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

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 /Queries/TX_Main HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfTX_Main7kRqkrSv 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:TX_Main>
      <d2p1:_x003C_BASCode_x003E_k__BackingField>0</d2p1:_x003C_BASCode_x003E_k__BackingField>
      <d2p1:_x003C_DefaultRateInGroup_x003E_k__BackingField>false</d2p1:_x003C_DefaultRateInGroup_x003E_k__BackingField>
      <d2p1:_x003C_DefaultRate_x003E_k__BackingField>0</d2p1:_x003C_DefaultRate_x003E_k__BackingField>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_Disabled_x003E_k__BackingField>false</d2p1:_x003C_Disabled_x003E_k__BackingField>
      <d2p1:_x003C_GSTTaxGroup_x003E_k__BackingField>0</d2p1:_x003C_GSTTaxGroup_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_S1_x003E_k__BackingField>String</d2p1:_x003C_S1_x003E_k__BackingField>
      <d2p1:_x003C_S2_x003E_k__BackingField>String</d2p1:_x003C_S2_x003E_k__BackingField>
      <d2p1:_x003C_S3_x003E_k__BackingField>String</d2p1:_x003C_S3_x003E_k__BackingField>
      <d2p1:_x003C_S4_x003E_k__BackingField>String</d2p1:_x003C_S4_x003E_k__BackingField>
      <d2p1:_x003C_TaxID_x003E_k__BackingField>String</d2p1:_x003C_TaxID_x003E_k__BackingField>
      <d2p1:_x003C_TaxRate_x003E_k__BackingField>0</d2p1:_x003C_TaxRate_x003E_k__BackingField>
    </d2p1:TX_Main>
  </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>
</QueryResponseOfTX_Main7kRqkrSv>