BokaMera.API.Host

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/company	Get billing details for the company.	Get billing details for the company.

**CompanyBillingInformation** 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.
IncludeBillingMethodOptions	query	boolean	No	If you want to include the billing methods to select from

**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

**BillingInformation** Parameters:
Name	Parameter	Data Type	Required
BillingMethod	form	BillingMethod	No
BillingMethodId	form	int	Yes
Name	form	string	Yes
Attention	form	string	No
Street1	form	string	No
Street2	form	string	No
ZipCode	form	string	No
City	form	string	No
Email	form	string	No
CreditCard	form	string	No
CreditCardHolder	form	string	No
CreditCardNumber	form	string	No
ValidToYear	form	short?	No
ValidToMonth	form	short?	No
CSV	form	string	No
Updated	form	DateTime	Yes
Created	form	DateTime	Yes
CountryId	form	string	Yes
PaymentTermsDays	form	int	Yes
VATRegistrationNumber	form	string	No
GLN	form	string	No
ReferenceLine1	form	string	No
ReferenceLine2	form	string	No
ModifiedDate	form	DateTimeOffset?	No
Id	form	Guid	Yes

**BillingMethod** Parameters:
Name	Parameter	Data Type	Required
BillingMethodCountriesRelation	form	List<BillingMethodCountriesRelation>	No
Name	form	string	Yes
Description	form	string	Yes
ModifiedDate	form	DateTimeOffset?	No
Id	form	int	No

**BillingMethodCountriesRelation** Parameters:
Name	Parameter	Data Type	Required
BillingMethodId	form	int	Yes
CountryId	form	string	Yes
ModifiedDate	form	DateTimeOffset?	No

**BillingMethodQueryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No	The billing method id
Name	form	string	No	The billing method name
Description	form	string	No	The billing method description
Countries	form	List<string>	No	The billing method is valid for the following countries

**QueryResponse<AccessKeyTypeResponse>** 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	No
Description	form	string	No

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 HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv

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