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.
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.API.ServiceModel.Db;

namespace BokaMera.API.ServiceModel.Db
{
    public partial class BaseModel
    {
    }

    public partial class BillingMethod
        : BaseModel
    {
        public BillingMethod()
        {
            BillingMethodCountriesRelation = new List<BillingMethodCountriesRelation>{};
        }

        public virtual List<BillingMethodCountriesRelation> BillingMethodCountriesRelation { get; set; }
        [Required]
        public virtual string Name { get; set; }

        [Required]
        public virtual string Description { get; set; }

        public virtual DateTimeOffset? ModifiedDate { get; set; }
        public virtual int Id { get; set; }
    }

    public partial class BillingMethodCountriesRelation
        : BaseModel
    {
        [Required]
        public virtual int BillingMethodId { get; set; }

        [Required]
        public virtual string CountryId { get; set; }

        public virtual DateTimeOffset? ModifiedDate { get; set; }
    }

}

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class BillingInformationResponse
    {
        public BillingInformationResponse()
        {
            BillingMethodOptions = new List<BillingMethod>{};
        }

        ///<summary>
        ///The company id.
        ///</summary>
        [ApiMember(Description="The company id.")]
        public virtual Guid CompanyId { get; set; }

        ///<summary>
        ///The prefered billing method.
        ///</summary>
        [ApiMember(Description="The prefered billing method.", IsRequired=true)]
        public virtual int BillingMethodId { 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.")]
        public virtual string Name { 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.")]
        public virtual string Attention { 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.")]
        public virtual string Street1 { get; set; }

        ///<summary>
        ///The street for the billing adress.
        ///</summary>
        [ApiMember(Description="The street for the billing adress.")]
        public virtual string Street2 { 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.")]
        public virtual string ZipCode { 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.")]
        public virtual string City { 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.")]
        public virtual string CountryId { 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.")]
        public virtual string Email { get; set; }

        ///<summary>
        ///The company global location number.
        ///</summary>
        [ApiMember(Description="The company global location number.")]
        public virtual string GLN { get; set; }

        ///<summary>
        ///You're internal rereference.
        ///</summary>
        [ApiMember(Description="You're internal rereference.")]
        public virtual string ReferenceLine1 { get; set; }

        ///<summary>
        ///You're internal rereference.
        ///</summary>
        [ApiMember(Description="You're internal rereference.")]
        public virtual string ReferenceLine2 { 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.")]
        public virtual int PaymentTermsDays { get; set; }

        ///<summary>
        ///The company vat registration number.
        ///</summary>
        [ApiMember(Description="The company vat registration number.")]
        public virtual string VatRegistrationNumber { get; set; }

        ///<summary>
        ///The billing method options to choose from
        ///</summary>
        [ApiMember(Description="The billing method options to choose from")]
        public virtual List<BillingMethod> BillingMethodOptions { get; set; }
    }

    [ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
    [ValidateRequest("IsAuthenticated")]
    public partial class UpdateBillingInformation
        : ICompany
    {
        ///<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.")]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///The prefered billing method.
        ///</summary>
        [ApiMember(Description="The prefered billing method.", IsRequired=true)]
        public virtual int? BillingMethodId { 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.")]
        public virtual string Name { 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.")]
        public virtual string Attention { 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.")]
        public virtual string Street1 { get; set; }

        ///<summary>
        ///The street for the billing adress.
        ///</summary>
        [ApiMember(Description="The street for the billing adress.")]
        public virtual string Street2 { 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.")]
        public virtual string ZipCode { 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.")]
        public virtual string City { 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.")]
        public virtual string CountryId { 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.")]
        public virtual string Email { 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.")]
        public virtual int? PaymentTermsDays { get; set; }

        ///<summary>
        ///The company vat registration number.
        ///</summary>
        [ApiMember(Description="The company vat registration number.")]
        public virtual string VatRegistrationNumber { get; set; }

        ///<summary>
        ///The company global location number.
        ///</summary>
        [ApiMember(Description="The company global location number.")]
        public virtual string GLN { get; set; }

        ///<summary>
        ///You're internal rereference.
        ///</summary>
        [ApiMember(Description="You're internal rereference.")]
        public virtual string ReferenceLine1 { get; set; }

        ///<summary>
        ///You're internal rereference.
        ///</summary>
        [ApiMember(Description="You're internal rereference.")]
        public virtual string ReferenceLine2 { get; set; }
    }

}

C# 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
		}
	]
}