BokaMera.API.Host

PaymentLogQuery

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

The following routes are available for this service:
GET	/articles/payments	Query payment logs	Query payment logs

**PaymentLogQuery** 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.
CreatedFrom	query	dateTime	No	Start of interval to query for payments when they where created. UTC+0 and parameter as defined by date-time - RFC3339
CreatedTo	query	dateTime	No	End of interval to query for payments when they where created. UTC+0 and parameter as defined by date-time - RFC3339
ArticleTypeId	query	int?	Yes	Article type (Could be Service, rebate code types, etc..
IncludeArticleType	query	bool	No

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

**PaymentLog** Parameters:
Name	Parameter	Data Type	Required
CurrencyId	form	string	Yes
CurrencyInfo	form	Currency	Yes
CompanyId	form	Guid	Yes
Id	form	int	No
InternalReferenceId	form	string	Yes
ArticleTypeId	form	int	Yes
PaymentReferenceId	form	string	No
PaymentProviderId	form	int?	No
OrderItemReferenceId	form	string	No
Amount	form	double?	No
VAT	form	decimal?	No
AmountCredited	form	double?	No
Comments	form	string	No
Created	form	DateTime	Yes
Updated	form	DateTime	Yes
ModifiedDate	form	DateTimeOffset?	No

**Currency** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	Yes
CurrencySign	form	string	Yes
Active	form	bool	Yes
ModifiedDate	form	DateTimeOffset?	No
Id	form	string	Yes

**PaymentLogQueryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No	The payment log id
InternalReference	form	int	No	The internal reference id, could be reference to a booking, rebate code, gift card etc.
PaymentReferenceId	form	string	Yes	The payment reference id
OrderItemReferenceId	form	string	Yes	The payment order item reference id
PaymentProviderId	form	int?	No	The payment reference id
Amount	form	double	No	The payment amount
ArticleType	form	ArticleType	Yes	The article type
VAT	form	decimal	No	The payment VAT in percent
AmountCredited	form	double	No	The payment amount that is credited
CurrencyId	form	string	Yes	The payment currency id
CurrencyInfo	form	CurrencyInfoResponse	Yes	The payment currency info
Comments	form	string	Yes	Comments that could be added to the event log item
Created	form	DateTime	No	The date when the payment items was created
Updated	form	DateTime	No	The date when the payment items were updated.

**ArticleType** Parameters:
Name	Parameter	Data Type	Required
ArticleTypeId	form	int	No
ArticleTypeName	form	string	Yes
ArticleTypeDescription	form	string	No

**CurrencyInfoResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	Yes	The currency id
Name	form	string	Yes	The currency id
CurrencySign	form	string	Yes	The currency id

**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 /articles/payments 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,
			InternalReference: 0,
			PaymentReferenceId: String,
			OrderItemReferenceId: String,
			PaymentProviderId: 0,
			Amount: 0,
			ArticleType: 
			{
				ArticleTypeId: 0,
				ArticleTypeName: String,
				ArticleTypeDescription: String
			},
			VAT: 0,
			AmountCredited: 0,
			CurrencyId: String,
			CurrencyInfo: 
			{
				Id: String,
				Name: String,
				CurrencySign: String
			},
			Comments: String
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}