BokaMera.API.Host

<back to all web services

CreateInvoiceDraft

The following routes are available for this service:
POST/eaccounting/invoicedraft

export class InvoiceAddress
{
    public CorporateIdentityNumber: string;
    public InvoiceAddress1: string;
    public InvoiceAddress2: string;
    public InvoiceCity: string;
    public InvoicePostalCode: string;
    public InvoiceCountryCode: string;

    public constructor(init?: Partial<InvoiceAddress>) { (Object as any).assign(this, init); }
}

export enum GreenTechnologyType
{
    None = 'None',
    SolarCellInstallation = 'SolarCellInstallation',
    ElectricEnergyStorageInstallation = 'ElectricEnergyStorageInstallation',
    ElectricVehicleChargingPointInstallation = 'ElectricVehicleChargingPointInstallation',
}

export class ContributionMargin
{
    public Amount?: number;
    public Percentage?: number;

    public constructor(init?: Partial<ContributionMargin>) { (Object as any).assign(this, init); }
}

export class InvoiceDraftLineQueryResponse
{
    public ArticleNumber: string;
    public ArticleId: string;
    public IsServiceArticle?: boolean;
    public AmountNoVat: number;
    public PercentVat: number;
    public LineNumber?: number;
    public IsTextRow: boolean;
    public Text: string;
    public UnitPrice?: number;
    public UnitAbbreviation: string;
    public UnitAbbreviationEnglish: string;
    public DiscountPercentage?: number;
    public Quantity?: number;
    public IsWorkCost: boolean;
    public IsVatFree: boolean;
    public CostCenterItemId1: string;
    public CostCenterItemId2: string;
    public CostCenterItemId3: string;
    public UnitId: string;
    public ProjectId: string;
    public WorkCostType?: number;
    public WorkHours?: number;
    public MaterialCosts?: number;
    public GreenTechnologyType?: GreenTechnologyType;
    public ContributionMargin: ContributionMargin;

    public constructor(init?: Partial<InvoiceDraftLineQueryResponse>) { (Object as any).assign(this, init); }
}

export class Person
{
    public Ssn: string;
    public Amount: number;

    public constructor(init?: Partial<Person>) { (Object as any).assign(this, init); }
}

export class NoteQueryResponse
{
    public Id: string;
    public Text: string;
    public CreatedUtc: string;
    public ModifiedUtc: string;

    public constructor(init?: Partial<NoteQueryResponse>) { (Object as any).assign(this, init); }
}

export class InvoiceDraftQueryResponse
{
    public InvoiceId: string;
    public CreatedDate?: string;
    public TotalAmount?: number;
    public TotalVatAmount?: number;
    public CustomerId: string;
    public Rows: InvoiceDraftLineQueryResponse[];
    public InvoiceDate: string;
    public DueDate: string;
    public DeliveryDate?: string;
    public Persons: Person[];
    public InvoiceCustomerName: string;
    public InvoiceAddress: InvoiceAddress;
    public CustomerIsPrivatePerson: boolean;
    public CustomerNumber: string;
    public Notes: NoteQueryResponse[];
    public NoteIds: string[];
    public CreatedUtc: string;
    public IncludesVat: boolean;
    public PriceSign: string;
    public BookingId: string;

    public constructor(init?: Partial<InvoiceDraftQueryResponse>) { (Object as any).assign(this, init); }
}

export class CreateInvoiceDraftQueryResponse
{
    public Invoice: InvoiceDraftQueryResponse;
    public InvoiceUri: string;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<CreateInvoiceDraftQueryResponse>) { (Object as any).assign(this, init); }
}

export enum RotPropertyTypes
{
    Apartment = 1,
    Property = 2,
}

export enum RotReducedInvoicingTypes
{
    Normal = 'Normal',
    Rot = 'Rot',
    Rut = 'Rut',
}

export class CreateInvoiceDraft extends InvoiceAddress implements ICompany
{
    /** @description 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 BookingId: number;

    /** @description 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 TermsOfPaymentId: string;

    /** @description Note id's to add to this invoice */
    // @ApiMember(Description="Note id's to add to this invoice")
    public Notes: string[];

    /** @description Invoice Customer name */
    // @ApiMember(Description="Invoice Customer name")
    public InvoiceCustomerName: string;

    /** @description 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 RotPropertyType: RotPropertyTypes;

    /** @description 0 = Normal, 1 = Rot, 2 = Rut = ['0', '1', '2'] */
    // @ApiMember(Description="0 = Normal, 1 = Rot, 2 = Rut = ['0', '1', '2']", IsRequired=true)
    public RotReducedInvoicingType: RotReducedInvoicingTypes;

    /** @description 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 CompanyId?: string;

    public constructor(init?: Partial<CreateInvoiceDraft>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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"}}}