| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| 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 .xml suffix or ?format=xml
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: testapi.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateBillingInformation 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>
</UpdateBillingInformation>
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>