JiwaAPI

<back to all web services

CR_PurchasesQuery

Requires Authentication
CR_PurchasesQuery Parameters:
NameParameterData TypeRequiredDescription
CR_PurchIDquerystringNo
CR_PurchIDStartsWithquerystringNo
CR_PurchIDEndsWithquerystringNo
CR_PurchIDContainsquerystringNo
CR_PurchIDLikequerystringNo
CR_PurchIDBetweenquerystring[]No
CR_PurchIDInquerystring[]No
DateRunqueryDateTime?No
DateRunGreaterThanOrEqualToqueryDateTime?No
DateRunGreaterThanqueryDateTime?No
DateRunLessThanqueryDateTime?No
DateRunLessThanOrEqualToqueryDateTime?No
DateRunNotEqualToqueryDateTime?No
DateRunBetweenqueryNullable<DateTime>[]No
DateRunInqueryNullable<DateTime>[]No
InvoiceDatequeryDateTime?No
InvoiceDateGreaterThanOrEqualToqueryDateTime?No
InvoiceDateGreaterThanqueryDateTime?No
InvoiceDateLessThanqueryDateTime?No
InvoiceDateLessThanOrEqualToqueryDateTime?No
InvoiceDateNotEqualToqueryDateTime?No
InvoiceDateBetweenqueryNullable<DateTime>[]No
InvoiceDateInqueryNullable<DateTime>[]No
CreditorIDquerystringNo
CreditorIDStartsWithquerystringNo
CreditorIDEndsWithquerystringNo
CreditorIDContainsquerystringNo
CreditorIDLikequerystringNo
CreditorIDBetweenquerystring[]No
CreditorIDInquerystring[]No
InvoiceNoquerystringNo
InvoiceNoStartsWithquerystringNo
InvoiceNoEndsWithquerystringNo
InvoiceNoContainsquerystringNo
InvoiceNoLikequerystringNo
InvoiceNoBetweenquerystring[]No
InvoiceNoInquerystring[]No
PartNoquerystringNo
PartNoStartsWithquerystringNo
PartNoEndsWithquerystringNo
PartNoContainsquerystringNo
PartNoLikequerystringNo
PartNoBetweenquerystring[]No
PartNoInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
ClassDescriptionquerystringNo
ClassDescriptionStartsWithquerystringNo
ClassDescriptionEndsWithquerystringNo
ClassDescriptionContainsquerystringNo
ClassDescriptionLikequerystringNo
ClassDescriptionBetweenquerystring[]No
ClassDescriptionInquerystring[]No
Quantityquerydecimal?No
QuantityGreaterThanOrEqualToquerydecimal?No
QuantityGreaterThanquerydecimal?No
QuantityLessThanquerydecimal?No
QuantityLessThanOrEqualToquerydecimal?No
QuantityNotEqualToquerydecimal?No
QuantityBetweenqueryNullable<Decimal>[]No
QuantityInqueryNullable<Decimal>[]No
UnitCostquerydecimal?No
UnitCostGreaterThanOrEqualToquerydecimal?No
UnitCostGreaterThanquerydecimal?No
UnitCostLessThanquerydecimal?No
UnitCostLessThanOrEqualToquerydecimal?No
UnitCostNotEqualToquerydecimal?No
UnitCostBetweenqueryNullable<Decimal>[]No
UnitCostInqueryNullable<Decimal>[]No
LineTotalquerydecimal?No
LineTotalGreaterThanOrEqualToquerydecimal?No
LineTotalGreaterThanquerydecimal?No
LineTotalLessThanquerydecimal?No
LineTotalLessThanOrEqualToquerydecimal?No
LineTotalNotEqualToquerydecimal?No
LineTotalBetweenqueryNullable<Decimal>[]No
LineTotalInqueryNullable<Decimal>[]No
InvoiceIDquerystringNo
InvoiceIDStartsWithquerystringNo
InvoiceIDEndsWithquerystringNo
InvoiceIDContainsquerystringNo
InvoiceIDLikequerystringNo
InvoiceIDBetweenquerystring[]No
InvoiceIDInquerystring[]No
InventoryIDquerystringNo
InventoryIDStartsWithquerystringNo
InventoryIDEndsWithquerystringNo
InventoryIDContainsquerystringNo
InventoryIDLikequerystringNo
InventoryIDBetweenquerystring[]No
InventoryIDInquerystring[]No
MonthNoqueryshort?No
MonthNoGreaterThanOrEqualToqueryshort?No
MonthNoGreaterThanqueryshort?No
MonthNoLessThanqueryshort?No
MonthNoLessThanOrEqualToqueryshort?No
MonthNoNotEqualToqueryshort?No
MonthNoBetweenqueryNullable<Int16>[]No
MonthNoInqueryNullable<Int16>[]No
YearNoqueryshort?No
YearNoGreaterThanOrEqualToqueryshort?No
YearNoGreaterThanqueryshort?No
YearNoLessThanqueryshort?No
YearNoLessThanOrEqualToqueryshort?No
YearNoNotEqualToqueryshort?No
YearNoBetweenqueryNullable<Int16>[]No
YearNoInqueryNullable<Int16>[]No
IN_LogicalIDquerystringNo
IN_LogicalIDStartsWithquerystringNo
IN_LogicalIDEndsWithquerystringNo
IN_LogicalIDContainsquerystringNo
IN_LogicalIDLikequerystringNo
IN_LogicalIDBetweenquerystring[]No
IN_LogicalIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
CR_Purchases Parameters:
NameParameterData TypeRequiredDescription
CR_PurchIDformstringNo
DateRunformDateTime?No
InvoiceDateformDateTime?No
CreditorIDformstringNo
InvoiceNoformstringNo
PartNoformstringNo
DescriptionformstringNo
ClassDescriptionformstringNo
Quantityformdecimal?No
UnitCostformdecimal?No
LineTotalformdecimal?No
InvoiceIDformstringNo
InventoryIDformstringNo
MonthNoformshort?No
YearNoformshort?No
IN_LogicalIDformstringNo
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.

POST /xml/reply/CR_PurchasesQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CR_PurchasesQuery 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>
  <CR_PurchID>String</CR_PurchID>
  <CR_PurchIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CR_PurchIDBetween>
  <CR_PurchIDContains>String</CR_PurchIDContains>
  <CR_PurchIDEndsWith>String</CR_PurchIDEndsWith>
  <CR_PurchIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CR_PurchIDIn>
  <CR_PurchIDLike>String</CR_PurchIDLike>
  <CR_PurchIDStartsWith>String</CR_PurchIDStartsWith>
  <ClassDescription>String</ClassDescription>
  <ClassDescriptionBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ClassDescriptionBetween>
  <ClassDescriptionContains>String</ClassDescriptionContains>
  <ClassDescriptionEndsWith>String</ClassDescriptionEndsWith>
  <ClassDescriptionIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ClassDescriptionIn>
  <ClassDescriptionLike>String</ClassDescriptionLike>
  <ClassDescriptionStartsWith>String</ClassDescriptionStartsWith>
  <CreditorID>String</CreditorID>
  <CreditorIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CreditorIDBetween>
  <CreditorIDContains>String</CreditorIDContains>
  <CreditorIDEndsWith>String</CreditorIDEndsWith>
  <CreditorIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CreditorIDIn>
  <CreditorIDLike>String</CreditorIDLike>
  <CreditorIDStartsWith>String</CreditorIDStartsWith>
  <DateRun>0001-01-01T00:00:00</DateRun>
  <DateRunBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </DateRunBetween>
  <DateRunGreaterThan>0001-01-01T00:00:00</DateRunGreaterThan>
  <DateRunGreaterThanOrEqualTo>0001-01-01T00:00:00</DateRunGreaterThanOrEqualTo>
  <DateRunIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </DateRunIn>
  <DateRunLessThan>0001-01-01T00:00:00</DateRunLessThan>
  <DateRunLessThanOrEqualTo>0001-01-01T00:00:00</DateRunLessThanOrEqualTo>
  <DateRunNotEqualTo>0001-01-01T00:00:00</DateRunNotEqualTo>
  <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>
  <IN_LogicalID>String</IN_LogicalID>
  <IN_LogicalIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </IN_LogicalIDBetween>
  <IN_LogicalIDContains>String</IN_LogicalIDContains>
  <IN_LogicalIDEndsWith>String</IN_LogicalIDEndsWith>
  <IN_LogicalIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </IN_LogicalIDIn>
  <IN_LogicalIDLike>String</IN_LogicalIDLike>
  <IN_LogicalIDStartsWith>String</IN_LogicalIDStartsWith>
  <InventoryID>String</InventoryID>
  <InventoryIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InventoryIDBetween>
  <InventoryIDContains>String</InventoryIDContains>
  <InventoryIDEndsWith>String</InventoryIDEndsWith>
  <InventoryIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InventoryIDIn>
  <InventoryIDLike>String</InventoryIDLike>
  <InventoryIDStartsWith>String</InventoryIDStartsWith>
  <InvoiceDate>0001-01-01T00:00:00</InvoiceDate>
  <InvoiceDateBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </InvoiceDateBetween>
  <InvoiceDateGreaterThan>0001-01-01T00:00:00</InvoiceDateGreaterThan>
  <InvoiceDateGreaterThanOrEqualTo>0001-01-01T00:00:00</InvoiceDateGreaterThanOrEqualTo>
  <InvoiceDateIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </InvoiceDateIn>
  <InvoiceDateLessThan>0001-01-01T00:00:00</InvoiceDateLessThan>
  <InvoiceDateLessThanOrEqualTo>0001-01-01T00:00:00</InvoiceDateLessThanOrEqualTo>
  <InvoiceDateNotEqualTo>0001-01-01T00:00:00</InvoiceDateNotEqualTo>
  <InvoiceID>String</InvoiceID>
  <InvoiceIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvoiceIDBetween>
  <InvoiceIDContains>String</InvoiceIDContains>
  <InvoiceIDEndsWith>String</InvoiceIDEndsWith>
  <InvoiceIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvoiceIDIn>
  <InvoiceIDLike>String</InvoiceIDLike>
  <InvoiceIDStartsWith>String</InvoiceIDStartsWith>
  <InvoiceNo>String</InvoiceNo>
  <InvoiceNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvoiceNoBetween>
  <InvoiceNoContains>String</InvoiceNoContains>
  <InvoiceNoEndsWith>String</InvoiceNoEndsWith>
  <InvoiceNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvoiceNoIn>
  <InvoiceNoLike>String</InvoiceNoLike>
  <InvoiceNoStartsWith>String</InvoiceNoStartsWith>
  <LineTotal>0</LineTotal>
  <LineTotalBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </LineTotalBetween>
  <LineTotalGreaterThan>0</LineTotalGreaterThan>
  <LineTotalGreaterThanOrEqualTo>0</LineTotalGreaterThanOrEqualTo>
  <LineTotalIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </LineTotalIn>
  <LineTotalLessThan>0</LineTotalLessThan>
  <LineTotalLessThanOrEqualTo>0</LineTotalLessThanOrEqualTo>
  <LineTotalNotEqualTo>0</LineTotalNotEqualTo>
  <MonthNo>0</MonthNo>
  <MonthNoBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </MonthNoBetween>
  <MonthNoGreaterThan>0</MonthNoGreaterThan>
  <MonthNoGreaterThanOrEqualTo>0</MonthNoGreaterThanOrEqualTo>
  <MonthNoIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </MonthNoIn>
  <MonthNoLessThan>0</MonthNoLessThan>
  <MonthNoLessThanOrEqualTo>0</MonthNoLessThanOrEqualTo>
  <MonthNoNotEqualTo>0</MonthNoNotEqualTo>
  <PartNo>String</PartNo>
  <PartNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PartNoBetween>
  <PartNoContains>String</PartNoContains>
  <PartNoEndsWith>String</PartNoEndsWith>
  <PartNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </PartNoIn>
  <PartNoLike>String</PartNoLike>
  <PartNoStartsWith>String</PartNoStartsWith>
  <Quantity>0</Quantity>
  <QuantityBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </QuantityBetween>
  <QuantityGreaterThan>0</QuantityGreaterThan>
  <QuantityGreaterThanOrEqualTo>0</QuantityGreaterThanOrEqualTo>
  <QuantityIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </QuantityIn>
  <QuantityLessThan>0</QuantityLessThan>
  <QuantityLessThanOrEqualTo>0</QuantityLessThanOrEqualTo>
  <QuantityNotEqualTo>0</QuantityNotEqualTo>
  <UnitCost>0</UnitCost>
  <UnitCostBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </UnitCostBetween>
  <UnitCostGreaterThan>0</UnitCostGreaterThan>
  <UnitCostGreaterThanOrEqualTo>0</UnitCostGreaterThanOrEqualTo>
  <UnitCostIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </UnitCostIn>
  <UnitCostLessThan>0</UnitCostLessThan>
  <UnitCostLessThanOrEqualTo>0</UnitCostLessThanOrEqualTo>
  <UnitCostNotEqualTo>0</UnitCostNotEqualTo>
  <YearNo>0</YearNo>
  <YearNoBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </YearNoBetween>
  <YearNoGreaterThan>0</YearNoGreaterThan>
  <YearNoGreaterThanOrEqualTo>0</YearNoGreaterThanOrEqualTo>
  <YearNoIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </YearNoIn>
  <YearNoLessThan>0</YearNoLessThan>
  <YearNoLessThanOrEqualTo>0</YearNoLessThanOrEqualTo>
  <YearNoNotEqualTo>0</YearNoNotEqualTo>
</CR_PurchasesQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfCR_Purchases7kRqkrSv 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:CR_Purchases>
      <d2p1:_x003C_CR_PurchID_x003E_k__BackingField>String</d2p1:_x003C_CR_PurchID_x003E_k__BackingField>
      <d2p1:_x003C_ClassDescription_x003E_k__BackingField>String</d2p1:_x003C_ClassDescription_x003E_k__BackingField>
      <d2p1:_x003C_CreditorID_x003E_k__BackingField>String</d2p1:_x003C_CreditorID_x003E_k__BackingField>
      <d2p1:_x003C_DateRun_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_DateRun_x003E_k__BackingField>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_IN_LogicalID_x003E_k__BackingField>String</d2p1:_x003C_IN_LogicalID_x003E_k__BackingField>
      <d2p1:_x003C_InventoryID_x003E_k__BackingField>String</d2p1:_x003C_InventoryID_x003E_k__BackingField>
      <d2p1:_x003C_InvoiceDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_InvoiceDate_x003E_k__BackingField>
      <d2p1:_x003C_InvoiceID_x003E_k__BackingField>String</d2p1:_x003C_InvoiceID_x003E_k__BackingField>
      <d2p1:_x003C_InvoiceNo_x003E_k__BackingField>String</d2p1:_x003C_InvoiceNo_x003E_k__BackingField>
      <d2p1:_x003C_LineTotal_x003E_k__BackingField>0</d2p1:_x003C_LineTotal_x003E_k__BackingField>
      <d2p1:_x003C_MonthNo_x003E_k__BackingField>0</d2p1:_x003C_MonthNo_x003E_k__BackingField>
      <d2p1:_x003C_PartNo_x003E_k__BackingField>String</d2p1:_x003C_PartNo_x003E_k__BackingField>
      <d2p1:_x003C_Quantity_x003E_k__BackingField>0</d2p1:_x003C_Quantity_x003E_k__BackingField>
      <d2p1:_x003C_UnitCost_x003E_k__BackingField>0</d2p1:_x003C_UnitCost_x003E_k__BackingField>
      <d2p1:_x003C_YearNo_x003E_k__BackingField>0</d2p1:_x003C_YearNo_x003E_k__BackingField>
    </d2p1:CR_Purchases>
  </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>
</QueryResponseOfCR_Purchases7kRqkrSv>