GET api/users/{userId}/invoice-settings

Gets the InvoiceSettings related to a specific User.

Request Information

URI Parameters

Name	Description	Type	Additional information
userId	The id of the User.	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

The requested InvoiceSettings related to the User, if any, a newly created InvoiceSettings; otherwise.

ReadInvoiceSettingsViewModel

Name	Type	Additional information
AmountOfRemindersBeforeEscalation	integer	None.
CompanyName	string	None.
AdditionalMileageRate	decimal number	None.
HourlyRate	decimal number	None.
HourlyRateHolidays	decimal number	None.
HourlyRateWeekend	decimal number	None.
MileageRate	decimal number	None.
PaymentTermInDays	integer	None.
PercentageOfRevenue	decimal number	None.
PercentageOfRevenueHolidays	decimal number	None.
PercentageOfRevenueWeekend	decimal number	None.
FootText	string	None.
Id	integer	None.
Logo	string	None.
LogoSize	InvoiceLogoSize	None.
ServiceHourRate	decimal number	None.
ServiceHourRateHolidays	decimal number	None.
ServiceHourRateWeekend	decimal number	None.
InvoiceCommissionConfigParts	Collection of InvoiceCommissionConfigPartViewModel	None.

Response Formats

application/json, text/json

Sample:

{
  "AmountOfRemindersBeforeEscalation": 1,
  "CompanyName": "sample string 2",
  "AdditionalMileageRate": 1.0,
  "HourlyRate": 1.0,
  "HourlyRateHolidays": 1.0,
  "HourlyRateWeekend": 1.0,
  "MileageRate": 1.0,
  "PaymentTermInDays": 1,
  "PercentageOfRevenue": 1.1,
  "PercentageOfRevenueHolidays": 1.1,
  "PercentageOfRevenueWeekend": 1.1,
  "FootText": "sample string 3",
  "Id": 4,
  "Logo": "sample string 5",
  "LogoSize": 1,
  "ServiceHourRate": 1.0,
  "ServiceHourRateHolidays": 1.0,
  "ServiceHourRateWeekend": 1.0,
  "InvoiceCommissionConfigParts": [
    {
      "Id": 1,
      "Start": 2.0,
      "Commission": 3.1,
      "CommissionWeekend": 4.1,
      "CommissionHoliday": 5.1
    },
    {
      "Id": 1,
      "Start": 2.0,
      "Commission": 3.1,
      "CommissionWeekend": 4.1,
      "CommissionHoliday": 5.1
    }
  ]
}

application/xml, text/xml

Sample:

<ReadInvoiceSettingsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Shared.Models.ViewModels">
  <AdditionalMileageRate>1</AdditionalMileageRate>
  <AmountOfRemindersBeforeEscalation>1</AmountOfRemindersBeforeEscalation>
  <CompanyName>sample string 2</CompanyName>
  <FootText>sample string 3</FootText>
  <HourlyRate>1</HourlyRate>
  <HourlyRateHolidays>1</HourlyRateHolidays>
  <HourlyRateWeekend>1</HourlyRateWeekend>
  <Id>4</Id>
  <InvoiceCommissionConfigParts>
    <InvoiceCommissionConfigPartViewModel>
      <Commission>3.1</Commission>
      <CommissionHoliday>5.1</CommissionHoliday>
      <CommissionWeekend>4.1</CommissionWeekend>
      <Id>1</Id>
      <Start>2</Start>
    </InvoiceCommissionConfigPartViewModel>
    <InvoiceCommissionConfigPartViewModel>
      <Commission>3.1</Commission>
      <CommissionHoliday>5.1</CommissionHoliday>
      <CommissionWeekend>4.1</CommissionWeekend>
      <Id>1</Id>
      <Start>2</Start>
    </InvoiceCommissionConfigPartViewModel>
  </InvoiceCommissionConfigParts>
  <Logo>sample string 5</Logo>
  <LogoSize>Small</LogoSize>
  <MileageRate>1</MileageRate>
  <PaymentTermInDays>1</PaymentTermInDays>
  <PercentageOfRevenue>1.1</PercentageOfRevenue>
  <PercentageOfRevenueHolidays>1.1</PercentageOfRevenueHolidays>
  <PercentageOfRevenueWeekend>1.1</PercentageOfRevenueWeekend>
  <ServiceHourRate>1</ServiceHourRate>
  <ServiceHourRateHolidays>1</ServiceHourRateHolidays>
  <ServiceHourRateWeekend>1</ServiceHourRateWeekend>
</ReadInvoiceSettingsViewModel>