| GET | /api/creditNote/from/{FromDate}/to/{ToDate} | Get credit note between start and end date |
|---|
/** @description Credit Note */
// @Api(Description="Credit Note")
// @ApiResponse(Description="Paged credit note response between start and end date", IsDefaultResponse=true, StatusCode=200)
export class GetCreditNoteByDateRange
{
/** @description Requested page number, starting at 1 */
// @ApiMember(Description="Requested page number, starting at 1")
public requestedPage: number;
/** @description Number of records to return on a page */
// @ApiMember(Description="Number of records to return on a page")
public numberOfRecordsPerPage: number;
/** @description From Date Time */
// @ApiMember(Description="From Date Time", ParameterType="path")
public fromDate: string;
/** @description To Date Time */
// @ApiMember(Description="To Date Time", ParameterType="path")
public toDate: string;
public constructor(init?: Partial<GetCreditNoteByDateRange>) { (Object as any).assign(this, init); }
}
export class PagedQueryResult<T>
{
public startIndex: number;
public endIndex: number;
public numberOfRecordsReturned: number;
public totalNumberOfPages: number;
public totalNumberOfRecords: number;
public results: ResultItem<ClaimMessage>[] = [];
public constructor(init?: Partial<PagedQueryResult<T>>) { (Object as any).assign(this, init); }
}
TypeScript GetCreditNoteByDateRange DTOs
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.
GET /api/creditNote/from/{FromDate}/to/{ToDate} HTTP/1.1
Host: stf-api-uat.data-xchange.co.za
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"startIndex":0,"endIndex":0,"numberOfRecordsReturned":0,"totalNumberOfPages":0,"totalNumberOfRecords":0,"results":[{}]}