JiwaAPI

<back to all web services

PI_MainQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/PI_MainRetrieves a list of purchase invoices.
PI_MainQuery Parameters:
NameParameterData TypeRequiredDescription
PI_MainIDquerystringNo
PI_MainIDStartsWithquerystringNo
PI_MainIDEndsWithquerystringNo
PI_MainIDContainsquerystringNo
PI_MainIDLikequerystringNo
PI_MainIDBetweenquerystring[]No
PI_MainIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
InvoiceNoquerystringNo
InvoiceNoStartsWithquerystringNo
InvoiceNoEndsWithquerystringNo
InvoiceNoContainsquerystringNo
InvoiceNoLikequerystringNo
InvoiceNoBetweenquerystring[]No
InvoiceNoInquerystring[]No
CreditorIDquerystringNo
CreditorIDStartsWithquerystringNo
CreditorIDEndsWithquerystringNo
CreditorIDContainsquerystringNo
CreditorIDLikequerystringNo
CreditorIDBetweenquerystring[]No
CreditorIDInquerystring[]No
InvoiceDatequeryDateTime?No
InvoiceDateGreaterThanOrEqualToqueryDateTime?No
InvoiceDateGreaterThanqueryDateTime?No
InvoiceDateLessThanqueryDateTime?No
InvoiceDateLessThanOrEqualToqueryDateTime?No
InvoiceDateNotEqualToqueryDateTime?No
InvoiceDateBetweenqueryNullable<DateTime>[]No
InvoiceDateInqueryNullable<DateTime>[]No
Statusqueryshort?No
StatusGreaterThanOrEqualToqueryshort?No
StatusGreaterThanqueryshort?No
StatusLessThanqueryshort?No
StatusLessThanOrEqualToqueryshort?No
StatusNotEqualToqueryshort?No
StatusBetweenqueryshort[]No
StatusInqueryshort[]No
Freightquerydecimal?No
FreightGreaterThanOrEqualToquerydecimal?No
FreightGreaterThanquerydecimal?No
FreightLessThanquerydecimal?No
FreightLessThanOrEqualToquerydecimal?No
FreightNotEqualToquerydecimal?No
FreightBetweenqueryNullable<Decimal>[]No
FreightInqueryNullable<Decimal>[]No
Dutyquerydecimal?No
DutyGreaterThanOrEqualToquerydecimal?No
DutyGreaterThanquerydecimal?No
DutyLessThanquerydecimal?No
DutyLessThanOrEqualToquerydecimal?No
DutyNotEqualToquerydecimal?No
DutyBetweenqueryNullable<Decimal>[]No
DutyInqueryNullable<Decimal>[]No
Insurancequerydecimal?No
InsuranceGreaterThanOrEqualToquerydecimal?No
InsuranceGreaterThanquerydecimal?No
InsuranceLessThanquerydecimal?No
InsuranceLessThanOrEqualToquerydecimal?No
InsuranceNotEqualToquerydecimal?No
InsuranceBetweenqueryNullable<Decimal>[]No
InsuranceInqueryNullable<Decimal>[]No
DueDatequeryDateTime?No
DueDateGreaterThanOrEqualToqueryDateTime?No
DueDateGreaterThanqueryDateTime?No
DueDateLessThanqueryDateTime?No
DueDateLessThanOrEqualToqueryDateTime?No
DueDateNotEqualToqueryDateTime?No
DueDateBetweenqueryNullable<DateTime>[]No
DueDateInqueryNullable<DateTime>[]No
IN_LogicalIDquerystringNo
IN_LogicalIDStartsWithquerystringNo
IN_LogicalIDEndsWithquerystringNo
IN_LogicalIDContainsquerystringNo
IN_LogicalIDLikequerystringNo
IN_LogicalIDBetweenquerystring[]No
IN_LogicalIDInquerystring[]No
TotalLineTaxquerydecimal?No
TotalLineTaxGreaterThanOrEqualToquerydecimal?No
TotalLineTaxGreaterThanquerydecimal?No
TotalLineTaxLessThanquerydecimal?No
TotalLineTaxLessThanOrEqualToquerydecimal?No
TotalLineTaxNotEqualToquerydecimal?No
TotalLineTaxBetweenquerydecimal[]No
TotalLineTaxInquerydecimal[]No
AdjTaxquerydecimal?No
AdjTaxGreaterThanOrEqualToquerydecimal?No
AdjTaxGreaterThanquerydecimal?No
AdjTaxLessThanquerydecimal?No
AdjTaxLessThanOrEqualToquerydecimal?No
AdjTaxNotEqualToquerydecimal?No
AdjTaxBetweenquerydecimal[]No
AdjTaxInquerydecimal[]No
FreightTaxIDquerystringNo
FreightTaxIDStartsWithquerystringNo
FreightTaxIDEndsWithquerystringNo
FreightTaxIDContainsquerystringNo
FreightTaxIDLikequerystringNo
FreightTaxIDBetweenquerystring[]No
FreightTaxIDInquerystring[]No
FreightTaxRatequerydecimal?No
FreightTaxRateGreaterThanOrEqualToquerydecimal?No
FreightTaxRateGreaterThanquerydecimal?No
FreightTaxRateLessThanquerydecimal?No
FreightTaxRateLessThanOrEqualToquerydecimal?No
FreightTaxRateNotEqualToquerydecimal?No
FreightTaxRateBetweenqueryNullable<Decimal>[]No
FreightTaxRateInqueryNullable<Decimal>[]No
FreightTaxAmountquerydecimal?No
FreightTaxAmountGreaterThanOrEqualToquerydecimal?No
FreightTaxAmountGreaterThanquerydecimal?No
FreightTaxAmountLessThanquerydecimal?No
FreightTaxAmountLessThanOrEqualToquerydecimal?No
FreightTaxAmountNotEqualToquerydecimal?No
FreightTaxAmountBetweenqueryNullable<Decimal>[]No
FreightTaxAmountInqueryNullable<Decimal>[]No
DutyTaxIDquerystringNo
DutyTaxIDStartsWithquerystringNo
DutyTaxIDEndsWithquerystringNo
DutyTaxIDContainsquerystringNo
DutyTaxIDLikequerystringNo
DutyTaxIDBetweenquerystring[]No
DutyTaxIDInquerystring[]No
DutyTaxRatequerydecimal?No
DutyTaxRateGreaterThanOrEqualToquerydecimal?No
DutyTaxRateGreaterThanquerydecimal?No
DutyTaxRateLessThanquerydecimal?No
DutyTaxRateLessThanOrEqualToquerydecimal?No
DutyTaxRateNotEqualToquerydecimal?No
DutyTaxRateBetweenqueryNullable<Decimal>[]No
DutyTaxRateInqueryNullable<Decimal>[]No
DutyTaxAmountquerydecimal?No
DutyTaxAmountGreaterThanOrEqualToquerydecimal?No
DutyTaxAmountGreaterThanquerydecimal?No
DutyTaxAmountLessThanquerydecimal?No
DutyTaxAmountLessThanOrEqualToquerydecimal?No
DutyTaxAmountNotEqualToquerydecimal?No
DutyTaxAmountBetweenqueryNullable<Decimal>[]No
DutyTaxAmountInqueryNullable<Decimal>[]No
InsuranceTaxIDquerystringNo
InsuranceTaxIDStartsWithquerystringNo
InsuranceTaxIDEndsWithquerystringNo
InsuranceTaxIDContainsquerystringNo
InsuranceTaxIDLikequerystringNo
InsuranceTaxIDBetweenquerystring[]No
InsuranceTaxIDInquerystring[]No
InsuranceTaxRatequerydecimal?No
InsuranceTaxRateGreaterThanOrEqualToquerydecimal?No
InsuranceTaxRateGreaterThanquerydecimal?No
InsuranceTaxRateLessThanquerydecimal?No
InsuranceTaxRateLessThanOrEqualToquerydecimal?No
InsuranceTaxRateNotEqualToquerydecimal?No
InsuranceTaxRateBetweenqueryNullable<Decimal>[]No
InsuranceTaxRateInqueryNullable<Decimal>[]No
InsuranceTaxAmountquerydecimal?No
InsuranceTaxAmountGreaterThanOrEqualToquerydecimal?No
InsuranceTaxAmountGreaterThanquerydecimal?No
InsuranceTaxAmountLessThanquerydecimal?No
InsuranceTaxAmountLessThanOrEqualToquerydecimal?No
InsuranceTaxAmountNotEqualToquerydecimal?No
InsuranceTaxAmountBetweenqueryNullable<Decimal>[]No
InsuranceTaxAmountInqueryNullable<Decimal>[]No
CurrencyIDquerystringNo
CurrencyIDStartsWithquerystringNo
CurrencyIDEndsWithquerystringNo
CurrencyIDContainsquerystringNo
CurrencyIDLikequerystringNo
CurrencyIDBetweenquerystring[]No
CurrencyIDInquerystring[]No
DecimalPlacesqueryshort?No
DecimalPlacesGreaterThanOrEqualToqueryshort?No
DecimalPlacesGreaterThanqueryshort?No
DecimalPlacesLessThanqueryshort?No
DecimalPlacesLessThanOrEqualToqueryshort?No
DecimalPlacesNotEqualToqueryshort?No
DecimalPlacesBetweenqueryNullable<Int16>[]No
DecimalPlacesInqueryNullable<Int16>[]No
FXDecimalPlacesqueryshort?No
FXDecimalPlacesGreaterThanOrEqualToqueryshort?No
FXDecimalPlacesGreaterThanqueryshort?No
FXDecimalPlacesLessThanqueryshort?No
FXDecimalPlacesLessThanOrEqualToqueryshort?No
FXDecimalPlacesNotEqualToqueryshort?No
FXDecimalPlacesBetweenqueryNullable<Int16>[]No
FXDecimalPlacesInqueryNullable<Int16>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
PI_Main Parameters:
NameParameterData TypeRequiredDescription
PI_MainIDformstringNo
LastSavedDateTimeformDateTime?No
InvoiceNoformstringNo
CreditorIDformstringNo
InvoiceDateformDateTime?No
StatusformshortNo
Freightformdecimal?No
Dutyformdecimal?No
Insuranceformdecimal?No
DueDateformDateTime?No
IN_LogicalIDformstringNo
TotalLineTaxformdecimalNo
AdjTaxformdecimalNo
FreightTaxIDformstringNo
FreightTaxRateformdecimal?No
FreightTaxAmountformdecimal?No
DutyTaxIDformstringNo
DutyTaxRateformdecimal?No
DutyTaxAmountformdecimal?No
InsuranceTaxIDformstringNo
InsuranceTaxRateformdecimal?No
InsuranceTaxAmountformdecimal?No
CurrencyIDformstringNo
DecimalPlacesformshort?No
FXDecimalPlacesformshort?No
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/PI_Main HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfPI_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:PI_Main>
      <d2p1:_x003C_AdjTax_x003E_k__BackingField>0</d2p1:_x003C_AdjTax_x003E_k__BackingField>
      <d2p1:_x003C_CreditorID_x003E_k__BackingField>String</d2p1:_x003C_CreditorID_x003E_k__BackingField>
      <d2p1:_x003C_CurrencyID_x003E_k__BackingField>String</d2p1:_x003C_CurrencyID_x003E_k__BackingField>
      <d2p1:_x003C_DecimalPlaces_x003E_k__BackingField>0</d2p1:_x003C_DecimalPlaces_x003E_k__BackingField>
      <d2p1:_x003C_DueDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_DueDate_x003E_k__BackingField>
      <d2p1:_x003C_DutyTaxAmount_x003E_k__BackingField>0</d2p1:_x003C_DutyTaxAmount_x003E_k__BackingField>
      <d2p1:_x003C_DutyTaxID_x003E_k__BackingField>String</d2p1:_x003C_DutyTaxID_x003E_k__BackingField>
      <d2p1:_x003C_DutyTaxRate_x003E_k__BackingField>0</d2p1:_x003C_DutyTaxRate_x003E_k__BackingField>
      <d2p1:_x003C_Duty_x003E_k__BackingField>0</d2p1:_x003C_Duty_x003E_k__BackingField>
      <d2p1:_x003C_FXDecimalPlaces_x003E_k__BackingField>0</d2p1:_x003C_FXDecimalPlaces_x003E_k__BackingField>
      <d2p1:_x003C_FreightTaxAmount_x003E_k__BackingField>0</d2p1:_x003C_FreightTaxAmount_x003E_k__BackingField>
      <d2p1:_x003C_FreightTaxID_x003E_k__BackingField>String</d2p1:_x003C_FreightTaxID_x003E_k__BackingField>
      <d2p1:_x003C_FreightTaxRate_x003E_k__BackingField>0</d2p1:_x003C_FreightTaxRate_x003E_k__BackingField>
      <d2p1:_x003C_Freight_x003E_k__BackingField>0</d2p1:_x003C_Freight_x003E_k__BackingField>
      <d2p1:_x003C_IN_LogicalID_x003E_k__BackingField>String</d2p1:_x003C_IN_LogicalID_x003E_k__BackingField>
      <d2p1:_x003C_InsuranceTaxAmount_x003E_k__BackingField>0</d2p1:_x003C_InsuranceTaxAmount_x003E_k__BackingField>
      <d2p1:_x003C_InsuranceTaxID_x003E_k__BackingField>String</d2p1:_x003C_InsuranceTaxID_x003E_k__BackingField>
      <d2p1:_x003C_InsuranceTaxRate_x003E_k__BackingField>0</d2p1:_x003C_InsuranceTaxRate_x003E_k__BackingField>
      <d2p1:_x003C_Insurance_x003E_k__BackingField>0</d2p1:_x003C_Insurance_x003E_k__BackingField>
      <d2p1:_x003C_InvoiceDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_InvoiceDate_x003E_k__BackingField>
      <d2p1:_x003C_InvoiceNo_x003E_k__BackingField>String</d2p1:_x003C_InvoiceNo_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_PI_MainID_x003E_k__BackingField>String</d2p1:_x003C_PI_MainID_x003E_k__BackingField>
      <d2p1:_x003C_Status_x003E_k__BackingField>0</d2p1:_x003C_Status_x003E_k__BackingField>
      <d2p1:_x003C_TotalLineTax_x003E_k__BackingField>0</d2p1:_x003C_TotalLineTax_x003E_k__BackingField>
    </d2p1:PI_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>
</QueryResponseOfPI_Main7kRqkrSv>