JiwaAPI

<back to all web services

v_DebtorBalanceInformationQuery

Requires Authentication
v_DebtorBalanceInformationQuery Parameters:
NameParameterData TypeRequiredDescription
DebtorIDquerystringNo
DebtorIDStartsWithquerystringNo
DebtorIDEndsWithquerystringNo
DebtorIDContainsquerystringNo
DebtorIDLikequerystringNo
DebtorIDBetweenquerystring[]No
DebtorIDInquerystring[]No
DueDatequeryDateTime?No
DueDateGreaterThanOrEqualToqueryDateTime?No
DueDateGreaterThanqueryDateTime?No
DueDateLessThanqueryDateTime?No
DueDateLessThanOrEqualToqueryDateTime?No
DueDateNotEqualToqueryDateTime?No
DueDateBetweenqueryNullable<DateTime>[]No
DueDateInqueryNullable<DateTime>[]No
Balancequerydecimal?No
BalanceGreaterThanOrEqualToquerydecimal?No
BalanceGreaterThanquerydecimal?No
BalanceLessThanquerydecimal?No
BalanceLessThanOrEqualToquerydecimal?No
BalanceNotEqualToquerydecimal?No
BalanceBetweenqueryNullable<Decimal>[]No
BalanceInqueryNullable<Decimal>[]No
SourcequerystringNo
SourceStartsWithquerystringNo
SourceEndsWithquerystringNo
SourceContainsquerystringNo
SourceLikequerystringNo
SourceBetweenquerystring[]No
SourceInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
v_DebtorBalanceInformation Parameters:
NameParameterData TypeRequiredDescription
DebtorIDformstringNo
DueDateformDateTime?No
Balanceformdecimal?No
SourceformstringNo
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/v_DebtorBalanceInformationQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"DebtorID":"String","DebtorIDStartsWith":"String","DebtorIDEndsWith":"String","DebtorIDContains":"String","DebtorIDLike":"String","DebtorIDBetween":["String"],"DebtorIDIn":["String"],"DueDate":"0001-01-01T00:00:00.0000000","DueDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","DueDateGreaterThan":"0001-01-01T00:00:00.0000000","DueDateLessThan":"0001-01-01T00:00:00.0000000","DueDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","DueDateNotEqualTo":"0001-01-01T00:00:00.0000000","DueDateBetween":["0001-01-01T00:00:00.0000000"],"DueDateIn":["0001-01-01T00:00:00.0000000"],"Balance":0,"BalanceGreaterThanOrEqualTo":0,"BalanceGreaterThan":0,"BalanceLessThan":0,"BalanceLessThanOrEqualTo":0,"BalanceNotEqualTo":0,"BalanceBetween":[0],"BalanceIn":[0],"Source":"String","SourceStartsWith":"String","SourceEndsWith":"String","SourceContains":"String","SourceLike":"String","SourceBetween":["String"],"SourceIn":["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":[{"DebtorID":"String","DueDate":"0001-01-01T00:00:00.0000000","Balance":0,"Source":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}