| POST | /eaccounting/invoice |
|---|
import Foundation
import ServiceStack
public class CreateInvoice : InvoiceAddress, 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)
public var bookingId:Int
/**
* 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)
public var termsOfPaymentId:String
/**
* Note id's to add to this invoice
*/
// @ApiMember(Description="Note id's to add to this invoice")
public var notes:[String] = []
/**
* Invoice Customer name
*/
// @ApiMember(Description="Invoice Customer name")
public var invoiceCustomerName:String
/**
* Used for sending the invoice via Auto-invoice Default:None, 0 = None, 1 = AutoInvoiceElectronic, 2 = AutoInvoicePrint, 3 = AutoInvoiceB2C = ['0', '1', '2', '3'].
*/
// @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)
public var sendType:EAccountingInvoiceSendTypes?
/**
* 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)
public var rotPropertyType:RotPropertyTypes?
/**
* 0 = Normal, 1 = Rot, 2 = Rut = ['0', '1', '2']
*/
// @ApiMember(Description="0 = Normal, 1 = Rot, 2 = Rut = ['0', '1', '2']", IsRequired=true)
public var rotReducedInvoicingType:RotReducedInvoicingTypes?
/**
* 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.")
public var companyId:String?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case bookingId
case termsOfPaymentId
case notes
case invoiceCustomerName
case sendType
case rotPropertyType
case rotReducedInvoicingType
case companyId
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
bookingId = try container.decodeIfPresent(Int.self, forKey: .bookingId)
termsOfPaymentId = try container.decodeIfPresent(String.self, forKey: .termsOfPaymentId)
notes = try container.decodeIfPresent([String].self, forKey: .notes) ?? []
invoiceCustomerName = try container.decodeIfPresent(String.self, forKey: .invoiceCustomerName)
sendType = try container.decodeIfPresent(EAccountingInvoiceSendTypes.self, forKey: .sendType)
rotPropertyType = try container.decodeIfPresent(RotPropertyTypes.self, forKey: .rotPropertyType)
rotReducedInvoicingType = try container.decodeIfPresent(RotReducedInvoicingTypes.self, forKey: .rotReducedInvoicingType)
companyId = try container.decodeIfPresent(String.self, forKey: .companyId)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if bookingId != nil { try container.encode(bookingId, forKey: .bookingId) }
if termsOfPaymentId != nil { try container.encode(termsOfPaymentId, forKey: .termsOfPaymentId) }
if notes.count > 0 { try container.encode(notes, forKey: .notes) }
if invoiceCustomerName != nil { try container.encode(invoiceCustomerName, forKey: .invoiceCustomerName) }
if sendType != nil { try container.encode(sendType, forKey: .sendType) }
if rotPropertyType != nil { try container.encode(rotPropertyType, forKey: .rotPropertyType) }
if rotReducedInvoicingType != nil { try container.encode(rotReducedInvoicingType, forKey: .rotReducedInvoicingType) }
if companyId != nil { try container.encode(companyId, forKey: .companyId) }
}
}
public class InvoiceAddress : Codable
{
public var corporateIdentityNumber:String
public var invoiceAddress1:String
public var invoiceAddress2:String
public var invoiceCity:String
public var invoicePostalCode:String
public var invoiceCountryCode:String
required public init(){}
}
public enum EAccountingInvoiceSendTypes : String, Codable
{
case None
case AutoInvoiceElectronic
case AutoInvoicePrint
case AutoInvoiceB2C
}
public enum RotPropertyTypes : Int, Codable
{
case Apartment = 1
case Property = 2
}
public enum RotReducedInvoicingTypes : String, Codable
{
case Normal
case Rot
case Rut
}
public class CreateInvoiceQueryResponse : Codable
{
public var invoice:InvoiceQueryResponse
public var invoiceUri:String
public var responseStatus:ResponseStatus
required public init(){}
}
public class InvoiceQueryResponse : Codable
{
public var invoiceId:String
public var createdDate:Date
public var totalAmount:Double
public var totalVatAmount:Double
public var customerId:String
public var rows:[InvoiceLineQueryResponse] = []
public var vatSpecification:[VatSpecificationQueryResponse] = []
public var invoiceDate:String
public var dueDate:String
public var deliveryDate:Date?
public var persons:[Person] = []
public var invoiceCustomerName:String
public var invoiceAddress:InvoiceAddress
public var customerIsPrivatePerson:Bool
public var termsOfPaymentId:String
public var termsOfPaymentData:EAccountingTermsOfPaymentQueryResponse
public var customerEmail:String
public var invoiceNumber:Int
public var customerNumber:String
public var notes:[NoteQueryResponse] = []
public var noteIds:[String] = []
public var createdUtc:Date
public var modifiedUtc:Date
public var includesVat:Bool
public var sendType:EAccountingInvoiceSendTypes?
public var isSold:Bool
public var paymentDate:Date?
public var paymentStatus:PaymentStatus
public var paymentStatusTitle:String
public var creditedBy:[CreditedBy] = []
public var priceSign:String
public var bookingId:String
required public init(){}
}
public class InvoiceLineQueryResponse : Codable
{
public var articleNumber:String
public var articleId:String
public var isServiceArticle:Bool
public var amountNoVat:Double
public var percentVat:Double?
public var lineNumber:Int
public var isTextRow:Bool
public var text:String
public var unitPrice:Double
public var unitAbbreviation:String
public var unitAbbreviationEnglish:String
public var discountPercentage:Double
public var quantity:Float
public var isWorkCost:Bool
public var isVatFree:Bool
public var costCenterItemId1:String
public var costCenterItemId2:String
public var costCenterItemId3:String
public var unitId:String
public var projectId:String
public var workCostType:Int?
public var workHours:Float?
public var materialCosts:Double?
public var greenTechnologyType:GreenTechnologyType?
public var contributionMargin:ContributionMargin
required public init(){}
}
public enum GreenTechnologyType : String, Codable
{
case None
case SolarCellInstallation
case ElectricEnergyStorageInstallation
case ElectricVehicleChargingPointInstallation
}
public class ContributionMargin : Codable
{
public var amount:Int?
public var percentage:Int?
required public init(){}
}
public class VatSpecificationQueryResponse : Codable
{
public var amountInvoiceCurrency:Double
public var vatAmountInvoiceCurrency:Double
public var vatPercent:Double
required public init(){}
}
public class Person : Codable
{
public var ssn:String
public var amount:Int
required public init(){}
}
public class EAccountingTermsOfPaymentQueryResponse : Codable
{
public var id:String
public var name:String
public var nameEnglish:String
public var numberOfDays:Int
public var termsOfPaymentTypeId:Int
public var termsOfPaymentTypeText:String
public var availableForSales:Bool
public var availableForPurchase:Bool
required public init(){}
}
public class NoteQueryResponse : Codable
{
public var id:String
public var text:String
public var createdUtc:Date
public var modifiedUtc:Date
required public init(){}
}
public enum PaymentStatus : String, Codable
{
case Paid
case Unpaid
case Overdue
}
public class CreditedBy : Codable
{
public var creditInvoiceId:String
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: api.bokamera.se
Accept: text/jsonl
Content-Type: text/jsonl
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/jsonl
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"}}}