JiwaAPI

<back to all web services

JB_PaymentDetailsQuery

Requires Authentication
JB_PaymentDetailsQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
JobNoquerystringNo
JobNoStartsWithquerystringNo
JobNoEndsWithquerystringNo
JobNoContainsquerystringNo
JobNoLikequerystringNo
JobNoBetweenquerystring[]No
JobNoInquerystring[]No
InvoiceIDquerystringNo
InvoiceIDStartsWithquerystringNo
InvoiceIDEndsWithquerystringNo
InvoiceIDContainsquerystringNo
InvoiceIDLikequerystringNo
InvoiceIDBetweenquerystring[]No
InvoiceIDInquerystring[]No
CostEntryLineIDquerystringNo
CostEntryLineIDStartsWithquerystringNo
CostEntryLineIDEndsWithquerystringNo
CostEntryLineIDContainsquerystringNo
CostEntryLineIDLikequerystringNo
CostEntryLineIDBetweenquerystring[]No
CostEntryLineIDInquerystring[]No
InvoiceTypequeryshort?No
InvoiceTypeGreaterThanOrEqualToqueryshort?No
InvoiceTypeGreaterThanqueryshort?No
InvoiceTypeLessThanqueryshort?No
InvoiceTypeLessThanOrEqualToqueryshort?No
InvoiceTypeNotEqualToqueryshort?No
InvoiceTypeBetweenqueryshort[]No
InvoiceTypeInqueryshort[]No
BillAmountquerydecimal?No
BillAmountGreaterThanOrEqualToquerydecimal?No
BillAmountGreaterThanquerydecimal?No
BillAmountLessThanquerydecimal?No
BillAmountLessThanOrEqualToquerydecimal?No
BillAmountNotEqualToquerydecimal?No
BillAmountBetweenquerydecimal[]No
BillAmountInquerydecimal[]No
CostAmountquerydecimal?No
CostAmountGreaterThanOrEqualToquerydecimal?No
CostAmountGreaterThanquerydecimal?No
CostAmountLessThanquerydecimal?No
CostAmountLessThanOrEqualToquerydecimal?No
CostAmountNotEqualToquerydecimal?No
CostAmountBetweenquerydecimal[]No
CostAmountInquerydecimal[]No
Statusqueryshort?No
StatusGreaterThanOrEqualToqueryshort?No
StatusGreaterThanqueryshort?No
StatusLessThanqueryshort?No
StatusLessThanOrEqualToqueryshort?No
StatusNotEqualToqueryshort?No
StatusBetweenqueryshort[]No
StatusInqueryshort[]No
WriteBillquerydecimal?No
WriteBillGreaterThanOrEqualToquerydecimal?No
WriteBillGreaterThanquerydecimal?No
WriteBillLessThanquerydecimal?No
WriteBillLessThanOrEqualToquerydecimal?No
WriteBillNotEqualToquerydecimal?No
WriteBillBetweenquerydecimal[]No
WriteBillInquerydecimal[]No
WriteCostquerydecimal?No
WriteCostGreaterThanOrEqualToquerydecimal?No
WriteCostGreaterThanquerydecimal?No
WriteCostLessThanquerydecimal?No
WriteCostLessThanOrEqualToquerydecimal?No
WriteCostNotEqualToquerydecimal?No
WriteCostBetweenquerydecimal[]No
WriteCostInquerydecimal[]No
LinkLineIDquerystringNo
LinkLineIDStartsWithquerystringNo
LinkLineIDEndsWithquerystringNo
LinkLineIDContainsquerystringNo
LinkLineIDLikequerystringNo
LinkLineIDBetweenquerystring[]No
LinkLineIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
JB_PaymentDetails Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
JobNoformstringNo
InvoiceIDformstringNo
CostEntryLineIDformstringNo
InvoiceTypeformshortNo
BillAmountformdecimalNo
CostAmountformdecimalNo
StatusformshortNo
WriteBillformdecimalNo
WriteCostformdecimalNo
LinkLineIDformstringNo
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 .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.

POST /csv/reply/JB_PaymentDetailsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"RecID":"String","RecIDStartsWith":"String","RecIDEndsWith":"String","RecIDContains":"String","RecIDLike":"String","RecIDBetween":["String"],"RecIDIn":["String"],"JobNo":"String","JobNoStartsWith":"String","JobNoEndsWith":"String","JobNoContains":"String","JobNoLike":"String","JobNoBetween":["String"],"JobNoIn":["String"],"InvoiceID":"String","InvoiceIDStartsWith":"String","InvoiceIDEndsWith":"String","InvoiceIDContains":"String","InvoiceIDLike":"String","InvoiceIDBetween":["String"],"InvoiceIDIn":["String"],"CostEntryLineID":"String","CostEntryLineIDStartsWith":"String","CostEntryLineIDEndsWith":"String","CostEntryLineIDContains":"String","CostEntryLineIDLike":"String","CostEntryLineIDBetween":["String"],"CostEntryLineIDIn":["String"],"InvoiceType":0,"InvoiceTypeGreaterThanOrEqualTo":0,"InvoiceTypeGreaterThan":0,"InvoiceTypeLessThan":0,"InvoiceTypeLessThanOrEqualTo":0,"InvoiceTypeNotEqualTo":0,"InvoiceTypeBetween":[0],"InvoiceTypeIn":[0],"BillAmount":0,"BillAmountGreaterThanOrEqualTo":0,"BillAmountGreaterThan":0,"BillAmountLessThan":0,"BillAmountLessThanOrEqualTo":0,"BillAmountNotEqualTo":0,"BillAmountBetween":[0],"BillAmountIn":[0],"CostAmount":0,"CostAmountGreaterThanOrEqualTo":0,"CostAmountGreaterThan":0,"CostAmountLessThan":0,"CostAmountLessThanOrEqualTo":0,"CostAmountNotEqualTo":0,"CostAmountBetween":[0],"CostAmountIn":[0],"Status":0,"StatusGreaterThanOrEqualTo":0,"StatusGreaterThan":0,"StatusLessThan":0,"StatusLessThanOrEqualTo":0,"StatusNotEqualTo":0,"StatusBetween":[0],"StatusIn":[0],"WriteBill":0,"WriteBillGreaterThanOrEqualTo":0,"WriteBillGreaterThan":0,"WriteBillLessThan":0,"WriteBillLessThanOrEqualTo":0,"WriteBillNotEqualTo":0,"WriteBillBetween":[0],"WriteBillIn":[0],"WriteCost":0,"WriteCostGreaterThanOrEqualTo":0,"WriteCostGreaterThan":0,"WriteCostLessThan":0,"WriteCostLessThanOrEqualTo":0,"WriteCostNotEqualTo":0,"WriteCostBetween":[0],"WriteCostIn":[0],"LinkLineID":"String","LinkLineIDStartsWith":"String","LinkLineIDEndsWith":"String","LinkLineIDContains":"String","LinkLineIDLike":"String","LinkLineIDBetween":["String"],"LinkLineIDIn":["String"],"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Results":[{"RecID":"String","JobNo":"String","InvoiceID":"String","CostEntryLineID":"String","LinkLineID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}