BokaMera.API.Host

<back to all web services

CompanyBillingInformation

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin
The following routes are available for this service:
GET/billing/companyGet billing details for the company.Get billing details for the company.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
    @ValidateRequest(Validator="IsAuthenticated")
    public static class CompanyBillingInformation extends QueryDb<BillingInformation, BillingMethodQueryResponse>
    {
        /**
        * 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 UUID CompanyId = null;

        /**
        * If you want to include the billing methods to select from
        */
        @ApiMember(DataType="boolean", Description="If you want to include the billing methods to select from", ParameterType="query")
        public Boolean IncludeBillingMethodOptions = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public CompanyBillingInformation setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Boolean isIncludeBillingMethodOptions() { return IncludeBillingMethodOptions; }
        public CompanyBillingInformation setIncludeBillingMethodOptions(Boolean value) { this.IncludeBillingMethodOptions = value; return this; }
    }

    public static class QueryDb<From, Into> extends QueryBase
    {
        
    }

    @DataContract
    public static class QueryBase
    {
        /**
        * Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code>
        */
        @DataMember(Order=1)
        public Integer Skip = null;

        /**
        * Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code>
        */
        @DataMember(Order=2)
        public Integer Take = null;

        /**
        * Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code>
        */
        @DataMember(Order=3)
        public String OrderBy = null;

        /**
        * Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code>
        */
        @DataMember(Order=4)
        public String OrderByDesc = null;

        /**
        * Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code>
        */
        @DataMember(Order=5)
        public String Include = null;

        @DataMember(Order=6)
        public String Fields = null;

        @DataMember(Order=7)
        public HashMap<String,String> Meta = null;
        
        public Integer getSkip() { return Skip; }
        public QueryBase setSkip(Integer value) { this.Skip = value; return this; }
        public Integer getTake() { return Take; }
        public QueryBase setTake(Integer value) { this.Take = value; return this; }
        public String getOrderBy() { return OrderBy; }
        public QueryBase setOrderBy(String value) { this.OrderBy = value; return this; }
        public String getOrderByDesc() { return OrderByDesc; }
        public QueryBase setOrderByDesc(String value) { this.OrderByDesc = value; return this; }
        public String getInclude() { return Include; }
        public QueryBase setInclude(String value) { this.Include = value; return this; }
        public String getFields() { return Fields; }
        public QueryBase setFields(String value) { this.Fields = value; return this; }
        public HashMap<String,String> getMeta() { return Meta; }
        public QueryBase setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
    }

    public static class BillingInformation extends BaseModel
    {
        public BillingMethod BillingMethod = null;
        @Required()
        public Integer BillingMethodId = null;

        @Required()
        public String Name = null;

        public String Attention = null;
        public String Street1 = null;
        public String Street2 = null;
        public String ZipCode = null;
        public String City = null;
        public String Email = null;
        public String CreditCard = null;
        public String CreditCardHolder = null;
        public String CreditCardNumber = null;
        public Short ValidToYear = null;
        public Short ValidToMonth = null;
        public String CSV = null;
        @Required()
        public Date Updated = null;

        @Required()
        public Date Created = null;

        @Required()
        public String CountryId = null;

        @Required()
        public Integer PaymentTermsDays = null;

        public String VATRegistrationNumber = null;
        public String GLN = null;
        public String ReferenceLine1 = null;
        public String ReferenceLine2 = null;
        public Date ModifiedDate = null;
        @Required()
        public UUID Id = null;
        
        public BillingMethod getBillingMethod() { return BillingMethod; }
        public BillingInformation setBillingMethod(BillingMethod value) { this.BillingMethod = value; return this; }
        public Integer getBillingMethodId() { return BillingMethodId; }
        public BillingInformation setBillingMethodId(Integer value) { this.BillingMethodId = value; return this; }
        public String getName() { return Name; }
        public BillingInformation setName(String value) { this.Name = value; return this; }
        public String getAttention() { return Attention; }
        public BillingInformation setAttention(String value) { this.Attention = value; return this; }
        public String getStreet1() { return Street1; }
        public BillingInformation setStreet1(String value) { this.Street1 = value; return this; }
        public String getStreet2() { return Street2; }
        public BillingInformation setStreet2(String value) { this.Street2 = value; return this; }
        public String getZipCode() { return ZipCode; }
        public BillingInformation setZipCode(String value) { this.ZipCode = value; return this; }
        public String getCity() { return City; }
        public BillingInformation setCity(String value) { this.City = value; return this; }
        public String getEmail() { return Email; }
        public BillingInformation setEmail(String value) { this.Email = value; return this; }
        public String getCreditCard() { return CreditCard; }
        public BillingInformation setCreditCard(String value) { this.CreditCard = value; return this; }
        public String getCreditCardHolder() { return CreditCardHolder; }
        public BillingInformation setCreditCardHolder(String value) { this.CreditCardHolder = value; return this; }
        public String getCreditCardNumber() { return CreditCardNumber; }
        public BillingInformation setCreditCardNumber(String value) { this.CreditCardNumber = value; return this; }
        public Short getValidToYear() { return ValidToYear; }
        public BillingInformation setValidToYear(Short value) { this.ValidToYear = value; return this; }
        public Short getValidToMonth() { return ValidToMonth; }
        public BillingInformation setValidToMonth(Short value) { this.ValidToMonth = value; return this; }
        public String getCsv() { return CSV; }
        public BillingInformation setCsv(String value) { this.CSV = value; return this; }
        public Date getUpdated() { return Updated; }
        public BillingInformation setUpdated(Date value) { this.Updated = value; return this; }
        public Date getCreated() { return Created; }
        public BillingInformation setCreated(Date value) { this.Created = value; return this; }
        public String getCountryId() { return CountryId; }
        public BillingInformation setCountryId(String value) { this.CountryId = value; return this; }
        public Integer getPaymentTermsDays() { return PaymentTermsDays; }
        public BillingInformation setPaymentTermsDays(Integer value) { this.PaymentTermsDays = value; return this; }
        public String getVatRegistrationNumber() { return VATRegistrationNumber; }
        public BillingInformation setVatRegistrationNumber(String value) { this.VATRegistrationNumber = value; return this; }
        public String getGln() { return GLN; }
        public BillingInformation setGln(String value) { this.GLN = value; return this; }
        public String getReferenceLine1() { return ReferenceLine1; }
        public BillingInformation setReferenceLine1(String value) { this.ReferenceLine1 = value; return this; }
        public String getReferenceLine2() { return ReferenceLine2; }
        public BillingInformation setReferenceLine2(String value) { this.ReferenceLine2 = value; return this; }
        public Date getModifiedDate() { return ModifiedDate; }
        public BillingInformation setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
        public UUID getId() { return Id; }
        public BillingInformation setId(UUID value) { this.Id = value; return this; }
    }

    public static class BaseModel
    {
        
    }

    public static class BillingMethod extends BaseModel
    {
        public ArrayList<BillingMethodCountriesRelation> BillingMethodCountriesRelation = null;
        @Required()
        public String Name = null;

        @Required()
        public String Description = null;

        public Date ModifiedDate = null;
        public Integer Id = null;
        
        public ArrayList<BillingMethodCountriesRelation> getBillingMethodCountriesRelation() { return BillingMethodCountriesRelation; }
        public BillingMethod setBillingMethodCountriesRelation(ArrayList<BillingMethodCountriesRelation> value) { this.BillingMethodCountriesRelation = value; return this; }
        public String getName() { return Name; }
        public BillingMethod setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public BillingMethod setDescription(String value) { this.Description = value; return this; }
        public Date getModifiedDate() { return ModifiedDate; }
        public BillingMethod setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
        public Integer getId() { return Id; }
        public BillingMethod setId(Integer value) { this.Id = value; return this; }
    }

    public static class BillingMethodCountriesRelation extends BaseModel
    {
        @Required()
        public Integer BillingMethodId = null;

        @Required()
        public String CountryId = null;

        public Date ModifiedDate = null;
        
        public Integer getBillingMethodId() { return BillingMethodId; }
        public BillingMethodCountriesRelation setBillingMethodId(Integer value) { this.BillingMethodId = value; return this; }
        public String getCountryId() { return CountryId; }
        public BillingMethodCountriesRelation setCountryId(String value) { this.CountryId = value; return this; }
        public Date getModifiedDate() { return ModifiedDate; }
        public BillingMethodCountriesRelation setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
    }

    public static class BillingMethodQueryResponse
    {
        /**
        * The billing method id
        */
        @ApiMember(Description="The billing method id")
        public Integer Id = null;

        /**
        * The billing method name
        */
        @ApiMember(Description="The billing method name")
        public String Name = null;

        /**
        * The billing method description
        */
        @ApiMember(Description="The billing method description")
        public String Description = null;

        /**
        * The billing method is valid for the following countries
        */
        @ApiMember(Description="The billing method is valid for the following countries")
        public ArrayList<String> Countries = null;
        
        public Integer getId() { return Id; }
        public BillingMethodQueryResponse setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public BillingMethodQueryResponse setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public BillingMethodQueryResponse setDescription(String value) { this.Description = value; return this; }
        public ArrayList<String> getCountries() { return Countries; }
        public BillingMethodQueryResponse setCountries(ArrayList<String> value) { this.Countries = value; return this; }
    }

    @DataContract
    public static class QueryResponse<AccessKeyTypeResponse>
    {
        @DataMember(Order=1)
        public Integer Offset = null;

        @DataMember(Order=2)
        public Integer Total = null;

        @DataMember(Order=3)
        public ArrayList<AccessKeyTypeResponse> Results = null;

        @DataMember(Order=4)
        public HashMap<String,String> Meta = null;

        @DataMember(Order=5)
        public ResponseStatus ResponseStatus = null;
        
        public Integer getOffset() { return Offset; }
        public QueryResponse<AccessKeyTypeResponse> setOffset(Integer value) { this.Offset = value; return this; }
        public Integer getTotal() { return Total; }
        public QueryResponse<AccessKeyTypeResponse> setTotal(Integer value) { this.Total = value; return this; }
        public ArrayList<AccessKeyTypeResponse> getResults() { return Results; }
        public QueryResponse<AccessKeyTypeResponse> setResults(ArrayList<AccessKeyTypeResponse> value) { this.Results = value; return this; }
        public HashMap<String,String> getMeta() { return Meta; }
        public QueryResponse<AccessKeyTypeResponse> setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public QueryResponse<AccessKeyTypeResponse> setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class AccessKeyTypeResponse
    {
        public Integer Id = null;
        public String KeyType = null;
        public String Description = null;
        
        public Integer getId() { return Id; }
        public AccessKeyTypeResponse setId(Integer value) { this.Id = value; return this; }
        public String getKeyType() { return KeyType; }
        public AccessKeyTypeResponse setKeyType(String value) { this.KeyType = value; return this; }
        public String getDescription() { return Description; }
        public AccessKeyTypeResponse setDescription(String value) { this.Description = value; return this; }
    }

}

Java CompanyBillingInformation DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /billing/company HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"Id":0,"Name":"String","Description":"String","Countries":["String"]}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}