| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin |
| GET | /billing/company/creditcard | Get saved credit card information for the company. | Get saved credit card information for the company. |
|---|
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 CompanyCreditCardInformation : QueryDb<CreditCard, CompanyCreditCardQueryResponse>(), 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
/**
* If you want to include only active credit cards
*/
@ApiMember(DataType="boolean", Description="If you want to include only active credit cards", ParameterType="query")
var Active:Boolean? = null
/**
* If you want to include only valid credit cards (not expired and valid)
*/
@ApiMember(DataType="boolean", Description="If you want to include only valid credit cards (not expired and valid)", ParameterType="query")
var IsValid: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 CreditCard : BaseModel()
{
@Ignore()
var IsValid:Boolean? = null
@Required()
var CompanyId:UUID? = null
var Id:Int? = null
@Required()
var Name:String? = null
@Required()
var Active:Boolean? = null
@Required()
var Type:String? = null
@Required()
var ExpYear:String? = null
@Required()
var ExpMonth:String? = null
@Required()
var TicketId:String? = null
var Updated:Date? = null
var Created:Date? = null
var ModifiedDate:Date? = null
}
open class BaseModel
{
}
open class CompanyCreditCardQueryResponse
{
/**
* The credit card id
*/
@ApiMember(Description="The credit card id")
var Id:Int? = null
/**
* The credit card name
*/
@ApiMember(Description="The credit card name")
var Name:String? = null
/**
* If the credit card is active
*/
@ApiMember(Description="If the credit card is active")
var Active:Boolean? = null
/**
* If the credit card is valid (active and not expired)
*/
@ApiMember(Description="If the credit card is valid (active and not expired)")
var IsValid:Boolean? = null
/**
* The credit card type
*/
@ApiMember(Description="The credit card type")
var Type:String? = null
/**
* The credit card expiration Year
*/
@ApiMember(Description="The credit card expiration Year")
var ExpYear:String? = null
/**
* The credit card expiration month
*/
@ApiMember(Description="The credit card expiration month")
var ExpMonth:String? = null
/**
* The credit card ticket name. This is secret information and won't be displayed
*/
@ApiMember(Description="The credit card ticket name. This is secret information and won't be displayed")
var TicketId:String? = null
/**
* The date when the credit card was saved.
*/
@ApiMember(Description="The date when the credit card was saved.")
var Created:Date? = null
/**
* The date when the credit card was updated.
*/
@ApiMember(Description="The date when the credit card was updated.")
var Updated:Date? = null
}
@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 CompanyCreditCardInformation DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /billing/company/creditcard HTTP/1.1 Host: testapi.bokamera.se Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"Id":0,"Name":"String","Active":false,"IsValid":false,"Type":"String","ExpYear":"String","ExpMonth":"String","TicketId":"String","Created":"0001-01-01T00:00:00","Updated":"0001-01-01T00:00:00"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}