| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DirectCreditorPaymentAllocationID | query | string | No | |
| DirectCreditorPaymentAllocationIDStartsWith | query | string | No | |
| DirectCreditorPaymentAllocationIDEndsWith | query | string | No | |
| DirectCreditorPaymentAllocationIDContains | query | string | No | |
| DirectCreditorPaymentAllocationIDLike | query | string | No | |
| DirectCreditorPaymentAllocationIDBetween | query | string[] | No | |
| DirectCreditorPaymentAllocationIDIn | query | string[] | No | |
| DirectCreditorPaymentID | query | string | No | |
| DirectCreditorPaymentIDStartsWith | query | string | No | |
| DirectCreditorPaymentIDEndsWith | query | string | No | |
| DirectCreditorPaymentIDContains | query | string | No | |
| DirectCreditorPaymentIDLike | query | string | No | |
| DirectCreditorPaymentIDBetween | query | string[] | No | |
| DirectCreditorPaymentIDIn | query | string[] | No | |
| AmountAllocated | query | decimal? | No | |
| AmountAllocatedGreaterThanOrEqualTo | query | decimal? | No | |
| AmountAllocatedGreaterThan | query | decimal? | No | |
| AmountAllocatedLessThan | query | decimal? | No | |
| AmountAllocatedLessThanOrEqualTo | query | decimal? | No | |
| AmountAllocatedNotEqualTo | query | decimal? | No | |
| AmountAllocatedBetween | query | Nullable<Decimal>[] | No | |
| AmountAllocatedIn | query | Nullable<Decimal>[] | No | |
| TransID | query | string | No | |
| TransIDStartsWith | query | string | No | |
| TransIDEndsWith | query | string | No | |
| TransIDContains | query | string | No | |
| TransIDLike | query | string | No | |
| TransIDBetween | query | string[] | No | |
| TransIDIn | query | string[] | 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 | |
| DiscountAmountAllocated | query | decimal? | No | |
| DiscountAmountAllocatedGreaterThanOrEqualTo | query | decimal? | No | |
| DiscountAmountAllocatedGreaterThan | query | decimal? | No | |
| DiscountAmountAllocatedLessThan | query | decimal? | No | |
| DiscountAmountAllocatedLessThanOrEqualTo | query | decimal? | No | |
| DiscountAmountAllocatedNotEqualTo | query | decimal? | No | |
| DiscountAmountAllocatedBetween | query | Nullable<Decimal>[] | No | |
| DiscountAmountAllocatedIn | query | Nullable<Decimal>[] | 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 |
|---|---|---|---|---|
| DirectCreditorPaymentAllocationID | form | string | No | |
| DirectCreditorPaymentID | form | string | No | |
| AmountAllocated | form | decimal? | No | |
| TransID | form | string | No | |
| LastSavedByStaffID | form | string | No | |
| LastSavedDateTime | form | DateTime? | No | |
| DiscountAmountAllocated | form | decimal? | 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_DirectCreditorPaymentAllocationsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"DirectCreditorPaymentAllocationID":"String","DirectCreditorPaymentAllocationIDStartsWith":"String","DirectCreditorPaymentAllocationIDEndsWith":"String","DirectCreditorPaymentAllocationIDContains":"String","DirectCreditorPaymentAllocationIDLike":"String","DirectCreditorPaymentAllocationIDBetween":["String"],"DirectCreditorPaymentAllocationIDIn":["String"],"DirectCreditorPaymentID":"String","DirectCreditorPaymentIDStartsWith":"String","DirectCreditorPaymentIDEndsWith":"String","DirectCreditorPaymentIDContains":"String","DirectCreditorPaymentIDLike":"String","DirectCreditorPaymentIDBetween":["String"],"DirectCreditorPaymentIDIn":["String"],"AmountAllocated":0,"AmountAllocatedGreaterThanOrEqualTo":0,"AmountAllocatedGreaterThan":0,"AmountAllocatedLessThan":0,"AmountAllocatedLessThanOrEqualTo":0,"AmountAllocatedNotEqualTo":0,"AmountAllocatedBetween":[0],"AmountAllocatedIn":[0],"TransID":"String","TransIDStartsWith":"String","TransIDEndsWith":"String","TransIDContains":"String","TransIDLike":"String","TransIDBetween":["String"],"TransIDIn":["String"],"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"],"DiscountAmountAllocated":0,"DiscountAmountAllocatedGreaterThanOrEqualTo":0,"DiscountAmountAllocatedGreaterThan":0,"DiscountAmountAllocatedLessThan":0,"DiscountAmountAllocatedLessThanOrEqualTo":0,"DiscountAmountAllocatedNotEqualTo":0,"DiscountAmountAllocatedBetween":[0],"DiscountAmountAllocatedIn":[0],"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":[{"DirectCreditorPaymentAllocationID":"String","DirectCreditorPaymentID":"String","AmountAllocated":0,"TransID":"String","LastSavedByStaffID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","DiscountAmountAllocated":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}