BokaMera.API.Host

<back to all web services

CreateInvoiceDraft

The following routes are available for this service:
POST/eaccounting/invoicedraft
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class CreateInvoiceDraft : InvoiceAddressResponse(), ICompany
{
    /**
    * The booking id, to be used to create the customer.
    */
    @ApiMember(Description="The booking id, to be used to create the customer.", IsRequired=true)
    open var BookingId:Int? = null

    /**
    * The Term of payment Id, to be used to create the invoice.
    */
    @ApiMember(Description="The Term of payment Id, to be used to create the invoice.", IsRequired=true)
    open var TermsOfPaymentId:UUID? = null

    /**
    * Note id's to add to this invoice
    */
    @ApiMember(Description="Note id's to add to this invoice")
    open var Notes:ArrayList<String>? = null

    /**
    * Invoice Customer name
    */
    @ApiMember(Description="Invoice Customer name")
    open var InvoiceCustomerName:String? = null

    /**
    * 1 = Apartment, 2 = Property Leave blank or set to null if you do not intend to use ROT or Green Technology functionality.
    */
    @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)
    open var RotPropertyType:RotPropertyTypes? = null

    /**
    * 0 = Normal, 1 = Rot, 2 = Rut = ['0', '1', '2']
    */
    @ApiMember(Description="0 = Normal, 1 = Rot, 2 = Rut = ['0', '1', '2']", IsRequired=true)
    open var RotReducedInvoicingType:RotReducedInvoicingTypes? = null

    /**
    * The company id, if empty will use the company id for the user you are logged in with.
    */
    @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    override var CompanyId:UUID? = null
}

open class InvoiceAddressResponse
{
    open var InvoiceAddressId:UUID? = null
    open var UserId:UUID? = null
    open var CorporateIdentityNumber:String? = null
    open var InvoiceAddress1:String? = null
    open var InvoiceAddress2:String? = null
    open var InvoiceCity:String? = null
    open var InvoicePostalCode:String? = null
    open var InvoiceCountryCode:String? = null
}

enum class RotPropertyTypes(val value:Int)
{
    Apartment(1),
    Property(2),
}

enum class RotReducedInvoicingTypes
{
    Normal,
    Rot,
    Rut,
}

open class CreateInvoiceDraftQueryResponse
{
    open var Invoice:InvoiceDraftQueryResponse? = null
    open var InvoiceUri:String? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class InvoiceDraftQueryResponse
{
    open var InvoiceId:UUID? = null
    open var CreatedDate:Date? = null
    open var TotalAmount:BigDecimal? = null
    open var TotalVatAmount:BigDecimal? = null
    open var CustomerId:String? = null
    open var Rows:ArrayList<InvoiceDraftLineQueryResponse>? = null
    open var InvoiceDate:String? = null
    open var DueDate:String? = null
    open var DeliveryDate:Date? = null
    open var Persons:ArrayList<Person>? = null
    open var InvoiceCustomerName:String? = null
    open var InvoiceAddress:EAccountingInvoiceAddress? = null
    open var CustomerIsPrivatePerson:Boolean? = null
    open var CustomerNumber:String? = null
    open var Notes:ArrayList<NoteQueryResponse>? = null
    open var NoteIds:ArrayList<String>? = null
    open var CreatedUtc:Date? = null
    open var IncludesVat:Boolean? = null
    open var PriceSign:String? = null
    open var BookingId:String? = null
}

open class InvoiceDraftLineQueryResponse
{
    open var ArticleNumber:String? = null
    open var ArticleId:String? = null
    open var IsServiceArticle:Boolean? = null
    open var AmountNoVat:BigDecimal? = null
    open var PercentVat:BigDecimal? = null
    open var LineNumber:Int? = null
    open var IsTextRow:Boolean? = null
    open var Text:String? = null
    open var UnitPrice:BigDecimal? = null
    open var UnitAbbreviation:String? = null
    open var UnitAbbreviationEnglish:String? = null
    open var DiscountPercentage:BigDecimal? = null
    open var Quantity:Double? = null
    open var IsWorkCost:Boolean? = null
    open var IsVatFree:Boolean? = null
    open var CostCenterItemId1:String? = null
    open var CostCenterItemId2:String? = null
    open var CostCenterItemId3:String? = null
    open var UnitId:String? = null
    open var ProjectId:String? = null
    open var WorkCostType:Int? = null
    open var WorkHours:Double? = null
    open var MaterialCosts:BigDecimal? = null
    open var GreenTechnologyType:GreenTechnologyType? = null
    open var ContributionMargin:ContributionMargin? = null
}

enum class GreenTechnologyType
{
    None,
    SolarCellInstallation,
    ElectricEnergyStorageInstallation,
    ElectricVehicleChargingPointInstallation,
}

open class ContributionMargin
{
    open var Amount:Int? = null
    open var Percentage:Int? = null
}

open class Person
{
    open var Ssn:String? = null
    open var Amount:Int? = null
}

open class EAccountingInvoiceAddress
{
    open var CorporateIdentityNumber:String? = null
    open var InvoiceAddress1:String? = null
    open var InvoiceAddress2:String? = null
    open var InvoiceCity:String? = null
    open var InvoicePostalCode:String? = null
    open var InvoiceCountryCode:String? = null
}

open class NoteQueryResponse
{
    open var Id:String? = null
    open var Text:String? = null
    open var CreatedUtc:Date? = null
    open var ModifiedUtc:Date? = null
}

Kotlin CreateInvoiceDraft DTOs

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

HTTP + JSV

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.bookmore.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	BookingId: 0,
	Notes: 
	[
		String
	],
	InvoiceCustomerName: String,
	RotPropertyType: 0,
	RotReducedInvoicingType: Normal,
	CompanyId: 00000000-0000-0000-0000-000000000000,
	UserId: 00000000-0000-0000-0000-000000000000,
	CorporateIdentityNumber: String,
	InvoiceAddress1: String,
	InvoiceAddress2: String,
	InvoiceCity: String,
	InvoicePostalCode: String,
	InvoiceCountryCode: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}