BokaMera.API.Host

<back to all web services

EAccountingCustomerQuery

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

public class EAccountingCustomerQuery : QueryData<EAccountingCustomerQueryResponse>, ICompany
{
    public var companyId:String?

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

    private enum CodingKeys : String, CodingKey {
        case companyId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        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 companyId != nil { try container.encode(companyId, forKey: .companyId) }
    }
}

public class EAccountingCustomerQueryResponse : Codable
{
    public var id:String
    public var customerNumber:String
    public var corporateIdentityNumber:String
    public var contactPersonEmail:String
    public var contactPersonMobile:String
    public var contactPersonName:String
    public var contactPersonPhone:String
    public var currencyCode:String
    public var gln:String
    public var invoiceCity:String
    public var invoicePostalCode:String
    public var emailAddress:String
    public var emailAddressOrder:String
    public var emailAddressQuote:String
    public var invoiceAddress:EAccountingInvoiceAddress
    public var deliveryCustomerName:String
    public var deliveryAddress1:String
    public var deliveryAddress2:String
    public var deliveryCity:String
    public var deliveryCountryCode:String
    public var deliveryPostalCode:String
    public var deliveryMethodId:String
    public var deliveryTermId:String
    public var payToAccountId:String
    public var name:String
    public var note:String
    public var reverseChargeOnConstructionServices:Bool
    public var webshopCustomerNumber:Int?
    public var mobilePhone:String
    public var telephone:String
    public var termsOfPaymentId:String
    public var eAccountingTermsOfPayment:EAccountingTermsOfPaymentQueryResponse
    public var vatNumber:String
    public var wwwAddress:String
    public var lastInvoiceDate:String
    public var isPrivatePerson:Bool
    public var isNorthernIreland:Bool
    public var discountPercentage:Double?
    public var changedUtc:Date?
    public var isActive:Bool
    public var forceBookkeepVat:Bool
    public var ediGlnNumber:String
    public var salesDocumentLanguage:String
    public var electronicAddress:String
    public var electronicReference:String
    public var ediServiceDelivererId:String
    public var autoInvoiceActivationEmailSentDate:Date?
    public var autoInvoiceRegistrationRequestSentDate:Date?
    public var emailAddresses:[String] = []
    public var customerLabels:[CustomerLabelQueryResponse] = []
    public var messageThreads:[String] = []
    public var notes:[String] = []
    public var isFutureInvoiceDateAllowed:Bool
    public var deliveryBasedVat:Bool
    public var salesPriceListId:String
    public var iban:String
    public var directDebitCustomerSettings:DirectDebitCustomerSettingsQueryResponse
    public var discountAgreementId:String
    public var unpaidInvoicesAmount:Double

    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 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 CustomerLabelQueryResponse : Codable
{
    public var id:String
    public var name:String
    public var Description:String

    required public init(){}
}

public class DirectDebitCustomerSettingsQueryResponse : Codable
{
    public var mandateId:String
    public var mandateType:Int
    public var sequenceType:Int
    public var signingDate:Date
    public var endDate:Date
    public var latestDirectDebit:Date

    required public init(){}
}

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

    required public init(){}
}


Swift EAccountingCustomerQuery 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/customers HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfEAccountingDtos.EAccountingCustomerQueryResponseWg5EthtI 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.EAccountingCustomerQueryResponse>
      <d2p1:AutoInvoiceActivationEmailSentDate>0001-01-01T00:00:00</d2p1:AutoInvoiceActivationEmailSentDate>
      <d2p1:AutoInvoiceRegistrationRequestSentDate>0001-01-01T00:00:00</d2p1:AutoInvoiceRegistrationRequestSentDate>
      <d2p1:ChangedUtc>0001-01-01T00:00:00</d2p1:ChangedUtc>
      <d2p1:ContactPersonEmail>String</d2p1:ContactPersonEmail>
      <d2p1:ContactPersonMobile>String</d2p1:ContactPersonMobile>
      <d2p1:ContactPersonName>String</d2p1:ContactPersonName>
      <d2p1:ContactPersonPhone>String</d2p1:ContactPersonPhone>
      <d2p1:CorporateIdentityNumber>String</d2p1:CorporateIdentityNumber>
      <d2p1:CurrencyCode>String</d2p1:CurrencyCode>
      <d2p1:CustomerLabels>
        <d2p1:EAccountingDtos.CustomerLabelQueryResponse>
          <d2p1:Description>String</d2p1:Description>
          <d2p1:Id>String</d2p1:Id>
          <d2p1:Name>String</d2p1:Name>
        </d2p1:EAccountingDtos.CustomerLabelQueryResponse>
      </d2p1:CustomerLabels>
      <d2p1:CustomerNumber>String</d2p1:CustomerNumber>
      <d2p1:DeliveryAddress1>String</d2p1:DeliveryAddress1>
      <d2p1:DeliveryAddress2>String</d2p1:DeliveryAddress2>
      <d2p1:DeliveryBasedVat>false</d2p1:DeliveryBasedVat>
      <d2p1:DeliveryCity>String</d2p1:DeliveryCity>
      <d2p1:DeliveryCountryCode>String</d2p1:DeliveryCountryCode>
      <d2p1:DeliveryCustomerName>String</d2p1:DeliveryCustomerName>
      <d2p1:DeliveryMethodId>String</d2p1:DeliveryMethodId>
      <d2p1:DeliveryPostalCode>String</d2p1:DeliveryPostalCode>
      <d2p1:DeliveryTermId>String</d2p1:DeliveryTermId>
      <d2p1:DirectDebitCustomerSettings>
        <d2p1:EndDate>0001-01-01T00:00:00</d2p1:EndDate>
        <d2p1:LatestDirectDebit>0001-01-01T00:00:00</d2p1:LatestDirectDebit>
        <d2p1:MandateId>String</d2p1:MandateId>
        <d2p1:MandateType>0</d2p1:MandateType>
        <d2p1:SequenceType>0</d2p1:SequenceType>
        <d2p1:SigningDate>0001-01-01T00:00:00</d2p1:SigningDate>
      </d2p1:DirectDebitCustomerSettings>
      <d2p1:DiscountAgreementId>String</d2p1:DiscountAgreementId>
      <d2p1:DiscountPercentage>0</d2p1:DiscountPercentage>
      <d2p1:EAccountingTermsOfPayment>
        <d2p1:AvailableForPurchase>false</d2p1:AvailableForPurchase>
        <d2p1:AvailableForSales>false</d2p1:AvailableForSales>
        <d2p1:Id>String</d2p1:Id>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:NameEnglish>String</d2p1:NameEnglish>
        <d2p1:NumberOfDays>0</d2p1:NumberOfDays>
        <d2p1:TermsOfPaymentTypeId>0</d2p1:TermsOfPaymentTypeId>
        <d2p1:TermsOfPaymentTypeText>String</d2p1:TermsOfPaymentTypeText>
      </d2p1:EAccountingTermsOfPayment>
      <d2p1:EdiGlnNumber>String</d2p1:EdiGlnNumber>
      <d2p1:EdiServiceDelivererId>String</d2p1:EdiServiceDelivererId>
      <d2p1:ElectronicAddress>String</d2p1:ElectronicAddress>
      <d2p1:ElectronicReference>String</d2p1:ElectronicReference>
      <d2p1:EmailAddress>String</d2p1:EmailAddress>
      <d2p1:EmailAddressOrder>String</d2p1:EmailAddressOrder>
      <d2p1:EmailAddressQuote>String</d2p1:EmailAddressQuote>
      <d2p1:EmailAddresses xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:EmailAddresses>
      <d2p1:ForceBookkeepVat>false</d2p1:ForceBookkeepVat>
      <d2p1:GLN>String</d2p1:GLN>
      <d2p1:Iban>String</d2p1:Iban>
      <d2p1:Id>String</d2p1:Id>
      <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:InvoiceCity>String</d2p1:InvoiceCity>
      <d2p1:InvoicePostalCode>String</d2p1:InvoicePostalCode>
      <d2p1:IsActive>false</d2p1:IsActive>
      <d2p1:IsFutureInvoiceDateAllowed>false</d2p1:IsFutureInvoiceDateAllowed>
      <d2p1:IsNorthernIreland>false</d2p1:IsNorthernIreland>
      <d2p1:IsPrivatePerson>false</d2p1:IsPrivatePerson>
      <d2p1:LastInvoiceDate>String</d2p1:LastInvoiceDate>
      <d2p1:MessageThreads xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:MessageThreads>
      <d2p1:MobilePhone>String</d2p1:MobilePhone>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Note>String</d2p1:Note>
      <d2p1:Notes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Notes>
      <d2p1:PayToAccountId>String</d2p1:PayToAccountId>
      <d2p1:ReverseChargeOnConstructionServices>false</d2p1:ReverseChargeOnConstructionServices>
      <d2p1:SalesDocumentLanguage>String</d2p1:SalesDocumentLanguage>
      <d2p1:SalesPriceListId>String</d2p1:SalesPriceListId>
      <d2p1:Telephone>String</d2p1:Telephone>
      <d2p1:TermsOfPaymentId>String</d2p1:TermsOfPaymentId>
      <d2p1:UnpaidInvoicesAmount>0</d2p1:UnpaidInvoicesAmount>
      <d2p1:VatNumber>String</d2p1:VatNumber>
      <d2p1:WebshopCustomerNumber>0</d2p1:WebshopCustomerNumber>
      <d2p1:WwwAddress>String</d2p1:WwwAddress>
    </d2p1:EAccountingDtos.EAccountingCustomerQueryResponse>
  </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.EAccountingCustomerQueryResponseWg5EthtI>