JiwaAPI

<back to all web services

BR_DirectDebtorReceiptAllocationsQuery

Requires Authentication
BR_DirectDebtorReceiptAllocationsQuery Parameters:
NameParameterData TypeRequiredDescription
DirectDebtorReceiptAllocationIDquerystringNo
DirectDebtorReceiptAllocationIDStartsWithquerystringNo
DirectDebtorReceiptAllocationIDEndsWithquerystringNo
DirectDebtorReceiptAllocationIDContainsquerystringNo
DirectDebtorReceiptAllocationIDLikequerystringNo
DirectDebtorReceiptAllocationIDBetweenquerystring[]No
DirectDebtorReceiptAllocationIDInquerystring[]No
DirectDebtorReceiptIDquerystringNo
DirectDebtorReceiptIDStartsWithquerystringNo
DirectDebtorReceiptIDEndsWithquerystringNo
DirectDebtorReceiptIDContainsquerystringNo
DirectDebtorReceiptIDLikequerystringNo
DirectDebtorReceiptIDBetweenquerystring[]No
DirectDebtorReceiptIDInquerystring[]No
AmountAllocatedquerydecimal?No
AmountAllocatedGreaterThanOrEqualToquerydecimal?No
AmountAllocatedGreaterThanquerydecimal?No
AmountAllocatedLessThanquerydecimal?No
AmountAllocatedLessThanOrEqualToquerydecimal?No
AmountAllocatedNotEqualToquerydecimal?No
AmountAllocatedBetweenqueryNullable<Decimal>[]No
AmountAllocatedInqueryNullable<Decimal>[]No
TransIDquerystringNo
TransIDStartsWithquerystringNo
TransIDEndsWithquerystringNo
TransIDContainsquerystringNo
TransIDLikequerystringNo
TransIDBetweenquerystring[]No
TransIDInquerystring[]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
DiscountAmountAllocatedquerydecimal?No
DiscountAmountAllocatedGreaterThanOrEqualToquerydecimal?No
DiscountAmountAllocatedGreaterThanquerydecimal?No
DiscountAmountAllocatedLessThanquerydecimal?No
DiscountAmountAllocatedLessThanOrEqualToquerydecimal?No
DiscountAmountAllocatedNotEqualToquerydecimal?No
DiscountAmountAllocatedBetweenqueryNullable<Decimal>[]No
DiscountAmountAllocatedInqueryNullable<Decimal>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
BR_DirectDebtorReceiptAllocations Parameters:
NameParameterData TypeRequiredDescription
DirectDebtorReceiptAllocationIDformstringNo
DirectDebtorReceiptIDformstringNo
AmountAllocatedformdecimal?No
TransIDformstringNo
LastSavedByStaffIDformstringNo
LastSavedDateTimeformDateTime?No
DiscountAmountAllocatedformdecimal?No
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/BR_DirectDebtorReceiptAllocationsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"DirectDebtorReceiptAllocationID":"String","DirectDebtorReceiptAllocationIDStartsWith":"String","DirectDebtorReceiptAllocationIDEndsWith":"String","DirectDebtorReceiptAllocationIDContains":"String","DirectDebtorReceiptAllocationIDLike":"String","DirectDebtorReceiptAllocationIDBetween":["String"],"DirectDebtorReceiptAllocationIDIn":["String"],"DirectDebtorReceiptID":"String","DirectDebtorReceiptIDStartsWith":"String","DirectDebtorReceiptIDEndsWith":"String","DirectDebtorReceiptIDContains":"String","DirectDebtorReceiptIDLike":"String","DirectDebtorReceiptIDBetween":["String"],"DirectDebtorReceiptIDIn":["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: application/json
Content-Length: length

{"Results":[{"DirectDebtorReceiptAllocationID":"String","DirectDebtorReceiptID":"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"}}}