| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DirectDebtorPaymentID | query | string | No | |
| DirectDebtorPaymentIDStartsWith | query | string | No | |
| DirectDebtorPaymentIDEndsWith | query | string | No | |
| DirectDebtorPaymentIDContains | query | string | No | |
| DirectDebtorPaymentIDLike | query | string | No | |
| DirectDebtorPaymentIDBetween | query | string[] | No | |
| DirectDebtorPaymentIDIn | query | string[] | No | |
| BankRecID | query | string | No | |
| BankRecIDStartsWith | query | string | No | |
| BankRecIDEndsWith | query | string | No | |
| BankRecIDContains | query | string | No | |
| BankRecIDLike | query | string | No | |
| BankRecIDBetween | query | string[] | No | |
| BankRecIDIn | query | string[] | No | |
| CreatedByStaffID | query | string | No | |
| CreatedByStaffIDStartsWith | query | string | No | |
| CreatedByStaffIDEndsWith | query | string | No | |
| CreatedByStaffIDContains | query | string | No | |
| CreatedByStaffIDLike | query | string | No | |
| CreatedByStaffIDBetween | query | string[] | No | |
| CreatedByStaffIDIn | query | string[] | No | |
| CreatedDateTime | query | DateTime? | No | |
| CreatedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
| CreatedDateTimeGreaterThan | query | DateTime? | No | |
| CreatedDateTimeLessThan | query | DateTime? | No | |
| CreatedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
| CreatedDateTimeNotEqualTo | query | DateTime? | No | |
| CreatedDateTimeBetween | query | Nullable<DateTime>[] | No | |
| CreatedDateTimeIn | query | Nullable<DateTime>[] | No | |
| LastSavedByStaffID | query | string | No | |
| LastSavedByStaffIDStartsWith | query | string | No | |
| LastSavedByStaffIDEndsWith | query | string | No | |
| LastSavedByStaffIDContains | query | string | No | |
| LastSavedByStaffIDLike | query | string | No | |
| LastSavedByStaffIDBetween | query | string[] | No | |
| LastSavedByStaffIDIn | query | string[] | No | |
| LastSavedDateTime | query | DateTime? | No | |
| LastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
| LastSavedDateTimeGreaterThan | query | DateTime? | No | |
| LastSavedDateTimeLessThan | query | DateTime? | No | |
| LastSavedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
| LastSavedDateTimeNotEqualTo | query | DateTime? | No | |
| LastSavedDateTimeBetween | query | Nullable<DateTime>[] | No | |
| LastSavedDateTimeIn | query | Nullable<DateTime>[] | No | |
| LineNumber | query | int? | No | |
| LineNumberGreaterThanOrEqualTo | query | int? | No | |
| LineNumberGreaterThan | query | int? | No | |
| LineNumberLessThan | query | int? | No | |
| LineNumberLessThanOrEqualTo | query | int? | No | |
| LineNumberNotEqualTo | query | int? | No | |
| LineNumberBetween | query | Nullable<Int32>[] | No | |
| LineNumberIn | query | Nullable<Int32>[] | No | |
| TransactionDateTime | query | DateTime? | No | |
| TransactionDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
| TransactionDateTimeGreaterThan | query | DateTime? | No | |
| TransactionDateTimeLessThan | query | DateTime? | No | |
| TransactionDateTimeLessThanOrEqualTo | query | DateTime? | No | |
| TransactionDateTimeNotEqualTo | query | DateTime? | No | |
| TransactionDateTimeBetween | query | Nullable<DateTime>[] | No | |
| TransactionDateTimeIn | query | Nullable<DateTime>[] | No | |
| AmountIncGST | query | decimal? | No | |
| AmountIncGSTGreaterThanOrEqualTo | query | decimal? | No | |
| AmountIncGSTGreaterThan | query | decimal? | No | |
| AmountIncGSTLessThan | query | decimal? | No | |
| AmountIncGSTLessThanOrEqualTo | query | decimal? | No | |
| AmountIncGSTNotEqualTo | query | decimal? | No | |
| AmountIncGSTBetween | query | Nullable<Decimal>[] | No | |
| AmountIncGSTIn | query | Nullable<Decimal>[] | No | |
| DebitCredit | query | byte? | No | |
| DebitCreditGreaterThanOrEqualTo | query | byte? | No | |
| DebitCreditGreaterThan | query | byte? | No | |
| DebitCreditLessThan | query | byte? | No | |
| DebitCreditLessThanOrEqualTo | query | byte? | No | |
| DebitCreditNotEqualTo | query | byte? | No | |
| DebitCreditBetween | query | Nullable<Byte>[] | No | |
| DebitCreditIn | query | Nullable<Byte>[] | No | |
| Remark | query | string | No | |
| RemarkStartsWith | query | string | No | |
| RemarkEndsWith | query | string | No | |
| RemarkContains | query | string | No | |
| RemarkLike | query | string | No | |
| RemarkBetween | query | string[] | No | |
| RemarkIn | query | string[] | No | |
| Status | query | byte? | No | |
| StatusGreaterThanOrEqualTo | query | byte? | No | |
| StatusGreaterThan | query | byte? | No | |
| StatusLessThan | query | byte? | No | |
| StatusLessThanOrEqualTo | query | byte? | No | |
| StatusNotEqualTo | query | byte? | No | |
| StatusBetween | query | Nullable<Byte>[] | No | |
| StatusIn | query | Nullable<Byte>[] | No | |
| GLLedgerID | query | string | No | |
| GLLedgerIDStartsWith | query | string | No | |
| GLLedgerIDEndsWith | query | string | No | |
| GLLedgerIDContains | query | string | No | |
| GLLedgerIDLike | query | string | No | |
| GLLedgerIDBetween | query | string[] | No | |
| GLLedgerIDIn | query | string[] | No | |
| DebtorID | query | string | No | |
| DebtorIDStartsWith | query | string | No | |
| DebtorIDEndsWith | query | string | No | |
| DebtorIDContains | query | string | No | |
| DebtorIDLike | query | string | No | |
| DebtorIDBetween | query | string[] | No | |
| DebtorIDIn | query | string[] | No | |
| ParentDebtorID | query | string | No | |
| ParentDebtorIDStartsWith | query | string | No | |
| ParentDebtorIDEndsWith | query | string | No | |
| ParentDebtorIDContains | query | string | No | |
| ParentDebtorIDLike | query | string | No | |
| ParentDebtorIDBetween | query | string[] | No | |
| ParentDebtorIDIn | query | string[] | No | |
| BankName | query | string | No | |
| BankNameStartsWith | query | string | No | |
| BankNameEndsWith | query | string | No | |
| BankNameContains | query | string | No | |
| BankNameLike | query | string | No | |
| BankNameBetween | query | string[] | No | |
| BankNameIn | query | string[] | No | |
| BankAccountNo | query | string | No | |
| BankAccountNoStartsWith | query | string | No | |
| BankAccountNoEndsWith | query | string | No | |
| BankAccountNoContains | query | string | No | |
| BankAccountNoLike | query | string | No | |
| BankAccountNoBetween | query | string[] | No | |
| BankAccountNoIn | query | string[] | No | |
| BSBN | query | string | No | |
| BSBNStartsWith | query | string | No | |
| BSBNEndsWith | query | string | No | |
| BSBNContains | query | string | No | |
| BSBNLike | query | string | No | |
| BSBNBetween | query | string[] | No | |
| BSBNIn | query | string[] | No | |
| BankAccountName | query | string | No | |
| BankAccountNameStartsWith | query | string | No | |
| BankAccountNameEndsWith | query | string | No | |
| BankAccountNameContains | query | string | No | |
| BankAccountNameLike | query | string | No | |
| BankAccountNameBetween | query | string[] | No | |
| BankAccountNameIn | query | string[] | No | |
| AmountReconciledIncGST | query | decimal? | No | |
| AmountReconciledIncGSTGreaterThanOrEqualTo | query | decimal? | No | |
| AmountReconciledIncGSTGreaterThan | query | decimal? | No | |
| AmountReconciledIncGSTLessThan | query | decimal? | No | |
| AmountReconciledIncGSTLessThanOrEqualTo | query | decimal? | No | |
| AmountReconciledIncGSTNotEqualTo | query | decimal? | No | |
| AmountReconciledIncGSTBetween | query | Nullable<Decimal>[] | No | |
| AmountReconciledIncGSTIn | query | Nullable<Decimal>[] | No | |
| Reference | query | string | No | |
| ReferenceStartsWith | query | string | No | |
| ReferenceEndsWith | query | string | No | |
| ReferenceContains | query | string | No | |
| ReferenceLike | query | string | No | |
| ReferenceBetween | query | string[] | No | |
| ReferenceIn | query | string[] | No | |
| PaymentTypeID | query | string | No | |
| PaymentTypeIDStartsWith | query | string | No | |
| PaymentTypeIDEndsWith | query | string | No | |
| PaymentTypeIDContains | query | string | No | |
| PaymentTypeIDLike | query | string | No | |
| PaymentTypeIDBetween | query | string[] | No | |
| PaymentTypeIDIn | query | string[] | No | |
| TaxID | query | string | No | |
| TaxIDStartsWith | query | string | No | |
| TaxIDEndsWith | query | string | No | |
| TaxIDContains | query | string | No | |
| TaxIDLike | query | string | No | |
| TaxIDBetween | query | string[] | No | |
| TaxIDIn | query | string[] | No | |
| TaxRate | query | decimal? | No | |
| TaxRateGreaterThanOrEqualTo | query | decimal? | No | |
| TaxRateGreaterThan | query | decimal? | No | |
| TaxRateLessThan | query | decimal? | No | |
| TaxRateLessThanOrEqualTo | query | decimal? | No | |
| TaxRateNotEqualTo | query | decimal? | No | |
| TaxRateBetween | query | Nullable<Decimal>[] | No | |
| TaxRateIn | query | Nullable<Decimal>[] | No | |
| TaxAmount | query | decimal? | No | |
| TaxAmountGreaterThanOrEqualTo | query | decimal? | No | |
| TaxAmountGreaterThan | query | decimal? | No | |
| TaxAmountLessThan | query | decimal? | No | |
| TaxAmountLessThanOrEqualTo | query | decimal? | No | |
| TaxAmountNotEqualTo | query | decimal? | No | |
| TaxAmountBetween | query | Nullable<Decimal>[] | No | |
| TaxAmountIn | query | Nullable<Decimal>[] | No | |
| InvoiceNo | query | string | No | |
| InvoiceNoStartsWith | query | string | No | |
| InvoiceNoEndsWith | query | string | No | |
| InvoiceNoContains | query | string | No | |
| InvoiceNoLike | query | string | No | |
| InvoiceNoBetween | query | string[] | No | |
| InvoiceNoIn | query | string[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | int? | No | |
| Take | form | int? | No | |
| OrderBy | form | string | No | |
| OrderByDesc | form | string | No | |
| Include | form | string | No | |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DirectDebtorPaymentID | form | string | No | |
| BankRecID | form | string | No | |
| CreatedByStaffID | form | string | No | |
| CreatedDateTime | form | DateTime? | No | |
| LastSavedByStaffID | form | string | No | |
| LastSavedDateTime | form | DateTime? | No | |
| LineNumber | form | int? | No | |
| TransactionDateTime | form | DateTime? | No | |
| AmountIncGST | form | decimal? | No | |
| DebitCredit | form | byte? | No | |
| Remark | form | string | No | |
| Status | form | byte? | No | |
| GLLedgerID | form | string | No | |
| DebtorID | form | string | No | |
| ParentDebtorID | form | string | No | |
| BankName | form | string | No | |
| BankAccountNo | form | string | No | |
| BSBN | form | string | No | |
| BankAccountName | form | string | No | |
| AmountReconciledIncGST | form | decimal? | No | |
| Reference | form | string | No | |
| PaymentTypeID | form | string | No | |
| TaxID | form | string | No | |
| TaxRate | form | decimal? | No | |
| TaxAmount | form | decimal? | No | |
| InvoiceNo | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<T> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/BR_DirectDebtorPaymentsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"DirectDebtorPaymentID":"String","DirectDebtorPaymentIDStartsWith":"String","DirectDebtorPaymentIDEndsWith":"String","DirectDebtorPaymentIDContains":"String","DirectDebtorPaymentIDLike":"String","DirectDebtorPaymentIDBetween":["String"],"DirectDebtorPaymentIDIn":["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"],"DebtorID":"String","DebtorIDStartsWith":"String","DebtorIDEndsWith":"String","DebtorIDContains":"String","DebtorIDLike":"String","DebtorIDBetween":["String"],"DebtorIDIn":["String"],"ParentDebtorID":"String","ParentDebtorIDStartsWith":"String","ParentDebtorIDEndsWith":"String","ParentDebtorIDContains":"String","ParentDebtorIDLike":"String","ParentDebtorIDBetween":["String"],"ParentDebtorIDIn":["String"],"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"],"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"],"TaxID":"String","TaxIDStartsWith":"String","TaxIDEndsWith":"String","TaxIDContains":"String","TaxIDLike":"String","TaxIDBetween":["String"],"TaxIDIn":["String"],"TaxRate":0,"TaxRateGreaterThanOrEqualTo":0,"TaxRateGreaterThan":0,"TaxRateLessThan":0,"TaxRateLessThanOrEqualTo":0,"TaxRateNotEqualTo":0,"TaxRateBetween":[0],"TaxRateIn":[0],"TaxAmount":0,"TaxAmountGreaterThanOrEqualTo":0,"TaxAmountGreaterThan":0,"TaxAmountLessThan":0,"TaxAmountLessThanOrEqualTo":0,"TaxAmountNotEqualTo":0,"TaxAmountBetween":[0],"TaxAmountIn":[0],"InvoiceNo":"String","InvoiceNoStartsWith":"String","InvoiceNoEndsWith":"String","InvoiceNoContains":"String","InvoiceNoLike":"String","InvoiceNoBetween":["String"],"InvoiceNoIn":["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":[{"DirectDebtorPaymentID":"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","DebtorID":"String","ParentDebtorID":"String","BankName":"String","BankAccountNo":"String","BSBN":"String","BankAccountName":"String","AmountReconciledIncGST":0,"Reference":"String","PaymentTypeID":"String","TaxID":"String","TaxRate":0,"TaxAmount":0,"InvoiceNo":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}