BokaMera.API.Host

<back to all web services

UpdateBillingInformation

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/billing/company/Update billing information.Update billing information.
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 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 BillingInformationResponse() = 
        ///<summary>
        ///The company id.
        ///</summary>
        [<ApiMember(Description="The company id.")>]
        member val CompanyId:Guid = new Guid() with get,set

        ///<summary>
        ///The prefered billing method.
        ///</summary>
        [<ApiMember(Description="The prefered billing method.", IsRequired=true)>]
        member val BillingMethodId:Int32 = new Int32() with get,set

        ///<summary>
        ///The name that should be printed on the billing information, normally this would be your company name.
        ///</summary>
        [<ApiMember(Description="The name that should be printed on the billing information, normally this would be your company name.")>]
        member val Name:String = null with get,set

        ///<summary>
        ///If you want to add the attention to the billing address.
        ///</summary>
        [<ApiMember(Description="If you want to add the attention to the billing address.")>]
        member val Attention:String = null with get,set

        ///<summary>
        ///The street for the billing adress. This is required when having postal invoice as billing method.
        ///</summary>
        [<ApiMember(Description="The street for the billing adress. This is required when having postal invoice as billing method.")>]
        member val Street1:String = null with get,set

        ///<summary>
        ///The street for the billing adress.
        ///</summary>
        [<ApiMember(Description="The street for the billing adress.")>]
        member val Street2:String = null with get,set

        ///<summary>
        ///The zip code (postal code) for the billing adress. This is required when having postal invoice as billing method.
        ///</summary>
        [<ApiMember(Description="The zip code (postal code) for the billing adress. This is required when having postal invoice as billing method.")>]
        member val ZipCode:String = null with get,set

        ///<summary>
        ///The city for the billing adress. This is required when having postal invoice as billing method.
        ///</summary>
        [<ApiMember(Description="The city for the billing adress. This is required when having postal invoice as billing method.")>]
        member val City:String = null with get,set

        ///<summary>
        ///The country for the billing adress. This is required when having postal invoice as billing method.
        ///</summary>
        [<ApiMember(Description="The country for the billing adress. This is required when having postal invoice as billing method.")>]
        member val CountryId:String = null with get,set

        ///<summary>
        ///The billing email. This is required when having email invoice as billing method.
        ///</summary>
        [<ApiMember(Description="The billing email. This is required when having email invoice as billing method.")>]
        member val Email:String = null with get,set

        ///<summary>
        ///The company global location number.
        ///</summary>
        [<ApiMember(Description="The company global location number.")>]
        member val GLN:String = null with get,set

        ///<summary>
        ///You're internal rereference.
        ///</summary>
        [<ApiMember(Description="You're internal rereference.")>]
        member val ReferenceLine1:String = null with get,set

        ///<summary>
        ///You're internal rereference.
        ///</summary>
        [<ApiMember(Description="You're internal rereference.")>]
        member val ReferenceLine2:String = null with get,set

        ///<summary>
        ///The billing payment terms in days. This is default 15 days.
        ///</summary>
        [<ApiMember(Description="The billing payment terms in days. This is default 15 days.")>]
        member val PaymentTermsDays:Int32 = new Int32() with get,set

        ///<summary>
        ///The company vat registration number.
        ///</summary>
        [<ApiMember(Description="The company vat registration number.")>]
        member val VatRegistrationNumber:String = null with get,set

        ///<summary>
        ///The billing method options to choose from
        ///</summary>
        [<ApiMember(Description="The billing method options to choose from")>]
        member val BillingMethodOptions:ResizeArray<BillingMethod> = new ResizeArray<BillingMethod>() with get,set

    [<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
    [<ValidateRequest(Validator="IsAuthenticated")>]
    [<AllowNullLiteral>]
    type UpdateBillingInformation() = 
        ///<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>
        ///The prefered billing method.
        ///</summary>
        [<ApiMember(Description="The prefered billing method.", IsRequired=true)>]
        member val BillingMethodId:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///The name that should be printed on the billing information, normally this would be your company name.
        ///</summary>
        [<ApiMember(Description="The name that should be printed on the billing information, normally this would be your company name.")>]
        member val Name:String = null with get,set

        ///<summary>
        ///If you want to add the attention to the billing address.
        ///</summary>
        [<ApiMember(Description="If you want to add the attention to the billing address.")>]
        member val Attention:String = null with get,set

        ///<summary>
        ///The street for the billing adress. This is required when having postal invoice as billing method.
        ///</summary>
        [<ApiMember(Description="The street for the billing adress. This is required when having postal invoice as billing method.")>]
        member val Street1:String = null with get,set

        ///<summary>
        ///The street for the billing adress.
        ///</summary>
        [<ApiMember(Description="The street for the billing adress.")>]
        member val Street2:String = null with get,set

        ///<summary>
        ///The zip code (postal code) for the billing adress. This is required when having postal invoice as billing method.
        ///</summary>
        [<ApiMember(Description="The zip code (postal code) for the billing adress. This is required when having postal invoice as billing method.")>]
        member val ZipCode:String = null with get,set

        ///<summary>
        ///The city for the billing adress. This is required when having postal invoice as billing method.
        ///</summary>
        [<ApiMember(Description="The city for the billing adress. This is required when having postal invoice as billing method.")>]
        member val City:String = null with get,set

        ///<summary>
        ///The country for the billing adress. This is required when having postal invoice as billing method.
        ///</summary>
        [<ApiMember(Description="The country for the billing adress. This is required when having postal invoice as billing method.")>]
        member val CountryId:String = null with get,set

        ///<summary>
        ///The billing email. This is required when having email invoice as billing method.
        ///</summary>
        [<ApiMember(Description="The billing email. This is required when having email invoice as billing method.")>]
        member val Email:String = null with get,set

        ///<summary>
        ///The billing payment terms in days. This is default 15 days.
        ///</summary>
        [<ApiMember(Description="The billing payment terms in days. This is default 15 days.")>]
        member val PaymentTermsDays:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///The company vat registration number.
        ///</summary>
        [<ApiMember(Description="The company vat registration number.")>]
        member val VatRegistrationNumber:String = null with get,set

        ///<summary>
        ///The company global location number.
        ///</summary>
        [<ApiMember(Description="The company global location number.")>]
        member val GLN:String = null with get,set

        ///<summary>
        ///You're internal rereference.
        ///</summary>
        [<ApiMember(Description="You're internal rereference.")>]
        member val ReferenceLine1:String = null with get,set

        ///<summary>
        ///You're internal rereference.
        ///</summary>
        [<ApiMember(Description="You're internal rereference.")>]
        member val ReferenceLine2:String = null with get,set

F# UpdateBillingInformation DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /billing/company/ HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	BillingMethodId: 0,
	Name: String,
	Attention: String,
	Street1: String,
	Street2: String,
	ZipCode: String,
	City: String,
	CountryId: String,
	Email: String,
	PaymentTermsDays: 0,
	VatRegistrationNumber: String,
	GLN: String,
	ReferenceLine1: String,
	ReferenceLine2: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	BillingMethodId: 0,
	Name: String,
	Attention: String,
	Street1: String,
	Street2: String,
	ZipCode: String,
	City: String,
	CountryId: String,
	Email: String,
	GLN: String,
	ReferenceLine1: String,
	ReferenceLine2: String,
	PaymentTermsDays: 0,
	VatRegistrationNumber: String,
	BillingMethodOptions: 
	[
		{
			BillingMethodCountriesRelation: 
			[
				{
					BillingMethodId: 0,
					CountryId: String,
					ModifiedDate: 0001-01-01T00:00:00.0000000+00:00
				}
			],
			Name: String,
			Description: String,
			ModifiedDate: 0001-01-01T00:00:00.0000000+00:00,
			Id: 0
		}
	]
}