Relative request path: | api/orgs/{organisationId}/issuedinvoicepostings |
Property | Description |
---|---|
organisationId | organisation id |
DateFrom | Optional. Filters from (including) supplied date. |
DateTo | Optional. Filters up to (including) supplied date. |
Description | Optional. Filter by (part of) description. |
Status | Optional. Filters by status. |
AnalyticID | Optional. Filters by analytic. |
CurrentPage | Current page index starting with 1 for first page. |
PageSize | Page size defines number of records returned per page. |
SortField | Field name that is used for sorting/ordering result rows. |
Order | Sort order: A - ascending; D - descending |
Filter options:
/// Issued invoice posting search filter.
public class IssuedInvoicePostingSearchFilter
{
// Optional. Filters from (including) supplied date.
public DateTime? DateFrom { get; set; }
// Optional. Filters up to (including) supplied date.
public DateTime? DateTo { get; set; }
// Optional. Filter by (part of) description.
public string Description { get; set; }
// Optional. Filters by status.
public string Status { get; set; }
// Optional. Filters by analytic.
public long? AnalyticID { get; set; }
// Current page index starting with 1 for first page.
public int CurrentPage { get; set; }
// Page size defines number of records returned per page.
public int PageSize { get; set; }
// Field name that is used for sorting/ordering result rows.
public string SortField { get; set; }
// Sort order: A - ascending; D - descending
public string Order { get; set; }
}
Request parameters:
Filter options:
/// Issued invoice posting search filter.
class IssuedInvoicePostingSearchFilter
{
// Optional. Filters from (including) supplied date.
public $DateFrom;
// Optional. Filters up to (including) supplied date.
public $DateTo;
// Optional. Filter by (part of) description.
public $Description;
// Optional. Filters by status.
public $Status;
// Optional. Filters by analytic.
public $AnalyticID;
// Current page index starting with 1 for first page.
public $CurrentPage;
// Page size defines number of records returned per page.
public $PageSize;
// Field name that is used for sorting/ordering result rows.
public $SortField;
// Sort order: A - ascending; D - descending
public $Order;
}
Request parameters:
Filter options:
/// Issued invoice posting search filter.
public class IssuedInvoicePostingSearchFilter
{
// Optional. Filters from (including) supplied date.
public Date DateFrom;
// Optional. Filters up to (including) supplied date.
public Date DateTo;
// Optional. Filter by (part of) description.
public String Description;
// Optional. Filters by status.
public String Status;
// Optional. Filters by analytic.
public Long AnalyticID;
// Current page index starting with 1 for first page.
public Integer CurrentPage;
// Page size defines number of records returned per page.
public Integer PageSize;
// Field name that is used for sorting/ordering result rows.
public String SortField;
// Sort order: A - ascending; D - descending
public String Order;
}
Request parameters:
Property | Description |
---|---|
Rows | Returned rows. List of IssuedInvoicePostingSearch. |
TotalRows | Number of rows matching search condition. |
CurrentPageNumber | Current page number. Result rows are returned in pages. |
PageSize | Numbers of rows returned per page. |
This method returns result of type 'SAOP.API.Models.SearchResult`1'.
/// SearchResult is default return type for all search api methods.
public class SearchResult<T>
{
// Returned rows.
public T Rows { get; set; }
// Number of rows matching search condition.
public long TotalRows { get; set; }
// Current page number. Result rows are returned in pages.
public long CurrentPageNumber { get; set; }
// Numbers of rows returned per page.
public long PageSize { get; set; }
}
/// Issued invoice posting search result item.
public class IssuedInvoicePostingSearch
{
// Issued invoice posting id.
public long IssuedInvoicePostingId { get; set; }
// Document type.
public string DocumentType { get; set; }
// Status.
public string Status { get; set; }
// Document date.
public DateTime? Date { get; set; }
// Document description.
public string Description { get; set; }
public DateTime RecordDtModified { get; set; }
// Row version is used for concurrency check.
// Ignored on create request.
public string RowVersion { get; set; }
}
This method returns result of type 'SAOP.API.Models.SearchResult`1'.
/// SearchResult is default return type for all search api methods.
class SearchResult
{
// Returned rows.
public $Rows;
// Number of rows matching search condition.
public $TotalRows;
// Current page number. Result rows are returned in pages.
public $CurrentPageNumber;
// Numbers of rows returned per page.
public $PageSize;
}
/// Issued invoice posting search result item.
class IssuedInvoicePostingSearch
{
// Issued invoice posting id.
public $IssuedInvoicePostingId;
// Document type.
public $DocumentType;
// Status.
public $Status;
// Document date.
public $Date;
// Document description.
public $Description;
public $RecordDtModified;
// Row version is used for concurrency check.
// Ignored on create request.
public $RowVersion;
}
This method returns result of type 'SAOP.API.Models.SearchResult`1'.
/// SearchResult is default return type for all search api methods.
public class SearchResultT
{
// Returned rows.
public T Rows;
// Number of rows matching search condition.
public Long TotalRows;
// Current page number. Result rows are returned in pages.
public Long CurrentPageNumber;
// Numbers of rows returned per page.
public Long PageSize;
}
/// Issued invoice posting search result item.
public class IssuedInvoicePostingSearch
{
// Issued invoice posting id.
public Long IssuedInvoicePostingId;
// Document type.
public String DocumentType;
// Status.
public String Status;
// Document date.
public Date Date;
// Document description.
public String Description;
public Date RecordDtModified;
// Row version is used for concurrency check.
// Ignored on create request.
public String RowVersion;
}