BokaMera.API.Host

<back to all web services

EaccountingInvoiceQuery

The following routes are available for this service:
GET/eaccounting/invoices
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type GreenTechnologyType =
        | None = 0
        | SolarCellInstallation = 1
        | ElectricEnergyStorageInstallation = 2
        | ElectricVehicleChargingPointInstallation = 3

    [<AllowNullLiteral>]
    type ContributionMargin() = 
        member val Amount:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Percentage:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type InvoiceLineQueryResponse() = 
        member val ArticleNumber:String = null with get,set
        member val ArticleId:String = null with get,set
        member val IsServiceArticle:Boolean = new Boolean() with get,set
        member val AmountNoVat:Decimal = new Decimal() with get,set
        member val PercentVat:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val LineNumber:Int32 = new Int32() with get,set
        member val IsTextRow:Boolean = new Boolean() with get,set
        member val Text:String = null with get,set
        member val UnitPrice:Decimal = new Decimal() with get,set
        member val UnitAbbreviation:String = null with get,set
        member val UnitAbbreviationEnglish:String = null with get,set
        member val DiscountPercentage:Decimal = new Decimal() with get,set
        member val Quantity:Single = new Single() with get,set
        member val IsWorkCost:Boolean = new Boolean() with get,set
        member val IsVatFree:Boolean = new Boolean() with get,set
        member val CostCenterItemId1:String = null with get,set
        member val CostCenterItemId2:String = null with get,set
        member val CostCenterItemId3:String = null with get,set
        member val UnitId:String = null with get,set
        member val ProjectId:String = null with get,set
        member val WorkCostType:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val WorkHours:Nullable<Single> = new Nullable<Single>() with get,set
        member val MaterialCosts:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val GreenTechnologyType:Nullable<GreenTechnologyType> = new Nullable<GreenTechnologyType>() with get,set
        member val ContributionMargin:ContributionMargin = null with get,set

    [<AllowNullLiteral>]
    type VatSpecificationQueryResponse() = 
        member val AmountInvoiceCurrency:Decimal = new Decimal() with get,set
        member val VatAmountInvoiceCurrency:Decimal = new Decimal() with get,set
        member val VatPercent:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type Person() = 
        member val Ssn:String = null with get,set
        member val Amount:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type EAccountingInvoiceAddress() = 
        member val CorporateIdentityNumber:String = null with get,set
        member val InvoiceAddress1:String = null with get,set
        member val InvoiceAddress2:String = null with get,set
        member val InvoiceCity:String = null with get,set
        member val InvoicePostalCode:String = null with get,set
        member val InvoiceCountryCode:String = null with get,set

    [<AllowNullLiteral>]
    type EAccountingTermsOfPaymentQueryResponse() = 
        member val Id:String = null with get,set
        member val Name:String = null with get,set
        member val NameEnglish:String = null with get,set
        member val NumberOfDays:Int32 = new Int32() with get,set
        member val TermsOfPaymentTypeId:Int32 = new Int32() with get,set
        member val TermsOfPaymentTypeText:String = null with get,set
        member val AvailableForSales:Boolean = new Boolean() with get,set
        member val AvailableForPurchase:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type NoteQueryResponse() = 
        member val Id:String = null with get,set
        member val Text:String = null with get,set
        member val CreatedUtc:DateTime = new DateTime() with get,set
        member val ModifiedUtc:DateTime = new DateTime() with get,set

    type EAccountingInvoiceSendTypes =
        | None = 0
        | AutoInvoiceElectronic = 1
        | AutoInvoicePrint = 2
        | AutoInvoiceB2C = 3

    type PaymentStatus =
        | Paid = 0
        | Unpaid = 1
        | Overdue = 2

    [<AllowNullLiteral>]
    type CreditedBy() = 
        member val CreditInvoiceId:String = null with get,set

    [<AllowNullLiteral>]
    type InvoiceQueryResponse() = 
        member val InvoiceId:Guid = new Guid() with get,set
        member val CreatedDate:DateTime = new DateTime() with get,set
        member val TotalAmount:Decimal = new Decimal() with get,set
        member val TotalVatAmount:Decimal = new Decimal() with get,set
        member val CustomerId:String = null with get,set
        member val Rows:ResizeArray<InvoiceLineQueryResponse> = null with get,set
        member val VatSpecification:ResizeArray<VatSpecificationQueryResponse> = null with get,set
        member val InvoiceDate:String = null with get,set
        member val DueDate:String = null with get,set
        member val DeliveryDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Persons:ResizeArray<Person> = null with get,set
        member val InvoiceCustomerName:String = null with get,set
        member val InvoiceAddress:EAccountingInvoiceAddress = null with get,set
        member val CustomerIsPrivatePerson:Boolean = new Boolean() with get,set
        member val TermsOfPaymentId:String = null with get,set
        member val TermsOfPaymentData:EAccountingTermsOfPaymentQueryResponse = null with get,set
        member val CustomerEmail:String = null with get,set
        member val InvoiceNumber:Int32 = new Int32() with get,set
        member val CustomerNumber:String = null with get,set
        member val Notes:ResizeArray<NoteQueryResponse> = null with get,set
        member val NoteIds:ResizeArray<String> = null with get,set
        member val CreatedUtc:DateTime = new DateTime() with get,set
        member val ModifiedUtc:DateTime = new DateTime() with get,set
        member val IncludesVat:Boolean = new Boolean() with get,set
        member val SendType:Nullable<EAccountingInvoiceSendTypes> = new Nullable<EAccountingInvoiceSendTypes>() with get,set
        member val IsSold:Boolean = new Boolean() with get,set
        member val PaymentDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val PaymentStatus:PaymentStatus = new PaymentStatus() with get,set
        member val PaymentStatusTitle:String = null with get,set
        member val CreditedBy:ResizeArray<CreditedBy> = null with get,set
        member val PriceSign:String = null with get,set
        member val BookingId:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryBase() = 
        [<DataMember(Order=1)>]
        member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=2)>]
        member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=3)>]
        member val OrderBy:String = null with get,set

        [<DataMember(Order=4)>]
        member val OrderByDesc:String = null with get,set

        [<DataMember(Order=5)>]
        member val Include:String = null with get,set

        [<DataMember(Order=6)>]
        member val Fields:String = null with get,set

        [<DataMember(Order=7)>]
        member val Meta:Dictionary<String, String> = null with get,set

    [<AllowNullLiteral>]
    type QueryData<T>() = 
        inherit QueryBase()

    [<AllowNullLiteral>]
    type EaccountingInvoiceQuery() = 
        inherit QueryData<InvoiceQueryResponse>()
        member val BookingId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Paid:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val IncludeInvoiceLines:Boolean = new Boolean() with get,set
        member val IncludeInvoiceNotes:Boolean = new Boolean() with get,set
        member val IncludePaymentTermData:Boolean = new Boolean() with get,set
        member val IncludeInvoiceAddress:Boolean = new Boolean() with get,set
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

    [<AllowNullLiteral>]
    type AccessKeyTypeResponse() = 
        member val Id:Int32 = new Int32() with get,set
        member val KeyType:String = null with get,set
        member val Description:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryResponse<T>() = 
        [<DataMember(Order=1)>]
        member val Offset:Int32 = new Int32() with get,set

        [<DataMember(Order=2)>]
        member val Total:Int32 = new Int32() with get,set

        [<DataMember(Order=3)>]
        member val Results:ResizeArray<AccessKeyTypeResponse> = null with get,set

        [<DataMember(Order=4)>]
        member val Meta:Dictionary<String, String> = null with get,set

        [<DataMember(Order=5)>]
        member val ResponseStatus:ResponseStatus = null with get,set

F# EaccountingInvoiceQuery 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/invoices HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfEAccountingDtos.InvoiceQueryResponseWg5EthtI 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.InvoiceQueryResponse>
      <d2p1:BookingId>String</d2p1:BookingId>
      <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
      <d2p1:CreatedUtc>0001-01-01T00:00:00</d2p1:CreatedUtc>
      <d2p1:CreditedBy>
        <d2p1:EAccountingClientDtos.CreditedBy>
          <d2p1:CreditInvoiceId>String</d2p1:CreditInvoiceId>
        </d2p1:EAccountingClientDtos.CreditedBy>
      </d2p1:CreditedBy>
      <d2p1:CustomerEmail>String</d2p1:CustomerEmail>
      <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:InvoiceNumber>0</d2p1:InvoiceNumber>
      <d2p1:IsSold>false</d2p1:IsSold>
      <d2p1:ModifiedUtc>0001-01-01T00:00:00</d2p1:ModifiedUtc>
      <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:PaymentDate>0001-01-01T00:00:00</d2p1:PaymentDate>
      <d2p1:PaymentStatus>Paid</d2p1:PaymentStatus>
      <d2p1:PaymentStatusTitle>String</d2p1:PaymentStatusTitle>
      <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.InvoiceLineQueryResponse>
          <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.InvoiceLineQueryResponse>
      </d2p1:Rows>
      <d2p1:SendType>None</d2p1:SendType>
      <d2p1:TermsOfPaymentData>
        <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:TermsOfPaymentData>
      <d2p1:TermsOfPaymentId>String</d2p1:TermsOfPaymentId>
      <d2p1:TotalAmount>0</d2p1:TotalAmount>
      <d2p1:TotalVatAmount>0</d2p1:TotalVatAmount>
      <d2p1:VatSpecification>
        <d2p1:EAccountingDtos.VatSpecificationQueryResponse>
          <d2p1:AmountInvoiceCurrency>0</d2p1:AmountInvoiceCurrency>
          <d2p1:VatAmountInvoiceCurrency>0</d2p1:VatAmountInvoiceCurrency>
          <d2p1:VatPercent>0</d2p1:VatPercent>
        </d2p1:EAccountingDtos.VatSpecificationQueryResponse>
      </d2p1:VatSpecification>
    </d2p1:EAccountingDtos.InvoiceQueryResponse>
  </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.InvoiceQueryResponseWg5EthtI>