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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfEAccountingDtos.InvoiceDraftQueryResponseWg5EthtI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
    <d2p1:EAccountingDtos.InvoiceDraftQueryResponse>
      <d2p1:BookingId>String</d2p1:BookingId>
      <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
      <d2p1:CreatedUtc>0001-01-01T00:00:00</d2p1:CreatedUtc>
      <d2p1:CustomerId>String</d2p1:CustomerId>
      <d2p1:CustomerIsPrivatePerson>false</d2p1:CustomerIsPrivatePerson>
      <d2p1:CustomerNumber>String</d2p1:CustomerNumber>
      <d2p1:DeliveryDate>0001-01-01T00:00:00</d2p1:DeliveryDate>
      <d2p1:DueDate>String</d2p1:DueDate>
      <d2p1:IncludesVat>false</d2p1:IncludesVat>
      <d2p1:InvoiceAddress>
        <d2p1:CorporateIdentityNumber>String</d2p1:CorporateIdentityNumber>
        <d2p1:InvoiceAddress1>String</d2p1:InvoiceAddress1>
        <d2p1:InvoiceAddress2>String</d2p1:InvoiceAddress2>
        <d2p1:InvoiceCity>String</d2p1:InvoiceCity>
        <d2p1:InvoiceCountryCode>String</d2p1:InvoiceCountryCode>
        <d2p1:InvoicePostalCode>String</d2p1:InvoicePostalCode>
      </d2p1:InvoiceAddress>
      <d2p1:InvoiceCustomerName>String</d2p1:InvoiceCustomerName>
      <d2p1:InvoiceDate>String</d2p1:InvoiceDate>
      <d2p1:InvoiceId>00000000-0000-0000-0000-000000000000</d2p1:InvoiceId>
      <d2p1:NoteIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:NoteIds>
      <d2p1:Notes>
        <d2p1:EAccountingDtos.NoteQueryResponse>
          <d2p1:CreatedUtc>0001-01-01T00:00:00</d2p1:CreatedUtc>
          <d2p1:Id>String</d2p1:Id>
          <d2p1:ModifiedUtc>0001-01-01T00:00:00</d2p1:ModifiedUtc>
          <d2p1:Text>String</d2p1:Text>
        </d2p1:EAccountingDtos.NoteQueryResponse>
      </d2p1:Notes>
      <d2p1:Persons>
        <d2p1:EAccountingClientDtos.Person>
          <d2p1:Amount>0</d2p1:Amount>
          <d2p1:Ssn>String</d2p1:Ssn>
        </d2p1:EAccountingClientDtos.Person>
      </d2p1:Persons>
      <d2p1:PriceSign>String</d2p1:PriceSign>
      <d2p1:Rows>
        <d2p1:EAccountingDtos.InvoiceDraftLineQueryResponse>
          <d2p1:AmountNoVat>0</d2p1:AmountNoVat>
          <d2p1:ArticleId>String</d2p1:ArticleId>
          <d2p1:ArticleNumber>String</d2p1:ArticleNumber>
          <d2p1:ContributionMargin>
            <d2p1:Amount>0</d2p1:Amount>
            <d2p1:Percentage>0</d2p1:Percentage>
          </d2p1:ContributionMargin>
          <d2p1:CostCenterItemId1>String</d2p1:CostCenterItemId1>
          <d2p1:CostCenterItemId2>String</d2p1:CostCenterItemId2>
          <d2p1:CostCenterItemId3>String</d2p1:CostCenterItemId3>
          <d2p1:DiscountPercentage>0</d2p1:DiscountPercentage>
          <d2p1:GreenTechnologyType>None</d2p1:GreenTechnologyType>
          <d2p1:IsServiceArticle>false</d2p1:IsServiceArticle>
          <d2p1:IsTextRow>false</d2p1:IsTextRow>
          <d2p1:IsVatFree>false</d2p1:IsVatFree>
          <d2p1:IsWorkCost>false</d2p1:IsWorkCost>
          <d2p1:LineNumber>0</d2p1:LineNumber>
          <d2p1:MaterialCosts>0</d2p1:MaterialCosts>
          <d2p1:PercentVat>0</d2p1:PercentVat>
          <d2p1:ProjectId>String</d2p1:ProjectId>
          <d2p1:Quantity>0</d2p1:Quantity>
          <d2p1:Text>String</d2p1:Text>
          <d2p1:UnitAbbreviation>String</d2p1:UnitAbbreviation>
          <d2p1:UnitAbbreviationEnglish>String</d2p1:UnitAbbreviationEnglish>
          <d2p1:UnitId>String</d2p1:UnitId>
          <d2p1:UnitPrice>0</d2p1:UnitPrice>
          <d2p1:WorkCostType>0</d2p1:WorkCostType>
          <d2p1:WorkHours>0</d2p1:WorkHours>
        </d2p1:EAccountingDtos.InvoiceDraftLineQueryResponse>
      </d2p1:Rows>
      <d2p1:TotalAmount>0</d2p1:TotalAmount>
      <d2p1:TotalVatAmount>0</d2p1:TotalVatAmount>
    </d2p1:EAccountingDtos.InvoiceDraftQueryResponse>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfEAccountingDtos.InvoiceDraftQueryResponseWg5EthtI>