BokaMera.API.Host

<back to all web services

EaccountingInvoiceQuery

The following routes are available for this service:
GET/eaccounting/invoices
import Foundation
import ServiceStack

public class EaccountingInvoiceQuery : EAccountingPagination, ICompany
{
    public var bookingId:Int?
    public var paid:Bool?
    public var includeInvoiceLines:Bool
    public var includeInvoiceNotes:Bool
    public var includePaymentTermData:Bool
    public var includeInvoiceAddress:Bool
    public var companyId:String?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case bookingId
        case paid
        case includeInvoiceLines
        case includeInvoiceNotes
        case includePaymentTermData
        case includeInvoiceAddress
        case companyId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        bookingId = try container.decodeIfPresent(Int.self, forKey: .bookingId)
        paid = try container.decodeIfPresent(Bool.self, forKey: .paid)
        includeInvoiceLines = try container.decodeIfPresent(Bool.self, forKey: .includeInvoiceLines)
        includeInvoiceNotes = try container.decodeIfPresent(Bool.self, forKey: .includeInvoiceNotes)
        includePaymentTermData = try container.decodeIfPresent(Bool.self, forKey: .includePaymentTermData)
        includeInvoiceAddress = try container.decodeIfPresent(Bool.self, forKey: .includeInvoiceAddress)
        companyId = try container.decodeIfPresent(String.self, forKey: .companyId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if bookingId != nil { try container.encode(bookingId, forKey: .bookingId) }
        if paid != nil { try container.encode(paid, forKey: .paid) }
        if includeInvoiceLines != nil { try container.encode(includeInvoiceLines, forKey: .includeInvoiceLines) }
        if includeInvoiceNotes != nil { try container.encode(includeInvoiceNotes, forKey: .includeInvoiceNotes) }
        if includePaymentTermData != nil { try container.encode(includePaymentTermData, forKey: .includePaymentTermData) }
        if includeInvoiceAddress != nil { try container.encode(includeInvoiceAddress, forKey: .includeInvoiceAddress) }
        if companyId != nil { try container.encode(companyId, forKey: .companyId) }
    }
}

public class EAccountingPagination : Codable
{
    /**
    * Page number that will be fetched to e-accounting client; Default 1
    */
    // @DataMember(Order=1)
    // @ApiMember(Description="Page number that will be fetched to e-accounting client; Default 1")
    public var pageNumber:Int?

    /**
    * Page size that will be fetched to e-accounting client; Default 75~
    */
    // @DataMember(Order=2)
    // @ApiMember(Description="Page size that will be fetched to e-accounting client; Default 75~")
    public var pageSize:Int?

    required public init(){}
}

public class InvoiceQueryResponse : Codable
{
    public var invoiceId:String
    public var createdDate:Date
    public var totalAmount:Double
    public var totalVatAmount:Double
    public var customerId:String
    public var rows:[InvoiceLineQueryResponse] = []
    public var vatSpecification:[VatSpecificationQueryResponse] = []
    public var invoiceDate:String
    public var dueDate:String
    public var deliveryDate:Date?
    public var persons:[Person] = []
    public var invoiceCustomerName:String
    public var invoiceAddress:InvoiceAddress
    public var customerIsPrivatePerson:Bool
    public var termsOfPaymentId:String
    public var termsOfPaymentData:EAccountingTermsOfPaymentQueryResponse
    public var customerEmail:String
    public var invoiceNumber:Int
    public var customerNumber:String
    public var notes:[NoteQueryResponse] = []
    public var noteIds:[String] = []
    public var createdUtc:Date
    public var modifiedUtc:Date
    public var includesVat:Bool
    public var sendType:EAccountingInvoiceSendTypes?
    public var isSold:Bool
    public var paymentDate:Date?
    public var paymentStatus:PaymentStatus
    public var paymentStatusTitle:String
    public var creditedBy:[CreditedBy] = []
    public var priceSign:String
    public var bookingId:String

    required public init(){}
}

public class InvoiceLineQueryResponse : Codable
{
    public var articleNumber:String
    public var articleId:String
    public var isServiceArticle:Bool
    public var amountNoVat:Double
    public var percentVat:Double?
    public var lineNumber:Int
    public var isTextRow:Bool
    public var text:String
    public var unitPrice:Double
    public var unitAbbreviation:String
    public var unitAbbreviationEnglish:String
    public var discountPercentage:Double
    public var quantity:Float
    public var isWorkCost:Bool
    public var isVatFree:Bool
    public var costCenterItemId1:String
    public var costCenterItemId2:String
    public var costCenterItemId3:String
    public var unitId:String
    public var projectId:String
    public var workCostType:Int?
    public var workHours:Float?
    public var materialCosts:Double?
    public var greenTechnologyType:GreenTechnologyType?
    public var contributionMargin:ContributionMargin

    required public init(){}
}

public enum GreenTechnologyType : String, Codable
{
    case None
    case SolarCellInstallation
    case ElectricEnergyStorageInstallation
    case ElectricVehicleChargingPointInstallation
}

public class ContributionMargin : Codable
{
    public var amount:Int?
    public var percentage:Int?

    required public init(){}
}

public class VatSpecificationQueryResponse : Codable
{
    public var amountInvoiceCurrency:Double
    public var vatAmountInvoiceCurrency:Double
    public var vatPercent:Double

    required public init(){}
}

public class Person : Codable
{
    public var ssn:String
    public var amount:Int

    required public init(){}
}

public class InvoiceAddress : Codable
{
    public var corporateIdentityNumber:String
    public var invoiceAddress1:String
    public var invoiceAddress2:String
    public var invoiceCity:String
    public var invoicePostalCode:String
    public var invoiceCountryCode:String

    required public init(){}
}

public class EAccountingTermsOfPaymentQueryResponse : Codable
{
    public var id:String
    public var name:String
    public var nameEnglish:String
    public var numberOfDays:Int
    public var termsOfPaymentTypeId:Int
    public var termsOfPaymentTypeText:String
    public var availableForSales:Bool
    public var availableForPurchase:Bool

    required public init(){}
}

public class NoteQueryResponse : Codable
{
    public var id:String
    public var text:String
    public var createdUtc:Date
    public var modifiedUtc:Date

    required public init(){}
}

public enum EAccountingInvoiceSendTypes : String, Codable
{
    case None
    case AutoInvoiceElectronic
    case AutoInvoicePrint
    case AutoInvoiceB2C
}

public enum PaymentStatus : String, Codable
{
    case Paid
    case Unpaid
    case Overdue
}

public class CreditedBy : Codable
{
    public var creditInvoiceId:String

    required public init(){}
}


Swift 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: testapi.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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