| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /billing/company/ | Add new billing information. | Add new 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
{
[ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
[ValidateRequest("IsAuthenticated")]
public partial class AddBillingInformation
: 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; }
}
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; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /billing/company/ HTTP/1.1
Host: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AddBillingInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Attention>String</Attention>
<BillingMethodId>0</BillingMethodId>
<City>String</City>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<CountryId>String</CountryId>
<Email>String</Email>
<GLN>String</GLN>
<Name>String</Name>
<PaymentTermsDays>0</PaymentTermsDays>
<ReferenceLine1>String</ReferenceLine1>
<ReferenceLine2>String</ReferenceLine2>
<Street1>String</Street1>
<Street2>String</Street2>
<VatRegistrationNumber>String</VatRegistrationNumber>
<ZipCode>String</ZipCode>
</AddBillingInformation>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<BillingInformationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Attention>String</Attention>
<BillingMethodId>0</BillingMethodId>
<BillingMethodOptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db">
<d2p1:BillingMethod>
<d2p1:BillingMethodCountriesRelation>
<d2p1:BillingMethodCountriesRelation>
<d2p1:BillingMethodId>0</d2p1:BillingMethodId>
<d2p1:CountryId>String</d2p1:CountryId>
<d2p1:ModifiedDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/System">
<d6p1:DateTime>0001-01-01T00:00:00Z</d6p1:DateTime>
<d6p1:OffsetMinutes>0</d6p1:OffsetMinutes>
</d2p1:ModifiedDate>
</d2p1:BillingMethodCountriesRelation>
</d2p1:BillingMethodCountriesRelation>
<d2p1:Description>String</d2p1:Description>
<d2p1:Id>0</d2p1:Id>
<d2p1:ModifiedDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
<d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
<d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
</d2p1:ModifiedDate>
<d2p1:Name>String</d2p1:Name>
</d2p1:BillingMethod>
</BillingMethodOptions>
<City>String</City>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<CountryId>String</CountryId>
<Email>String</Email>
<GLN>String</GLN>
<Name>String</Name>
<PaymentTermsDays>0</PaymentTermsDays>
<ReferenceLine1>String</ReferenceLine1>
<ReferenceLine2>String</ReferenceLine2>
<Street1>String</Street1>
<Street2>String</Street2>
<VatRegistrationNumber>String</VatRegistrationNumber>
<ZipCode>String</ZipCode>
</BillingInformationResponse>