Relative request path: | api/payrollsettings/{payrollSettingCode}?externalUserIdentifier={externalUserIdentifier}&customerCode={customerCode}&date={date} |
Property | Description |
---|---|
payrollSettingCode | |
externalUserIdentifier | |
customerCode | |
date | |
SearchString | Search string. |
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:
/// Payroll settings search filter.
public class PayrollSettingsSearchFilter
{
// Search string.
public string SearchString { 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:
/// Payroll settings search filter.
class PayrollSettingsSearchFilter
{
// Search string.
public $SearchString;
// 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:
/// Payroll settings search filter.
public class PayrollSettingsSearchFilter
{
// Search string.
public String SearchString;
// 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 PayrollSettings. |
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; }
}
/// Payroll settings.
public class PayrollSettings
{
// Payroll settings id.
public long PayrollSettingsId { get; set; }
// Payroll settings code.
public string Code { get; set; }
// Payroll settings name.
public string Name { get; set; }
// Payroll settings description.
public string Description { get; set; }
// Payroll settings customer code.
public string CustomerCode { get; set; }
// Payroll settings customer name.
public string CustomerName { get; set; }
// Payroll settings value.
public Decimal? Value { get; set; }
// Payroll settings date.
public DateTime? Date { 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;
}
/// Payroll settings.
class PayrollSettings
{
// Payroll settings id.
public $PayrollSettingsId;
// Payroll settings code.
public $Code;
// Payroll settings name.
public $Name;
// Payroll settings description.
public $Description;
// Payroll settings customer code.
public $CustomerCode;
// Payroll settings customer name.
public $CustomerName;
// Payroll settings value.
public $Value;
// Payroll settings date.
public $Date;
}
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;
}
/// Payroll settings.
public class PayrollSettings
{
// Payroll settings id.
public Long PayrollSettingsId;
// Payroll settings code.
public String Code;
// Payroll settings name.
public String Name;
// Payroll settings description.
public String Description;
// Payroll settings customer code.
public String CustomerCode;
// Payroll settings customer name.
public String CustomerName;
// Payroll settings value.
public Double Value;
// Payroll settings date.
public Date Date;
}