| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin |
| GET | /billing/company | Get billing details for the company. | Get billing details for the company. |
|---|
namespace BokaMera.API.ServiceModel.Db
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type BillingMethodQueryResponse() =
///<summary>
///The billing method id
///</summary>
[<ApiMember(Description="The billing method id")>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///The billing method name
///</summary>
[<ApiMember(Description="The billing method name")>]
member val Name:String = null with get,set
///<summary>
///The billing method description
///</summary>
[<ApiMember(Description="The billing method description")>]
member val Description:String = null with get,set
///<summary>
///The billing method is valid for the following countries
///</summary>
[<ApiMember(Description="The billing method is valid for the following countries")>]
member val Countries:ResizeArray<String> = new ResizeArray<String>() with get,set
[<AllowNullLiteral>]
type BaseModel() =
class end
[<AllowNullLiteral>]
type BillingMethodCountriesRelation() =
inherit BaseModel()
[<Required>]
member val BillingMethodId:Int32 = new Int32() with get,set
[<Required>]
member val CountryId:String = null with get,set
member val ModifiedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
[<AllowNullLiteral>]
type BillingMethod() =
inherit BaseModel()
member val BillingMethodCountriesRelation:ResizeArray<BillingMethodCountriesRelation> = new ResizeArray<BillingMethodCountriesRelation>() with get,set
[<Required>]
member val Name:String = null with get,set
[<Required>]
member val Description:String = null with get,set
member val ModifiedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
member val Id:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type BillingInformation() =
inherit BaseModel()
member val BillingMethod:BillingMethod = null with get,set
[<Required>]
member val BillingMethodId:Int32 = new Int32() with get,set
[<Required>]
member val Name:String = null with get,set
member val Attention:String = null with get,set
member val Street1:String = null with get,set
member val Street2:String = null with get,set
member val ZipCode:String = null with get,set
member val City:String = null with get,set
member val Email:String = null with get,set
member val CreditCard:String = null with get,set
member val CreditCardHolder:String = null with get,set
member val CreditCardNumber:String = null with get,set
member val ValidToYear:Nullable<Int16> = new Nullable<Int16>() with get,set
member val ValidToMonth:Nullable<Int16> = new Nullable<Int16>() with get,set
member val CSV:String = null with get,set
[<Required>]
member val Updated:DateTime = new DateTime() with get,set
[<Required>]
member val Created:DateTime = new DateTime() with get,set
[<Required>]
member val CountryId:String = null with get,set
[<Required>]
member val PaymentTermsDays:Int32 = new Int32() with get,set
member val VATRegistrationNumber:String = null with get,set
member val GLN:String = null with get,set
member val ReferenceLine1:String = null with get,set
member val ReferenceLine2:String = null with get,set
member val ModifiedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
[<Required>]
member val Id:Guid = new Guid() with get,set
[<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
[<ValidateRequest(Validator="IsAuthenticated")>]
[<AllowNullLiteral>]
type CompanyBillingInformation() =
inherit QueryDb<BillingInformation, BillingMethodQueryResponse>()
///<summary>
///The company id, if empty will use the company id for the user you are logged in with.
///</summary>
[<ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")>]
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///If you want to include the billing methods to select from
///</summary>
[<ApiMember(DataType="boolean", Description="If you want to include the billing methods to select from", ParameterType="query")>]
member val IncludeBillingMethodOptions:Boolean = new Boolean() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type QueryBase() =
///<summary>
///Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code>
///</summary>
[<DataMember(Order=1)>]
member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code>
///</summary>
[<DataMember(Order=2)>]
member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code>
///</summary>
[<DataMember(Order=3)>]
member val OrderBy:String = null with get,set
///<summary>
///Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code>
///</summary>
[<DataMember(Order=4)>]
member val OrderByDesc:String = null with get,set
///<summary>
///Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code>
///</summary>
[<DataMember(Order=5)>]
member val Include:String = null with get,set
[<DataMember(Order=6)>]
member val Fields:String = null with get,set
[<DataMember(Order=7)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<AllowNullLiteral>]
type QueryDb<From, Into>() =
inherit QueryBase()
[<AllowNullLiteral>]
type AccessKeyTypeResponse() =
member val Id:Int32 = new Int32() with get,set
member val KeyType:String = null with get,set
member val Description:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type QueryResponse<AccessKeyTypeResponse>() =
[<DataMember(Order=1)>]
member val Offset:Int32 = new Int32() with get,set
[<DataMember(Order=2)>]
member val Total:Int32 = new Int32() with get,set
[<DataMember(Order=3)>]
member val Results:ResizeArray<AccessKeyTypeResponse> = new ResizeArray<AccessKeyTypeResponse>() with get,set
[<DataMember(Order=4)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<DataMember(Order=5)>]
member val ResponseStatus:ResponseStatus = null with get,set
F# CompanyBillingInformation 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 /billing/company HTTP/1.1 Host: testapi.bokamera.se Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Offset: 0,
Total: 0,
Results:
[
{
Id: 0,
Name: String,
Description: String,
Countries:
[
String
]
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}