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.

export class BaseModel
{

    public constructor(init?: Partial<BaseModel>) { (Object as any).assign(this, init); }
}

export class BillingMethodCountriesRelation extends BaseModel
{
    // @Required()
    public BillingMethodId: number;

    // @Required()
    public CountryId: string;

    public ModifiedDate?: string;

    public constructor(init?: Partial<BillingMethodCountriesRelation>) { super(init); (Object as any).assign(this, init); }
}

export class BillingMethod extends BaseModel
{
    public BillingMethodCountriesRelation: BillingMethodCountriesRelation[];
    // @Required()
    public Name: string;

    // @Required()
    public Description: string;

    public ModifiedDate?: string;
    public Id: number;

    public constructor(init?: Partial<BillingMethod>) { super(init); (Object as any).assign(this, init); }
}

export class BillingInformationResponse
{
    /** @description The company id. */
    // @ApiMember(Description="The company id.")
    public CompanyId: string;

    /** @description The prefered billing method. */
    // @ApiMember(Description="The prefered billing method.", IsRequired=true)
    public BillingMethodId: number;

    /** @description 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.")
    public Name: string;

    /** @description If you want to add the attention to the billing address. */
    // @ApiMember(Description="If you want to add the attention to the billing address.")
    public Attention: string;

    /** @description 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.")
    public Street1: string;

    /** @description The street for the billing adress. */
    // @ApiMember(Description="The street for the billing adress.")
    public Street2: string;

    /** @description 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.")
    public ZipCode: string;

    /** @description 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.")
    public City: string;

    /** @description 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.")
    public CountryId: string;

    /** @description 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.")
    public Email: string;

    /** @description The company global location number. */
    // @ApiMember(Description="The company global location number.")
    public GLN: string;

    /** @description You're internal rereference. */
    // @ApiMember(Description="You're internal rereference.")
    public ReferenceLine1: string;

    /** @description You're internal rereference. */
    // @ApiMember(Description="You're internal rereference.")
    public ReferenceLine2: string;

    /** @description The billing payment terms in days. This is default 15 days. */
    // @ApiMember(Description="The billing payment terms in days. This is default 15 days.")
    public PaymentTermsDays: number;

    /** @description The company vat registration number. */
    // @ApiMember(Description="The company vat registration number.")
    public VatRegistrationNumber: string;

    /** @description The billing method options to choose from */
    // @ApiMember(Description="The billing method options to choose from")
    public BillingMethodOptions: BillingMethod[];

    public constructor(init?: Partial<BillingInformationResponse>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class UpdateBillingInformation implements ICompany
{
    /** @description 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.")
    public CompanyId?: string;

    /** @description The prefered billing method. */
    // @ApiMember(Description="The prefered billing method.", IsRequired=true)
    public BillingMethodId: number;

    /** @description 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.")
    public Name: string;

    /** @description If you want to add the attention to the billing address. */
    // @ApiMember(Description="If you want to add the attention to the billing address.")
    public Attention: string;

    /** @description 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.")
    public Street1: string;

    /** @description The street for the billing adress. */
    // @ApiMember(Description="The street for the billing adress.")
    public Street2: string;

    /** @description 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.")
    public ZipCode: string;

    /** @description 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.")
    public City: string;

    /** @description 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.")
    public CountryId: string;

    /** @description 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.")
    public Email: string;

    /** @description The billing payment terms in days. This is default 15 days. */
    // @ApiMember(Description="The billing payment terms in days. This is default 15 days.")
    public PaymentTermsDays?: number;

    /** @description The company vat registration number. */
    // @ApiMember(Description="The company vat registration number.")
    public VatRegistrationNumber: string;

    /** @description The company global location number. */
    // @ApiMember(Description="The company global location number.")
    public GLN: string;

    /** @description You're internal rereference. */
    // @ApiMember(Description="You're internal rereference.")
    public ReferenceLine1: string;

    /** @description You're internal rereference. */
    // @ApiMember(Description="You're internal rereference.")
    public ReferenceLine2: string;

    public constructor(init?: Partial<UpdateBillingInformation>) { (Object as any).assign(this, init); }
}

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