BokaMera.API.Host

<back to all web services

SuperAdminAdditionalInvoiceQuery

Requires Authentication
Required role:superadminRequires the role:superadmin
The following routes are available for this service:
GET/superadmin/billing/company/additionalinvoicesGet all company additional invoices for the subscriptionGet all company additional invoices for the subscription you have assigned to.
SuperAdminAdditionalInvoiceQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
IdqueryGuid?NoId of the invoice
QueryBase Parameters:
NameParameterData TypeRequiredDescription
SkipqueryintNoSkip 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
TakequeryintNoReturn a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.

Example:
?take=20
OrderByquerystringNoComma 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
OrderByDescquerystringNoComma 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
IncludequerystringNoInclude 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
FieldsformstringNo
MetaformDictionary<string, string>No
AdditionalInvoicing Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
IdformGuidYes
ArticleNoformintNo
QuantityformintNo
DescriptionformstringNo
DateformDateTime?No
CreatedByformstringNo
CreatedDateformDateTimeNo
UpdatedDateformDateTimeYes
SyncedToAccountingformboolNo
AccountingSystemInfoformstringNo
ModifiedDateformDateTimeOffset?No
AdditionalInvoiceQueryResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNoThe company id
IdformGuid?NoThe invoice id
ArticleNoformintNoArticleNo
QuantityformintNoQuantity
DescriptionformstringNoDescription
DateformDateTime?NoInvoie date
CreatedByformstringNoCreated By
CreatedDateformDateTimeNoCreated Date
UpdatedDateformDateTimeNoUpdated Date
QueryResponse<AccessKeyTypeResponse> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<AccessKeyTypeResponse>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
AccessKeyTypeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
KeyTypeformstringNo
DescriptionformstringNo

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /superadmin/billing/company/additionalinvoices HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"Id":"00000000-0000-0000-0000-000000000000","ArticleNo":0,"Quantity":0,"Description":"String","Date":"0001-01-01T00:00:00","CreatedBy":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}