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.
import java.math.*
import java.util.*
import net.servicestack.client.*


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class UpdateBillingInformation : ICompany
{
    /**
    * The company id, if empty will use the company id for the user you are logged in with.
    */
    @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    var CompanyId:UUID? = null

    /**
    * The prefered billing method.
    */
    @ApiMember(Description="The prefered billing method.", IsRequired=true)
    var BillingMethodId:Int? = null

    /**
    * The name that should be printed on the billing information, normally this would be your company name.
    */
    @ApiMember(Description="The name that should be printed on the billing information, normally this would be your company name.")
    var Name:String? = null

    /**
    * If you want to add the attention to the billing address.
    */
    @ApiMember(Description="If you want to add the attention to the billing address.")
    var Attention:String? = null

    /**
    * The street for the billing adress. This is required when having postal invoice as billing method.
    */
    @ApiMember(Description="The street for the billing adress. This is required when having postal invoice as billing method.")
    var Street1:String? = null

    /**
    * The street for the billing adress.
    */
    @ApiMember(Description="The street for the billing adress.")
    var Street2:String? = null

    /**
    * The zip code (postal code) for the billing adress. This is required when having postal invoice as billing method.
    */
    @ApiMember(Description="The zip code (postal code) for the billing adress. This is required when having postal invoice as billing method.")
    var ZipCode:String? = null

    /**
    * The city for the billing adress. This is required when having postal invoice as billing method.
    */
    @ApiMember(Description="The city for the billing adress. This is required when having postal invoice as billing method.")
    var City:String? = null

    /**
    * The country for the billing adress. This is required when having postal invoice as billing method.
    */
    @ApiMember(Description="The country for the billing adress. This is required when having postal invoice as billing method.")
    var CountryId:String? = null

    /**
    * The billing email. This is required when having email invoice as billing method.
    */
    @ApiMember(Description="The billing email. This is required when having email invoice as billing method.")
    var Email:String? = null

    /**
    * The billing payment terms in days. This is default 15 days.
    */
    @ApiMember(Description="The billing payment terms in days. This is default 15 days.")
    var PaymentTermsDays:Int? = null

    /**
    * The company vat registration number.
    */
    @ApiMember(Description="The company vat registration number.")
    var VatRegistrationNumber:String? = null

    /**
    * The company global location number.
    */
    @ApiMember(Description="The company global location number.")
    var GLN:String? = null

    /**
    * You're internal rereference.
    */
    @ApiMember(Description="You're internal rereference.")
    var ReferenceLine1:String? = null

    /**
    * You're internal rereference.
    */
    @ApiMember(Description="You're internal rereference.")
    var ReferenceLine2:String? = null
}

open class BillingInformationResponse
{
    /**
    * The company id.
    */
    @ApiMember(Description="The company id.")
    var CompanyId:UUID? = null

    /**
    * The prefered billing method.
    */
    @ApiMember(Description="The prefered billing method.", IsRequired=true)
    var BillingMethodId:Int? = null

    /**
    * The name that should be printed on the billing information, normally this would be your company name.
    */
    @ApiMember(Description="The name that should be printed on the billing information, normally this would be your company name.")
    var Name:String? = null

    /**
    * If you want to add the attention to the billing address.
    */
    @ApiMember(Description="If you want to add the attention to the billing address.")
    var Attention:String? = null

    /**
    * The street for the billing adress. This is required when having postal invoice as billing method.
    */
    @ApiMember(Description="The street for the billing adress. This is required when having postal invoice as billing method.")
    var Street1:String? = null

    /**
    * The street for the billing adress.
    */
    @ApiMember(Description="The street for the billing adress.")
    var Street2:String? = null

    /**
    * The zip code (postal code) for the billing adress. This is required when having postal invoice as billing method.
    */
    @ApiMember(Description="The zip code (postal code) for the billing adress. This is required when having postal invoice as billing method.")
    var ZipCode:String? = null

    /**
    * The city for the billing adress. This is required when having postal invoice as billing method.
    */
    @ApiMember(Description="The city for the billing adress. This is required when having postal invoice as billing method.")
    var City:String? = null

    /**
    * The country for the billing adress. This is required when having postal invoice as billing method.
    */
    @ApiMember(Description="The country for the billing adress. This is required when having postal invoice as billing method.")
    var CountryId:String? = null

    /**
    * The billing email. This is required when having email invoice as billing method.
    */
    @ApiMember(Description="The billing email. This is required when having email invoice as billing method.")
    var Email:String? = null

    /**
    * The company global location number.
    */
    @ApiMember(Description="The company global location number.")
    var GLN:String? = null

    /**
    * You're internal rereference.
    */
    @ApiMember(Description="You're internal rereference.")
    var ReferenceLine1:String? = null

    /**
    * You're internal rereference.
    */
    @ApiMember(Description="You're internal rereference.")
    var ReferenceLine2:String? = null

    /**
    * The billing payment terms in days. This is default 15 days.
    */
    @ApiMember(Description="The billing payment terms in days. This is default 15 days.")
    var PaymentTermsDays:Int? = null

    /**
    * The company vat registration number.
    */
    @ApiMember(Description="The company vat registration number.")
    var VatRegistrationNumber:String? = null

    /**
    * The billing method options to choose from
    */
    @ApiMember(Description="The billing method options to choose from")
    var BillingMethodOptions:ArrayList<BillingMethod> = ArrayList<BillingMethod>()
}

open class BillingMethod : BaseModel()
{
    var BillingMethodCountriesRelation:ArrayList<BillingMethodCountriesRelation> = ArrayList<BillingMethodCountriesRelation>()
    @Required()
    var Name:String? = null

    @Required()
    var Description:String? = null

    var ModifiedDate:Date? = null
    var Id:Int? = null
}

open class BaseModel
{
}

open class BillingMethodCountriesRelation : BaseModel()
{
    @Required()
    var BillingMethodId:Int? = null

    @Required()
    var CountryId:String? = null

    var ModifiedDate:Date? = null
}

Kotlin 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
		}
	]
}