BokaMera.API.Host

<back to all web services

QuerySummarizedInvoices

Requires Authentication
The following routes are available for this service:
GET/eaccounting/summarizedinvoicesList summarized invoices with optional filtersQuery summarized invoices by company, customer, date range, and status.
QuerySummarizedInvoices Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
CustomerIdqueryGuid?NoFilter by customer id.
DateFromqueryDateTime?NoFilter by date from.
DateToqueryDateTime?NoFilter by date to.
StatusquerySummarizedInvoiceStatus?NoFilter by status (0=Pending, 1=Processing, 2=Completed, 3=Failed).
SummarizedInvoiceStatus Enum:
Pending
Processing
Completed
Failed
QuerySummarizedInvoicesResponse Parameters:
NameParameterData TypeRequiredDescription
ResultsformList<SummarizedInvoiceDetailResponse>Yes
ResponseStatusformResponseStatusYes
SummarizedInvoiceDetailResponse Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
CompanyIdformGuidNo
CustomerIdformGuidNo
CustomerNameformstringYes
EAccountingInvoiceIdformstringNo
DraftformboolNo
DateFromformDateTimeNo
DateToformDateTimeNo
ServiceIdformint?No
StatusformintNo
StatusNameformstringYes
ErrorMessageformstringNo
BookingIdsformList<int>Yes
CreatedDateformDateTimeNo
UpdatedDateformDateTimeNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /eaccounting/summarizedinvoices HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Results":[{"CustomerName":"String","EAccountingInvoiceId":"String","Draft":false,"ServiceId":0,"Status":0,"StatusName":"String","ErrorMessage":"String","BookingIds":[0]}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}