BokaMera.API.Host

CompanyCreditCardInformation

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin

The following routes are available for this service:
GET	/billing/company/creditcard	Get saved credit card information for the company.	Get saved credit card information for the company.

**CompanyCreditCardInformation** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	query	Guid?	No	The company id, if empty will use the company id for the user you are logged in with.
Active	query	boolean	No	If you want to include only active credit cards
IsValid	query	boolean	No	If you want to include only valid credit cards (not expired and valid)

**QueryBase** Parameters:
Name	Parameter	Data Type	Required	Description
Skip	query	int	No	Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging. Example: `?skip=10&orderBy=Id`
Take	query	int	No	Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging. Example: `?take=20`
OrderBy	query	string	No	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. Example: `?orderBy=Id,-Age,FirstName`
OrderByDesc	query	string	No	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. Example: `?orderByDesc=Id,-Age,FirstName`
Include	query	string	No	Include any of the aggregates `AVG, COUNT, FIRST, LAST, MAX, MIN, SUM` in your result set. The results will be returned in the meta field. Example: `?include=COUNT() as Total` or multiple fields with `?include=Count() Total, Min(Age), AVG(Age) AverageAge` or unique with `?include=COUNT(DISTINCT LivingStatus) as UniqueStatus`
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**CreditCard** Parameters:
Name	Parameter	Data Type	Required
IsValid	form	bool	No
CompanyId	form	Guid	Yes
Id	form	int	No
Name	form	string	Yes
Active	form	bool	Yes
Type	form	string	Yes
ExpYear	form	string	Yes
ExpMonth	form	string	Yes
TicketId	form	string	Yes
Updated	form	DateTime?	No
Created	form	DateTime?	No
ModifiedDate	form	DateTimeOffset?	No

**CompanyCreditCardQueryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No	The credit card id
Name	form	string	Yes	The credit card name
Active	form	bool	No	If the credit card is active
IsValid	form	bool	No	If the credit card is valid (active and not expired)
Type	form	string	Yes	The credit card type
ExpYear	form	string	Yes	The credit card expiration Year
ExpMonth	form	string	Yes	The credit card expiration month
TicketId	form	string	Yes	The credit card ticket name. This is secret information and won't be displayed
Created	form	DateTime?	No	The date when the credit card was saved.
Updated	form	DateTime?	No	The date when the credit card was updated.

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<AccessKeyTypeResponse>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

**AccessKeyTypeResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
KeyType	form	string	Yes
Description	form	string	Yes

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

HTTP + JSV

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.bookmore.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}