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.
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.API.ServiceModel.Enums;

namespace BokaMera.API.ServiceModel.Dtos
{
    [ValidateRequest("IsAuthenticated")]
    public partial class QuerySummarizedInvoices
        : ICompany
    {
        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///Filter by customer id.
        ///</summary>
        [ApiMember(Description="Filter by customer id.")]
        public virtual Guid? CustomerId { get; set; }

        ///<summary>
        ///Filter by date from.
        ///</summary>
        [ApiMember(Description="Filter by date from.")]
        public virtual DateTime? DateFrom { get; set; }

        ///<summary>
        ///Filter by date to.
        ///</summary>
        [ApiMember(Description="Filter by date to.")]
        public virtual DateTime? DateTo { get; set; }

        ///<summary>
        ///Filter by status (0=Pending, 1=Processing, 2=Completed, 3=Failed).
        ///</summary>
        [ApiMember(Description="Filter by status (0=Pending, 1=Processing, 2=Completed, 3=Failed).")]
        public virtual SummarizedInvoiceStatus? Status { get; set; }
    }

    public partial class QuerySummarizedInvoicesResponse
    {
        public virtual List<SummarizedInvoiceDetailResponse> Results { get; set; } = [];
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class SummarizedInvoiceDetailResponse
    {
        public virtual Guid Id { get; set; }
        public virtual Guid CompanyId { get; set; }
        public virtual Guid CustomerId { get; set; }
        public virtual string CustomerName { get; set; }
        public virtual string? EAccountingInvoiceId { get; set; }
        public virtual bool Draft { get; set; }
        public virtual DateTime DateFrom { get; set; }
        public virtual DateTime DateTo { get; set; }
        public virtual int? ServiceId { get; set; }
        public virtual int Status { get; set; }
        public virtual string StatusName { get; set; }
        public virtual string? ErrorMessage { get; set; }
        public virtual List<int> BookingIds { get; set; } = [];
        public virtual DateTime CreatedDate { get; set; }
        public virtual DateTime UpdatedDate { get; set; }
    }

}

namespace BokaMera.API.ServiceModel.Enums
{
    public enum SummarizedInvoiceStatus
    {
        Pending,
        Processing,
        Completed,
        Failed,
    }

}

C# QuerySummarizedInvoices DTOs

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"}}}