| GET | /api/invoice/type/{Type} | Get paged invoice response by type |
|---|
"use strict";
export class GetInvoiceByType {
/** @param {{searchTerm?:string,requestedPage?:number,numberOfRecordsPerPage?:number,type?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Not used */
searchTerm;
/**
* @type {number}
* @description Requested page number, starting at 1 */
requestedPage;
/**
* @type {number}
* @description Number of records to return on a page */
numberOfRecordsPerPage;
/**
* @type {string}
* @description Invoice type to be returned */
type;
}
/** @typedef T {any} */
export class PagedQueryResult {
/** @param {{startIndex?:number,endIndex?:number,numberOfRecordsReturned?:number,totalNumberOfPages?:number,totalNumberOfRecords?:number,results?:ResultItem<ClaimMessage>[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
startIndex;
/** @type {number} */
endIndex;
/** @type {number} */
numberOfRecordsReturned;
/** @type {number} */
totalNumberOfPages;
/** @type {number} */
totalNumberOfRecords;
/** @type {ResultItem<ClaimMessage>[]} */
results = [];
}
JavaScript GetInvoiceByType DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/invoice/type/{Type} HTTP/1.1
Host: stf-api-uat.data-xchange.co.za
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
startIndex: 0,
endIndex: 0,
numberOfRecordsReturned: 0,
totalNumberOfPages: 0,
totalNumberOfRecords: 0,
results:
[
{
}
]
}