BokaMera.API.Host

<back to all web services

CompanyBillingInformation

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class CompanyBillingInformation : 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.")
    var CompanyId:UUID? = 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")
    var IncludeBillingMethodOptions:Boolean? = null
}

open class QueryDb<From, Into> : QueryBase()
{
}

@DataContract
open 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)
    var Skip:Int? = 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)
    var Take:Int? = 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)
    var OrderBy:String? = 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)
    var OrderByDesc:String? = 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)
    var Include:String? = null

    @DataMember(Order=6)
    var Fields:String? = null

    @DataMember(Order=7)
    var Meta:HashMap<String,String> = HashMap<String,String>()
}

open class BillingInformation : BaseModel()
{
    var BillingMethod:BillingMethod? = null
    @Required()
    var BillingMethodId:Int? = null

    @Required()
    var Name:String? = null

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

    @Required()
    var Created:Date? = null

    @Required()
    var CountryId:String? = null

    @Required()
    var PaymentTermsDays:Int? = null

    var VATRegistrationNumber:String? = null
    var GLN:String? = null
    var ReferenceLine1:String? = null
    var ReferenceLine2:String? = null
    var ModifiedDate:Date? = null
    @Required()
    var Id:UUID? = null
}

open class BaseModel
{
}

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 BillingMethodCountriesRelation : BaseModel()
{
    @Required()
    var BillingMethodId:Int? = null

    @Required()
    var CountryId:String? = null

    var ModifiedDate:Date? = null
}

open class BillingMethodQueryResponse
{
    /**
    * The billing method id
    */
    @ApiMember(Description="The billing method id")
    var Id:Int? = null

    /**
    * The billing method name
    */
    @ApiMember(Description="The billing method name")
    var Name:String? = null

    /**
    * The billing method description
    */
    @ApiMember(Description="The billing method description")
    var Description:String? = null

    /**
    * The billing method is valid for the following countries
    */
    @ApiMember(Description="The billing method is valid for the following countries")
    var Countries:ArrayList<String> = ArrayList<String>()
}

@DataContract
open class QueryResponse<AccessKeyTypeResponse>
{
    @DataMember(Order=1)
    var Offset:Int? = null

    @DataMember(Order=2)
    var Total:Int? = null

    @DataMember(Order=3)
    var Results:ArrayList<AccessKeyTypeResponse> = ArrayList<AccessKeyTypeResponse>()

    @DataMember(Order=4)
    var Meta:HashMap<String,String> = HashMap<String,String>()

    @DataMember(Order=5)
    var ResponseStatus:ResponseStatus? = null
}

open class AccessKeyTypeResponse
{
    var Id:Int? = null
    var KeyType:String? = null
    var Description:String? = null
}

Kotlin CompanyBillingInformation DTOs

GET /billing/company HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}