| POST | /eaccounting/invoice |
|---|
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 CreateInvoiceQueryResponse() =
member val Invoice:InvoiceQueryResponse = 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 CreateInvoice() =
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>
///Used for sending the invoice via Auto-invoice Default:None, 0 = None, 1 = AutoInvoiceElectronic, 2 = AutoInvoicePrint, 3 = AutoInvoiceB2C = ['0', '1', '2', '3'].
///</summary>
[<ApiMember(Description="Used for sending the invoice via Auto-invoice Default:None, 0 = None, 1 = AutoInvoiceElectronic, 2 = AutoInvoicePrint, 3 = AutoInvoiceB2C = ['0', '1', '2', '3'].", IsRequired=true)>]
member val SendType:Nullable<EAccountingInvoiceSendTypes> = new Nullable<EAccountingInvoiceSendTypes>() 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
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /eaccounting/invoice HTTP/1.1
Host: testapi.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
BookingId: 0,
Notes:
[
String
],
InvoiceCustomerName: String,
SendType: None,
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: text/jsv
Content-Length: length
{
Invoice:
{
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
},
InvoiceUri: String,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}