| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CBBatchID | query | string | No | |
| CBBatchIDStartsWith | query | string | No | |
| CBBatchIDEndsWith | query | string | No | |
| CBBatchIDContains | query | string | No | |
| CBBatchIDLike | query | string | No | |
| CBBatchIDBetween | query | string[] | No | |
| CBBatchIDIn | 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 | |
| StaffID | query | string | No | |
| StaffIDStartsWith | query | string | No | |
| StaffIDEndsWith | query | string | No | |
| StaffIDContains | query | string | No | |
| StaffIDLike | query | string | No | |
| StaffIDBetween | query | string[] | No | |
| StaffIDIn | query | string[] | No | |
| BatchDate | query | DateTime? | No | |
| BatchDateGreaterThanOrEqualTo | query | DateTime? | No | |
| BatchDateGreaterThan | query | DateTime? | No | |
| BatchDateLessThan | query | DateTime? | No | |
| BatchDateLessThanOrEqualTo | query | DateTime? | No | |
| BatchDateNotEqualTo | query | DateTime? | No | |
| BatchDateBetween | query | Nullable<DateTime>[] | No | |
| BatchDateIn | query | Nullable<DateTime>[] | No | |
| BatchNo | query | string | No | |
| BatchNoStartsWith | query | string | No | |
| BatchNoEndsWith | query | string | No | |
| BatchNoContains | query | string | No | |
| BatchNoLike | query | string | No | |
| BatchNoBetween | query | string[] | No | |
| BatchNoIn | query | string[] | No | |
| Activated | query | bool? | No | |
| Description | query | string | No | |
| DescriptionStartsWith | query | string | No | |
| DescriptionEndsWith | query | string | No | |
| DescriptionContains | query | string | No | |
| DescriptionLike | query | string | No | |
| DescriptionBetween | query | string[] | No | |
| DescriptionIn | query | string[] | No | |
| ReceiptPayment | query | byte? | No | |
| ReceiptPaymentGreaterThanOrEqualTo | query | byte? | No | |
| ReceiptPaymentGreaterThan | query | byte? | No | |
| ReceiptPaymentLessThan | query | byte? | No | |
| ReceiptPaymentLessThanOrEqualTo | query | byte? | No | |
| ReceiptPaymentNotEqualTo | query | byte? | No | |
| ReceiptPaymentBetween | query | Nullable<Byte>[] | No | |
| ReceiptPaymentIn | query | Nullable<Byte>[] | No | |
| BankLedgerID | query | string | No | |
| BankLedgerIDStartsWith | query | string | No | |
| BankLedgerIDEndsWith | query | string | No | |
| BankLedgerIDContains | query | string | No | |
| BankLedgerIDLike | query | string | No | |
| BankLedgerIDBetween | query | string[] | No | |
| BankLedgerIDIn | query | string[] | No | |
| GroupJournals | query | bool? | 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 |
|---|---|---|---|---|
| CBBatchID | form | string | No | |
| LastSavedDateTime | form | DateTime? | No | |
| StaffID | form | string | No | |
| BatchDate | form | DateTime? | No | |
| BatchNo | form | string | No | |
| Activated | form | bool? | No | |
| Description | form | string | No | |
| ReceiptPayment | form | byte? | No | |
| BankLedgerID | form | string | No | |
| GroupJournals | form | bool | 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/CB_BatchTransQuery HTTP/1.1
Host: localhost
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"CBBatchID":"String","CBBatchIDStartsWith":"String","CBBatchIDEndsWith":"String","CBBatchIDContains":"String","CBBatchIDLike":"String","CBBatchIDBetween":["String"],"CBBatchIDIn":["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"],"StaffID":"String","StaffIDStartsWith":"String","StaffIDEndsWith":"String","StaffIDContains":"String","StaffIDLike":"String","StaffIDBetween":["String"],"StaffIDIn":["String"],"BatchDate":"0001-01-01T00:00:00.0000000","BatchDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","BatchDateGreaterThan":"0001-01-01T00:00:00.0000000","BatchDateLessThan":"0001-01-01T00:00:00.0000000","BatchDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","BatchDateNotEqualTo":"0001-01-01T00:00:00.0000000","BatchDateBetween":["0001-01-01T00:00:00.0000000"],"BatchDateIn":["0001-01-01T00:00:00.0000000"],"BatchNo":"String","BatchNoStartsWith":"String","BatchNoEndsWith":"String","BatchNoContains":"String","BatchNoLike":"String","BatchNoBetween":["String"],"BatchNoIn":["String"],"Activated":false,"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"ReceiptPayment":0,"ReceiptPaymentGreaterThanOrEqualTo":0,"ReceiptPaymentGreaterThan":0,"ReceiptPaymentLessThan":0,"ReceiptPaymentLessThanOrEqualTo":0,"ReceiptPaymentNotEqualTo":0,"ReceiptPaymentBetween":[0],"ReceiptPaymentIn":[0],"BankLedgerID":"String","BankLedgerIDStartsWith":"String","BankLedgerIDEndsWith":"String","BankLedgerIDContains":"String","BankLedgerIDLike":"String","BankLedgerIDBetween":["String"],"BankLedgerIDIn":["String"],"GroupJournals":false,"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":[{"CBBatchID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","StaffID":"String","BatchDate":"0001-01-01T00:00:00.0000000","BatchNo":"String","Activated":false,"Description":"String","ReceiptPayment":0,"BankLedgerID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}