JiwaAPI

<back to all web services

BR_DirectCreditorPaymentsQuery

Requires Authentication
BR_DirectCreditorPaymentsQuery Parameters:
NameParameterData TypeRequiredDescription
DirectCreditorPaymentIDquerystringNo
DirectCreditorPaymentIDStartsWithquerystringNo
DirectCreditorPaymentIDEndsWithquerystringNo
DirectCreditorPaymentIDContainsquerystringNo
DirectCreditorPaymentIDLikequerystringNo
DirectCreditorPaymentIDBetweenquerystring[]No
DirectCreditorPaymentIDInquerystring[]No
BankRecIDquerystringNo
BankRecIDStartsWithquerystringNo
BankRecIDEndsWithquerystringNo
BankRecIDContainsquerystringNo
BankRecIDLikequerystringNo
BankRecIDBetweenquerystring[]No
BankRecIDInquerystring[]No
CreatedByStaffIDquerystringNo
CreatedByStaffIDStartsWithquerystringNo
CreatedByStaffIDEndsWithquerystringNo
CreatedByStaffIDContainsquerystringNo
CreatedByStaffIDLikequerystringNo
CreatedByStaffIDBetweenquerystring[]No
CreatedByStaffIDInquerystring[]No
CreatedDateTimequeryDateTime?No
CreatedDateTimeGreaterThanOrEqualToqueryDateTime?No
CreatedDateTimeGreaterThanqueryDateTime?No
CreatedDateTimeLessThanqueryDateTime?No
CreatedDateTimeLessThanOrEqualToqueryDateTime?No
CreatedDateTimeNotEqualToqueryDateTime?No
CreatedDateTimeBetweenqueryNullable<DateTime>[]No
CreatedDateTimeInqueryNullable<DateTime>[]No
LastSavedByStaffIDquerystringNo
LastSavedByStaffIDStartsWithquerystringNo
LastSavedByStaffIDEndsWithquerystringNo
LastSavedByStaffIDContainsquerystringNo
LastSavedByStaffIDLikequerystringNo
LastSavedByStaffIDBetweenquerystring[]No
LastSavedByStaffIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
LineNumberqueryint?No
LineNumberGreaterThanOrEqualToqueryint?No
LineNumberGreaterThanqueryint?No
LineNumberLessThanqueryint?No
LineNumberLessThanOrEqualToqueryint?No
LineNumberNotEqualToqueryint?No
LineNumberBetweenqueryNullable<Int32>[]No
LineNumberInqueryNullable<Int32>[]No
TransactionDateTimequeryDateTime?No
TransactionDateTimeGreaterThanOrEqualToqueryDateTime?No
TransactionDateTimeGreaterThanqueryDateTime?No
TransactionDateTimeLessThanqueryDateTime?No
TransactionDateTimeLessThanOrEqualToqueryDateTime?No
TransactionDateTimeNotEqualToqueryDateTime?No
TransactionDateTimeBetweenqueryNullable<DateTime>[]No
TransactionDateTimeInqueryNullable<DateTime>[]No
AmountIncGSTquerydecimal?No
AmountIncGSTGreaterThanOrEqualToquerydecimal?No
AmountIncGSTGreaterThanquerydecimal?No
AmountIncGSTLessThanquerydecimal?No
AmountIncGSTLessThanOrEqualToquerydecimal?No
AmountIncGSTNotEqualToquerydecimal?No
AmountIncGSTBetweenqueryNullable<Decimal>[]No
AmountIncGSTInqueryNullable<Decimal>[]No
DebitCreditquerybyte?No
DebitCreditGreaterThanOrEqualToquerybyte?No
DebitCreditGreaterThanquerybyte?No
DebitCreditLessThanquerybyte?No
DebitCreditLessThanOrEqualToquerybyte?No
DebitCreditNotEqualToquerybyte?No
DebitCreditBetweenqueryNullable<Byte>[]No
DebitCreditInqueryNullable<Byte>[]No
RemarkquerystringNo
RemarkStartsWithquerystringNo
RemarkEndsWithquerystringNo
RemarkContainsquerystringNo
RemarkLikequerystringNo
RemarkBetweenquerystring[]No
RemarkInquerystring[]No
Statusquerybyte?No
StatusGreaterThanOrEqualToquerybyte?No
StatusGreaterThanquerybyte?No
StatusLessThanquerybyte?No
StatusLessThanOrEqualToquerybyte?No
StatusNotEqualToquerybyte?No
StatusBetweenqueryNullable<Byte>[]No
StatusInqueryNullable<Byte>[]No
GLLedgerIDquerystringNo
GLLedgerIDStartsWithquerystringNo
GLLedgerIDEndsWithquerystringNo
GLLedgerIDContainsquerystringNo
GLLedgerIDLikequerystringNo
GLLedgerIDBetweenquerystring[]No
GLLedgerIDInquerystring[]No
CreditorIDquerystringNo
CreditorIDStartsWithquerystringNo
CreditorIDEndsWithquerystringNo
CreditorIDContainsquerystringNo
CreditorIDLikequerystringNo
CreditorIDBetweenquerystring[]No
CreditorIDInquerystring[]No
DiscountGLLedgerIDquerystringNo
DiscountGLLedgerIDStartsWithquerystringNo
DiscountGLLedgerIDEndsWithquerystringNo
DiscountGLLedgerIDContainsquerystringNo
DiscountGLLedgerIDLikequerystringNo
DiscountGLLedgerIDBetweenquerystring[]No
DiscountGLLedgerIDInquerystring[]No
DiscountAmountIncGSTquerydecimal?No
DiscountAmountIncGSTGreaterThanOrEqualToquerydecimal?No
DiscountAmountIncGSTGreaterThanquerydecimal?No
DiscountAmountIncGSTLessThanquerydecimal?No
DiscountAmountIncGSTLessThanOrEqualToquerydecimal?No
DiscountAmountIncGSTNotEqualToquerydecimal?No
DiscountAmountIncGSTBetweenqueryNullable<Decimal>[]No
DiscountAmountIncGSTInqueryNullable<Decimal>[]No
BankNamequerystringNo
BankNameStartsWithquerystringNo
BankNameEndsWithquerystringNo
BankNameContainsquerystringNo
BankNameLikequerystringNo
BankNameBetweenquerystring[]No
BankNameInquerystring[]No
BankAccountNoquerystringNo
BankAccountNoStartsWithquerystringNo
BankAccountNoEndsWithquerystringNo
BankAccountNoContainsquerystringNo
BankAccountNoLikequerystringNo
BankAccountNoBetweenquerystring[]No
BankAccountNoInquerystring[]No
BSBNquerystringNo
BSBNStartsWithquerystringNo
BSBNEndsWithquerystringNo
BSBNContainsquerystringNo
BSBNLikequerystringNo
BSBNBetweenquerystring[]No
BSBNInquerystring[]No
BankAccountNamequerystringNo
BankAccountNameStartsWithquerystringNo
BankAccountNameEndsWithquerystringNo
BankAccountNameContainsquerystringNo
BankAccountNameLikequerystringNo
BankAccountNameBetweenquerystring[]No
BankAccountNameInquerystring[]No
DiscountTaxIDquerystringNo
DiscountTaxIDStartsWithquerystringNo
DiscountTaxIDEndsWithquerystringNo
DiscountTaxIDContainsquerystringNo
DiscountTaxIDLikequerystringNo
DiscountTaxIDBetweenquerystring[]No
DiscountTaxIDInquerystring[]No
DiscountTaxAmountquerydecimal?No
DiscountTaxAmountGreaterThanOrEqualToquerydecimal?No
DiscountTaxAmountGreaterThanquerydecimal?No
DiscountTaxAmountLessThanquerydecimal?No
DiscountTaxAmountLessThanOrEqualToquerydecimal?No
DiscountTaxAmountNotEqualToquerydecimal?No
DiscountTaxAmountBetweenqueryNullable<Decimal>[]No
DiscountTaxAmountInqueryNullable<Decimal>[]No
DiscountTaxRatequerydecimal?No
DiscountTaxRateGreaterThanOrEqualToquerydecimal?No
DiscountTaxRateGreaterThanquerydecimal?No
DiscountTaxRateLessThanquerydecimal?No
DiscountTaxRateLessThanOrEqualToquerydecimal?No
DiscountTaxRateNotEqualToquerydecimal?No
DiscountTaxRateBetweenqueryNullable<Decimal>[]No
DiscountTaxRateInqueryNullable<Decimal>[]No
AmountReconciledIncGSTquerydecimal?No
AmountReconciledIncGSTGreaterThanOrEqualToquerydecimal?No
AmountReconciledIncGSTGreaterThanquerydecimal?No
AmountReconciledIncGSTLessThanquerydecimal?No
AmountReconciledIncGSTLessThanOrEqualToquerydecimal?No
AmountReconciledIncGSTNotEqualToquerydecimal?No
AmountReconciledIncGSTBetweenqueryNullable<Decimal>[]No
AmountReconciledIncGSTInqueryNullable<Decimal>[]No
ReferencequerystringNo
ReferenceStartsWithquerystringNo
ReferenceEndsWithquerystringNo
ReferenceContainsquerystringNo
ReferenceLikequerystringNo
ReferenceBetweenquerystring[]No
ReferenceInquerystring[]No
PaymentTypeIDquerystringNo
PaymentTypeIDStartsWithquerystringNo
PaymentTypeIDEndsWithquerystringNo
PaymentTypeIDContainsquerystringNo
PaymentTypeIDLikequerystringNo
PaymentTypeIDBetweenquerystring[]No
PaymentTypeIDInquerystring[]No
RemitNoquerystringNo
RemitNoStartsWithquerystringNo
RemitNoEndsWithquerystringNo
RemitNoContainsquerystringNo
RemitNoLikequerystringNo
RemitNoBetweenquerystring[]No
RemitNoInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
BR_DirectCreditorPayments Parameters:
NameParameterData TypeRequiredDescription
DirectCreditorPaymentIDformstringNo
BankRecIDformstringNo
CreatedByStaffIDformstringNo
CreatedDateTimeformDateTime?No
LastSavedByStaffIDformstringNo
LastSavedDateTimeformDateTime?No
LineNumberformint?No
TransactionDateTimeformDateTime?No
AmountIncGSTformdecimal?No
DebitCreditformbyte?No
RemarkformstringNo
Statusformbyte?No
GLLedgerIDformstringNo
CreditorIDformstringNo
DiscountGLLedgerIDformstringNo
DiscountAmountIncGSTformdecimal?No
BankNameformstringNo
BankAccountNoformstringNo
BSBNformstringNo
BankAccountNameformstringNo
DiscountTaxIDformstringNo
DiscountTaxAmountformdecimal?No
DiscountTaxRateformdecimal?No
AmountReconciledIncGSTformdecimal?No
ReferenceformstringNo
PaymentTypeIDformstringNo
RemitNoformstringNo
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/BR_DirectCreditorPaymentsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"DirectCreditorPaymentID":"String","DirectCreditorPaymentIDStartsWith":"String","DirectCreditorPaymentIDEndsWith":"String","DirectCreditorPaymentIDContains":"String","DirectCreditorPaymentIDLike":"String","DirectCreditorPaymentIDBetween":["String"],"DirectCreditorPaymentIDIn":["String"],"BankRecID":"String","BankRecIDStartsWith":"String","BankRecIDEndsWith":"String","BankRecIDContains":"String","BankRecIDLike":"String","BankRecIDBetween":["String"],"BankRecIDIn":["String"],"CreatedByStaffID":"String","CreatedByStaffIDStartsWith":"String","CreatedByStaffIDEndsWith":"String","CreatedByStaffIDContains":"String","CreatedByStaffIDLike":"String","CreatedByStaffIDBetween":["String"],"CreatedByStaffIDIn":["String"],"CreatedDateTime":"0001-01-01T00:00:00.0000000","CreatedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","CreatedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","CreatedDateTimeLessThan":"0001-01-01T00:00:00.0000000","CreatedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","CreatedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","CreatedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"CreatedDateTimeIn":["0001-01-01T00:00:00.0000000"],"LastSavedByStaffID":"String","LastSavedByStaffIDStartsWith":"String","LastSavedByStaffIDEndsWith":"String","LastSavedByStaffIDContains":"String","LastSavedByStaffIDLike":"String","LastSavedByStaffIDBetween":["String"],"LastSavedByStaffIDIn":["String"],"LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"LastSavedDateTimeIn":["0001-01-01T00:00:00.0000000"],"LineNumber":0,"LineNumberGreaterThanOrEqualTo":0,"LineNumberGreaterThan":0,"LineNumberLessThan":0,"LineNumberLessThanOrEqualTo":0,"LineNumberNotEqualTo":0,"LineNumberBetween":[0],"LineNumberIn":[0],"TransactionDateTime":"0001-01-01T00:00:00.0000000","TransactionDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","TransactionDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","TransactionDateTimeLessThan":"0001-01-01T00:00:00.0000000","TransactionDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","TransactionDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","TransactionDateTimeBetween":["0001-01-01T00:00:00.0000000"],"TransactionDateTimeIn":["0001-01-01T00:00:00.0000000"],"AmountIncGST":0,"AmountIncGSTGreaterThanOrEqualTo":0,"AmountIncGSTGreaterThan":0,"AmountIncGSTLessThan":0,"AmountIncGSTLessThanOrEqualTo":0,"AmountIncGSTNotEqualTo":0,"AmountIncGSTBetween":[0],"AmountIncGSTIn":[0],"DebitCredit":0,"DebitCreditGreaterThanOrEqualTo":0,"DebitCreditGreaterThan":0,"DebitCreditLessThan":0,"DebitCreditLessThanOrEqualTo":0,"DebitCreditNotEqualTo":0,"DebitCreditBetween":[0],"DebitCreditIn":[0],"Remark":"String","RemarkStartsWith":"String","RemarkEndsWith":"String","RemarkContains":"String","RemarkLike":"String","RemarkBetween":["String"],"RemarkIn":["String"],"Status":0,"StatusGreaterThanOrEqualTo":0,"StatusGreaterThan":0,"StatusLessThan":0,"StatusLessThanOrEqualTo":0,"StatusNotEqualTo":0,"StatusBetween":[0],"StatusIn":[0],"GLLedgerID":"String","GLLedgerIDStartsWith":"String","GLLedgerIDEndsWith":"String","GLLedgerIDContains":"String","GLLedgerIDLike":"String","GLLedgerIDBetween":["String"],"GLLedgerIDIn":["String"],"CreditorID":"String","CreditorIDStartsWith":"String","CreditorIDEndsWith":"String","CreditorIDContains":"String","CreditorIDLike":"String","CreditorIDBetween":["String"],"CreditorIDIn":["String"],"DiscountGLLedgerID":"String","DiscountGLLedgerIDStartsWith":"String","DiscountGLLedgerIDEndsWith":"String","DiscountGLLedgerIDContains":"String","DiscountGLLedgerIDLike":"String","DiscountGLLedgerIDBetween":["String"],"DiscountGLLedgerIDIn":["String"],"DiscountAmountIncGST":0,"DiscountAmountIncGSTGreaterThanOrEqualTo":0,"DiscountAmountIncGSTGreaterThan":0,"DiscountAmountIncGSTLessThan":0,"DiscountAmountIncGSTLessThanOrEqualTo":0,"DiscountAmountIncGSTNotEqualTo":0,"DiscountAmountIncGSTBetween":[0],"DiscountAmountIncGSTIn":[0],"BankName":"String","BankNameStartsWith":"String","BankNameEndsWith":"String","BankNameContains":"String","BankNameLike":"String","BankNameBetween":["String"],"BankNameIn":["String"],"BankAccountNo":"String","BankAccountNoStartsWith":"String","BankAccountNoEndsWith":"String","BankAccountNoContains":"String","BankAccountNoLike":"String","BankAccountNoBetween":["String"],"BankAccountNoIn":["String"],"BSBN":"String","BSBNStartsWith":"String","BSBNEndsWith":"String","BSBNContains":"String","BSBNLike":"String","BSBNBetween":["String"],"BSBNIn":["String"],"BankAccountName":"String","BankAccountNameStartsWith":"String","BankAccountNameEndsWith":"String","BankAccountNameContains":"String","BankAccountNameLike":"String","BankAccountNameBetween":["String"],"BankAccountNameIn":["String"],"DiscountTaxID":"String","DiscountTaxIDStartsWith":"String","DiscountTaxIDEndsWith":"String","DiscountTaxIDContains":"String","DiscountTaxIDLike":"String","DiscountTaxIDBetween":["String"],"DiscountTaxIDIn":["String"],"DiscountTaxAmount":0,"DiscountTaxAmountGreaterThanOrEqualTo":0,"DiscountTaxAmountGreaterThan":0,"DiscountTaxAmountLessThan":0,"DiscountTaxAmountLessThanOrEqualTo":0,"DiscountTaxAmountNotEqualTo":0,"DiscountTaxAmountBetween":[0],"DiscountTaxAmountIn":[0],"DiscountTaxRate":0,"DiscountTaxRateGreaterThanOrEqualTo":0,"DiscountTaxRateGreaterThan":0,"DiscountTaxRateLessThan":0,"DiscountTaxRateLessThanOrEqualTo":0,"DiscountTaxRateNotEqualTo":0,"DiscountTaxRateBetween":[0],"DiscountTaxRateIn":[0],"AmountReconciledIncGST":0,"AmountReconciledIncGSTGreaterThanOrEqualTo":0,"AmountReconciledIncGSTGreaterThan":0,"AmountReconciledIncGSTLessThan":0,"AmountReconciledIncGSTLessThanOrEqualTo":0,"AmountReconciledIncGSTNotEqualTo":0,"AmountReconciledIncGSTBetween":[0],"AmountReconciledIncGSTIn":[0],"Reference":"String","ReferenceStartsWith":"String","ReferenceEndsWith":"String","ReferenceContains":"String","ReferenceLike":"String","ReferenceBetween":["String"],"ReferenceIn":["String"],"PaymentTypeID":"String","PaymentTypeIDStartsWith":"String","PaymentTypeIDEndsWith":"String","PaymentTypeIDContains":"String","PaymentTypeIDLike":"String","PaymentTypeIDBetween":["String"],"PaymentTypeIDIn":["String"],"RemitNo":"String","RemitNoStartsWith":"String","RemitNoEndsWith":"String","RemitNoContains":"String","RemitNoLike":"String","RemitNoBetween":["String"],"RemitNoIn":["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":[{"DirectCreditorPaymentID":"String","BankRecID":"String","CreatedByStaffID":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","LastSavedByStaffID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","LineNumber":0,"TransactionDateTime":"0001-01-01T00:00:00.0000000","AmountIncGST":0,"DebitCredit":0,"Remark":"String","Status":0,"GLLedgerID":"String","CreditorID":"String","DiscountGLLedgerID":"String","DiscountAmountIncGST":0,"BankName":"String","BankAccountNo":"String","BSBN":"String","BankAccountName":"String","DiscountTaxID":"String","DiscountTaxAmount":0,"DiscountTaxRate":0,"AmountReconciledIncGST":0,"Reference":"String","PaymentTypeID":"String","RemitNo":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}