BokaMera.API.Host

<back to all web services

CreateInvoiceDraft

The following routes are available for this service:
POST/eaccounting/invoicedraft
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 InvoiceDraftLineQueryResponse() = 
        member val ArticleNumber:String = null with get,set
        member val ArticleId:String = null with get,set
        member val IsServiceArticle:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val AmountNoVat:Decimal = new Decimal() with get,set
        member val PercentVat:Decimal = new Decimal() with get,set
        member val LineNumber:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val IsTextRow:Boolean = new Boolean() with get,set
        member val Text:String = null with get,set
        member val UnitPrice:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val UnitAbbreviation:String = null with get,set
        member val UnitAbbreviationEnglish:String = null with get,set
        member val DiscountPercentage:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Quantity:Nullable<Double> = new Nullable<Double>() 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<Double> = new Nullable<Double>() 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 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 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

    [<AllowNullLiteral>]
    type InvoiceDraftQueryResponse() = 
        member val InvoiceId:Guid = new Guid() with get,set
        member val CreatedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val TotalAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val TotalVatAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val CustomerId:String = null with get,set
        member val Rows:ResizeArray<InvoiceDraftLineQueryResponse> = new ResizeArray<InvoiceDraftLineQueryResponse>() 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 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 IncludesVat:Boolean = new Boolean() with get,set
        member val PriceSign:String = null with get,set
        member val BookingId:String = null with get,set

    [<AllowNullLiteral>]
    type CreateInvoiceDraftQueryResponse() = 
        member val Invoice:InvoiceDraftQueryResponse = null with get,set
        member val InvoiceUri:String = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    type RotPropertyTypes =
        | Apartment = 1
        | Property = 2

    type RotReducedInvoicingTypes =
        | Normal = 0
        | Rot = 1
        | Rut = 2

    [<AllowNullLiteral>]
    type CreateInvoiceDraft() = 
        inherit InvoiceAddress()
        ///<summary>
        ///The booking id, to be used to create the customer.
        ///</summary>
        [<ApiMember(Description="The booking id, to be used to create the customer.", IsRequired=true)>]
        member val BookingId:Int32 = new Int32() with get,set

        ///<summary>
        ///The Term of payment Id, to be used to create the invoice.
        ///</summary>
        [<ApiMember(Description="The Term of payment Id, to be used to create the invoice.", IsRequired=true)>]
        member val TermsOfPaymentId:Guid = new Guid() with get,set

        ///<summary>
        ///Note id's to add to this invoice
        ///</summary>
        [<ApiMember(Description="Note id's to add to this invoice")>]
        member val Notes:ResizeArray<String> = new ResizeArray<String>() with get,set

        ///<summary>
        ///Invoice Customer name
        ///</summary>
        [<ApiMember(Description="Invoice Customer name")>]
        member val InvoiceCustomerName:String = null with get,set

        ///<summary>
        ///1 = Apartment, 2 = Property Leave blank or set to null if you do not intend to use ROT or Green Technology functionality.
        ///</summary>
        [<ApiMember(Description="1 = Apartment, 2 = Property Leave blank or set to null if you do not intend to use ROT or Green Technology functionality.", IsRequired=true)>]
        member val RotPropertyType:Nullable<RotPropertyTypes> = new Nullable<RotPropertyTypes>() with get,set

        ///<summary>
        ///0 = Normal, 1 = Rot, 2 = Rut = ['0', '1', '2']
        ///</summary>
        [<ApiMember(Description="0 = Normal, 1 = Rot, 2 = Rut = ['0', '1', '2']", IsRequired=true)>]
        member val RotReducedInvoicingType:Nullable<RotReducedInvoicingTypes> = new Nullable<RotReducedInvoicingTypes>() with get,set

        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [<ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

F# CreateInvoiceDraft 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.

POST /eaccounting/invoicedraft HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"BookingId":0,"Notes":["String"],"InvoiceCustomerName":"String","RotPropertyType":"0","RotReducedInvoicingType":"Normal","CompanyId":"00000000-0000-0000-0000-000000000000","CorporateIdentityNumber":"String","InvoiceAddress1":"String","InvoiceAddress2":"String","InvoiceCity":"String","InvoicePostalCode":"String","InvoiceCountryCode":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Invoice":{"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"},"InvoiceUri":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}