POST api/StatementItems

API interface handling generic JSON request for StatementItem details

Request Information

URI Parameters

None.

Body Parameters

StatementRequest

Name	Description	Type	Additional information
Id	Request by unique ClientStatement identifier	integer	None.
ClientId	Match statements referring to Client Id	integer	None.
UserId	Match statements made by User id	integer	None.
FromDate	Match statements made From this date onward (if only todate specified then use it)	date	None.
ToDate	Match statements made before this date (if no todate match statement made on from date)	date	None.
StatementType	Match statements of a specific type	integer	None.
StatementCategory	Match statements of specific category	integer	None.
limit	Limit to number of rows returned by request (default is 100)	integer	None.
Skip	Number of rows to skip (so we can skip 10 get next 10 etc)	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 707,
  "ClientId": 534,
  "UserId": 581,
  "FromDate": "2024-04-27T00:07:20.7014386+10:00",
  "ToDate": "2024-04-27T00:07:20.7014386+10:00",
  "StatementType": 291,
  "StatementCategory": 303,
  "limit": 776,
  "Skip": 15
}

application/xml, text/xml

Sample:

<StatementRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Turnpoint.Turnpoint">
  <ClientId>534</ClientId>
  <FromDate>2024-04-27T00:07:20.7014386+10:00</FromDate>
  <Id>707</Id>
  <Skip>15</Skip>
  <StatementCategory>303</StatementCategory>
  <StatementType>291</StatementType>
  <ToDate>2024-04-27T00:07:20.7014386+10:00</ToDate>
  <UserId>581</UserId>
  <limit>776</limit>
</StatementRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

StatementReportDetails

Name	Description	Type	Additional information
statementID	Unique ClientStatementItem identifier	integer	None.
statementClient	Client Id that statement item refers to	integer	None.
statementUser	User Id that created the statement	integer	None.
statementType	ClientStatementItem Type (Refer to ClientStatementItemTypes)	integer	None.
statementNumber	Statement Number that item belongs to	integer	None.
statementCategory	Category of StatementItem	integer	None.
statementDeleted	Deleted flag for statement	boolean	None.
statementReference	Reference of client statement	string	None.
statementDate	Date that statement was last edited	date	None.
statementName	Name for Statement Item	string	None.
statementAmount	Monitory amount for entry	decimal number	None.
statementQty	Quantity of statement item	integer	None.
statementFundingType	Type of funding reported on statement	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "statementID": 762,
  "statementClient": 815,
  "statementUser": 710,
  "statementType": 46,
  "statementNumber": 415,
  "statementCategory": 864,
  "statementDeleted": true,
  "statementReference": "sample string 2",
  "statementDate": "2024-04-27T00:07:20.7170469+10:00",
  "statementName": "sample string 3",
  "statementAmount": 1.1,
  "statementQty": 791,
  "statementFundingType": 375
}

application/xml, text/xml

Sample:

<StatementReportDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Turnpoint.Turnpoint">
  <statementAmount>1.1</statementAmount>
  <statementCategory>864</statementCategory>
  <statementClient>815</statementClient>
  <statementDate>2024-04-27T00:07:20.7170469+10:00</statementDate>
  <statementDeleted>true</statementDeleted>
  <statementFundingType>375</statementFundingType>
  <statementID>762</statementID>
  <statementName>sample string 3</statementName>
  <statementNumber>415</statementNumber>
  <statementQty>791</statementQty>
  <statementReference>sample string 2</statementReference>
  <statementType>46</statementType>
  <statementUser>710</statementUser>
</StatementReportDetails>