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.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 InvoiceAddress() = 
        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> = new ResizeArray<InvoiceLineQueryResponse>() with get,set
        member val VatSpecification:ResizeArray<VatSpecificationQueryResponse> = new ResizeArray<VatSpecificationQueryResponse>() 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> = new ResizeArray<Person>() with get,set
        member val InvoiceCustomerName:String = null with get,set
        member val InvoiceAddress:InvoiceAddress = 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> = new ResizeArray<NoteQueryResponse>() with get,set
        member val NoteIds:ResizeArray<String> = new ResizeArray<String>() 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> = new ResizeArray<CreditedBy>() with get,set
        member val PriceSign:String = null with get,set
        member val BookingId:String = null with get,set

    [<AllowNullLiteral>]
    type EAccountingPagination() = 
        ///<summary>
        ///Page number that will be fetched to e-accounting client; Default 1
        ///</summary>
        [<DataMember(Order=1)>]
        [<ApiMember(Description="Page number that will be fetched to e-accounting client; Default 1")>]
        member val PageNumber:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///Page size that will be fetched to e-accounting client; Default 75~
        ///</summary>
        [<DataMember(Order=2)>]
        [<ApiMember(Description="Page size that will be fetched to e-accounting client; Default 75~")>]
        member val PageSize:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type EaccountingInvoiceQuery() = 
        inherit EAccountingPagination()
        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

F# EaccountingInvoiceQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}