| 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. |
|---|
// @DataContract
export class QueryBase
{
/** @description 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 Skip?: number;
/** @description 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 Take?: number;
/** @description 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 OrderBy: string;
/** @description 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 OrderByDesc: string;
/** @description 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 Include: string;
// @DataMember(Order=6)
public Fields: string;
// @DataMember(Order=7)
public Meta: { [index: string]: string; };
public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}
export class QueryDb<From, Into> extends QueryBase
{
public constructor(init?: Partial<QueryDb<From, Into>>) { super(init); (Object as any).assign(this, init); }
}
export class CompanyCreditCardQueryResponse
{
/** @description The credit card id */
// @ApiMember(Description="The credit card id")
public Id: number;
/** @description The credit card name */
// @ApiMember(Description="The credit card name")
public Name: string;
/** @description If the credit card is active */
// @ApiMember(Description="If the credit card is active")
public Active: boolean;
/** @description If the credit card is valid (active and not expired) */
// @ApiMember(Description="If the credit card is valid (active and not expired)")
public IsValid: boolean;
/** @description The credit card type */
// @ApiMember(Description="The credit card type")
public Type: string;
/** @description The credit card expiration Year */
// @ApiMember(Description="The credit card expiration Year")
public ExpYear: string;
/** @description The credit card expiration month */
// @ApiMember(Description="The credit card expiration month")
public ExpMonth: string;
/** @description 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")
public TicketId: string;
/** @description The date when the credit card was saved. */
// @ApiMember(Description="The date when the credit card was saved.")
public Created?: string;
/** @description The date when the credit card was updated. */
// @ApiMember(Description="The date when the credit card was updated.")
public Updated?: string;
public constructor(init?: Partial<CompanyCreditCardQueryResponse>) { (Object as any).assign(this, init); }
}
export class BaseModel
{
public constructor(init?: Partial<BaseModel>) { (Object as any).assign(this, init); }
}
export class CreditCard extends BaseModel
{
// @Ignore()
public IsValid: boolean;
// @Required()
public CompanyId: string;
public Id: number;
// @Required()
public Name: string;
// @Required()
public Active: boolean;
// @Required()
public Type: string;
// @Required()
public ExpYear: string;
// @Required()
public ExpMonth: string;
// @Required()
public TicketId: string;
public Updated?: string;
public Created?: string;
public ModifiedDate?: string;
public constructor(init?: Partial<CreditCard>) { super(init); (Object as any).assign(this, init); }
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class CompanyCreditCardInformation extends QueryDb<CreditCard, CompanyCreditCardQueryResponse> implements ICompany
{
/** @description 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 CompanyId?: string;
/** @description If you want to include only active credit cards */
// @ApiMember(DataType="boolean", Description="If you want to include only active credit cards", ParameterType="query")
public Active: boolean;
/** @description 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")
public IsValid: boolean;
public constructor(init?: Partial<CompanyCreditCardInformation>) { super(init); (Object as any).assign(this, init); }
}
export class AccessKeyTypeResponse
{
public Id: number;
public KeyType: string;
public Description: string;
public constructor(init?: Partial<AccessKeyTypeResponse>) { (Object as any).assign(this, init); }
}
// @DataContract
export class QueryResponse<AccessKeyTypeResponse>
{
// @DataMember(Order=1)
public Offset: number;
// @DataMember(Order=2)
public Total: number;
// @DataMember(Order=3)
public Results: AccessKeyTypeResponse[];
// @DataMember(Order=4)
public Meta: { [index: string]: string; };
// @DataMember(Order=5)
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<QueryResponse<AccessKeyTypeResponse>>) { (Object as any).assign(this, init); }
}
TypeScript 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: api.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"}}}