BokaMera.API.Host

<back to all web services

EAccountingInvoiceDraftQuery

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

public class EAccountingInvoiceDraftQuery : QueryData<InvoiceDraftQueryResponse>, ICompany
{
    public var bookingId:Int?
    public var includeInvoiceLines:Bool
    public var includeInvoiceNotes:Bool
    public var companyId:String?

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

    private enum CodingKeys : String, CodingKey {
        case bookingId
        case includeInvoiceLines
        case includeInvoiceNotes
        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)
        includeInvoiceLines = try container.decodeIfPresent(Bool.self, forKey: .includeInvoiceLines)
        includeInvoiceNotes = try container.decodeIfPresent(Bool.self, forKey: .includeInvoiceNotes)
        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 includeInvoiceLines != nil { try container.encode(includeInvoiceLines, forKey: .includeInvoiceLines) }
        if includeInvoiceNotes != nil { try container.encode(includeInvoiceNotes, forKey: .includeInvoiceNotes) }
        if companyId != nil { try container.encode(companyId, forKey: .companyId) }
    }
}

public class InvoiceDraftQueryResponse : Codable
{
    public var invoiceId:String
    public var createdDate:Date?
    public var totalAmount:Double?
    public var totalVatAmount:Double?
    public var customerId:String
    public var rows:[InvoiceDraftLineQueryResponse] = []
    public var invoiceDate:String
    public var dueDate:String
    public var deliveryDate:Date?
    public var persons:[Person] = []
    public var invoiceCustomerName:String
    public var invoiceAddress:EAccountingInvoiceAddress
    public var customerIsPrivatePerson:Bool
    public var customerNumber:String
    public var notes:[NoteQueryResponse] = []
    public var noteIds:[String] = []
    public var createdUtc:Date
    public var includesVat:Bool
    public var priceSign:String
    public var bookingId:String

    required public init(){}
}

public class InvoiceDraftLineQueryResponse : 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:Double?
    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:Double?
    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 Person : Codable
{
    public var ssn:String
    public var amount:Int

    required public init(){}
}

public class EAccountingInvoiceAddress : 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 NoteQueryResponse : Codable
{
    public var id:String
    public var text:String
    public var createdUtc:Date
    public var modifiedUtc:Date

    required public init(){}
}

public class AccessKeyTypeResponse : Codable
{
    public var id:Int
    public var keyType:String
    public var Description:String

    required public init(){}
}


Swift EAccountingInvoiceDraftQuery 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/invoicedrafts 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: 
	[
		{
			CreatedDate: "0001-01-01T00:00:00",
			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
					}
				}
			],
			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,
			CustomerNumber: String,
			Notes: 
			[
				{
					Id: String,
					Text: String
				}
			],
			NoteIds: 
			[
				String
			],
			IncludesVat: False,
			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
		}
	}
}