BokaMera.API.Host

<back to all web services

EaccountingInvoiceQuery

The following routes are available for this service:
GET/eaccounting/invoices
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
{
    public partial class AccessKeyTypeResponse
    {
        public virtual int Id { get; set; }
        public virtual string KeyType { get; set; }
        public virtual string Description { get; set; }
    }

}

namespace ServiceStack
{
    [DataContract]
    public partial class QueryBase
    {
        [DataMember(Order=1)]
        public virtual int? Skip { get; set; }

        [DataMember(Order=2)]
        public virtual int? Take { get; set; }

        [DataMember(Order=3)]
        public virtual string? OrderBy { get; set; }

        [DataMember(Order=4)]
        public virtual string? OrderByDesc { get; set; }

        [DataMember(Order=5)]
        public virtual string? Include { get; set; }

        [DataMember(Order=6)]
        public virtual string? Fields { get; set; }

        [DataMember(Order=7)]
        public virtual Dictionary<string, string>? Meta { get; set; }
    }

    public partial class QueryData<T>
        : QueryBase
    {
    }

    [DataContract]
    public partial class QueryResponse<T>
    {
        [DataMember(Order=1)]
        public virtual int Offset { get; set; }

        [DataMember(Order=2)]
        public virtual int Total { get; set; }

        [DataMember(Order=3)]
        public virtual List<AccessKeyTypeResponse> Results { get; set; } = [];

        [DataMember(Order=4)]
        public virtual Dictionary<string, string>? Meta { get; set; }

        [DataMember(Order=5)]
        public virtual ResponseStatus? ResponseStatus { get; set; }
    }

}

C# EaccountingInvoiceQuery DTOs

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 /eaccounting/invoices 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: 
	[
		{
			TotalAmount: 0,
			TotalVatAmount: 0,
			CustomerId: String,
			Rows: 
			[
				{
					ArticleNumber: String,
					ArticleId: String,
					IsServiceArticle: False,
					AmountNoVat: 0,
					PercentVat: 0,
					LineNumber: 0,
					IsTextRow: False,
					Text: String,
					UnitPrice: 0,
					UnitAbbreviation: String,
					UnitAbbreviationEnglish: String,
					DiscountPercentage: 0,
					Quantity: 0,
					IsWorkCost: False,
					IsVatFree: False,
					CostCenterItemId1: String,
					CostCenterItemId2: String,
					CostCenterItemId3: String,
					UnitId: String,
					ProjectId: String,
					WorkCostType: 0,
					WorkHours: 0,
					MaterialCosts: 0,
					GreenTechnologyType: None,
					ContributionMargin: 
					{
						Amount: 0,
						Percentage: 0
					}
				}
			],
			VatSpecification: 
			[
				{
					AmountInvoiceCurrency: 0,
					VatAmountInvoiceCurrency: 0,
					VatPercent: 0
				}
			],
			InvoiceDate: String,
			DueDate: String,
			DeliveryDate: "0001-01-01T00:00:00",
			Persons: 
			[
				{
					Ssn: String,
					Amount: 0
				}
			],
			InvoiceCustomerName: String,
			InvoiceAddress: 
			{
				CorporateIdentityNumber: String,
				InvoiceAddress1: String,
				InvoiceAddress2: String,
				InvoiceCity: String,
				InvoicePostalCode: String,
				InvoiceCountryCode: String
			},
			CustomerIsPrivatePerson: False,
			TermsOfPaymentId: String,
			TermsOfPaymentData: 
			{
				Id: String,
				Name: String,
				NameEnglish: String,
				NumberOfDays: 0,
				TermsOfPaymentTypeId: 0,
				TermsOfPaymentTypeText: String,
				AvailableForSales: False,
				AvailableForPurchase: False
			},
			CustomerEmail: String,
			InvoiceNumber: 0,
			CustomerNumber: String,
			Notes: 
			[
				{
					Id: String,
					Text: String
				}
			],
			NoteIds: 
			[
				String
			],
			IncludesVat: False,
			SendType: None,
			IsSold: False,
			PaymentDate: "0001-01-01T00:00:00",
			PaymentStatus: Paid,
			PaymentStatusTitle: String,
			CreditedBy: 
			[
				{
					CreditInvoiceId: String
				}
			],
			PriceSign: String,
			BookingId: String
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}