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.
ReadInvoiceSettingsViewModelName | Description | Type | Additional information |
---|---|---|---|
AmountOfRemindersBeforeEscalation | integer |
None. |
|
CompanyName | string |
None. |
|
DefaultAdditionalMileageRate | decimal number |
None. |
|
DefaultHourlyRate | decimal number |
None. |
|
DefaultHourlyRateHolidays | decimal number |
None. |
|
DefaultHourlyRateWeekend | decimal number |
None. |
|
DefaultMileageRate | decimal number |
None. |
|
DefaultPaymentTermInDays | integer |
None. |
|
DefaultPercentageOfRevenue | decimal number |
None. |
|
DefaultPercentageOfRevenueHolidays | decimal number |
None. |
|
DefaultPercentageOfRevenueWeekend | decimal number |
None. |
|
FootText | string |
None. |
|
Id | integer |
None. |
|
Logo | string |
None. |
|
LogoSize | InvoiceLogoSize |
None. |
Response Formats
application/json, text/json
Sample:
{ "AmountOfRemindersBeforeEscalation": 1, "CompanyName": "sample string 2", "DefaultAdditionalMileageRate": 1.0, "DefaultHourlyRate": 1.0, "DefaultHourlyRateHolidays": 1.0, "DefaultHourlyRateWeekend": 1.0, "DefaultMileageRate": 1.0, "DefaultPaymentTermInDays": 1, "DefaultPercentageOfRevenue": 1.1, "DefaultPercentageOfRevenueHolidays": 1.1, "DefaultPercentageOfRevenueWeekend": 1.1, "FootText": "sample string 3", "Id": 4, "Logo": "sample string 5", "LogoSize": 1 }
application/xml, text/xml
Sample:
<ReadInvoiceSettingsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Models.ViewModels"> <AmountOfRemindersBeforeEscalation>1</AmountOfRemindersBeforeEscalation> <CompanyName>sample string 2</CompanyName> <DefaultAdditionalMileageRate>1</DefaultAdditionalMileageRate> <DefaultHourlyRate>1</DefaultHourlyRate> <DefaultHourlyRateHolidays>1</DefaultHourlyRateHolidays> <DefaultHourlyRateWeekend>1</DefaultHourlyRateWeekend> <DefaultMileageRate>1</DefaultMileageRate> <DefaultPaymentTermInDays>1</DefaultPaymentTermInDays> <DefaultPercentageOfRevenue>1.1</DefaultPercentageOfRevenue> <DefaultPercentageOfRevenueHolidays>1.1</DefaultPercentageOfRevenueHolidays> <DefaultPercentageOfRevenueWeekend>1.1</DefaultPercentageOfRevenueWeekend> <FootText>sample string 3</FootText> <Id>4</Id> <Logo>sample string 5</Logo> <LogoSize>Small</LogoSize> </ReadInvoiceSettingsViewModel>