| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /billing/company/ | Add new billing information. | Add new 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 AddBillingInformation() =
///<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: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 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
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: testapi.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>