BokaMera.API.Host

<back to all web services

EAccountingInvoiceDraftQuery

The following routes are available for this service:
GET/eaccounting/invoicedrafts
"use strict";
export class EAccountingPagination {
    /** @param {{PageNumber?:number,PageSize?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?number}
     * @description Page number that will be fetched to e-accounting client; Default 1 */
    PageNumber;
    /**
     * @type {?number}
     * @description Page size that will be fetched to e-accounting client; Default 75~ */
    PageSize;
}
/** @typedef {'None'|'SolarCellInstallation'|'ElectricEnergyStorageInstallation'|'ElectricVehicleChargingPointInstallation'} */
export var GreenTechnologyType;
(function (GreenTechnologyType) {
    GreenTechnologyType["None"] = "None"
    GreenTechnologyType["SolarCellInstallation"] = "SolarCellInstallation"
    GreenTechnologyType["ElectricEnergyStorageInstallation"] = "ElectricEnergyStorageInstallation"
    GreenTechnologyType["ElectricVehicleChargingPointInstallation"] = "ElectricVehicleChargingPointInstallation"
})(GreenTechnologyType || (GreenTechnologyType = {}));
export class ContributionMargin {
    /** @param {{Amount?:number,Percentage?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    Amount;
    /** @type {?number} */
    Percentage;
}
export class InvoiceDraftLineQueryResponse {
    /** @param {{ArticleNumber?:string,ArticleId?:string,IsServiceArticle?:boolean,AmountNoVat?:number,PercentVat?:number,LineNumber?:number,IsTextRow?:boolean,Text?:string,UnitPrice?:number,UnitAbbreviation?:string,UnitAbbreviationEnglish?:string,DiscountPercentage?:number,Quantity?:number,IsWorkCost?:boolean,IsVatFree?:boolean,CostCenterItemId1?:string,CostCenterItemId2?:string,CostCenterItemId3?:string,UnitId?:string,ProjectId?:string,WorkCostType?:number,WorkHours?:number,MaterialCosts?:number,GreenTechnologyType?:GreenTechnologyType,ContributionMargin?:ContributionMargin}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ArticleNumber;
    /** @type {string} */
    ArticleId;
    /** @type {?boolean} */
    IsServiceArticle;
    /** @type {number} */
    AmountNoVat;
    /** @type {number} */
    PercentVat;
    /** @type {?number} */
    LineNumber;
    /** @type {boolean} */
    IsTextRow;
    /** @type {string} */
    Text;
    /** @type {?number} */
    UnitPrice;
    /** @type {string} */
    UnitAbbreviation;
    /** @type {string} */
    UnitAbbreviationEnglish;
    /** @type {?number} */
    DiscountPercentage;
    /** @type {?number} */
    Quantity;
    /** @type {boolean} */
    IsWorkCost;
    /** @type {boolean} */
    IsVatFree;
    /** @type {string} */
    CostCenterItemId1;
    /** @type {string} */
    CostCenterItemId2;
    /** @type {string} */
    CostCenterItemId3;
    /** @type {string} */
    UnitId;
    /** @type {string} */
    ProjectId;
    /** @type {?number} */
    WorkCostType;
    /** @type {?number} */
    WorkHours;
    /** @type {?number} */
    MaterialCosts;
    /** @type {?GreenTechnologyType} */
    GreenTechnologyType;
    /** @type {ContributionMargin} */
    ContributionMargin;
}
export class Person {
    /** @param {{Ssn?:string,Amount?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Ssn;
    /** @type {number} */
    Amount;
}
export class InvoiceAddress {
    /** @param {{CorporateIdentityNumber?:string,InvoiceAddress1?:string,InvoiceAddress2?:string,InvoiceCity?:string,InvoicePostalCode?:string,InvoiceCountryCode?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CorporateIdentityNumber;
    /** @type {string} */
    InvoiceAddress1;
    /** @type {string} */
    InvoiceAddress2;
    /** @type {string} */
    InvoiceCity;
    /** @type {string} */
    InvoicePostalCode;
    /** @type {string} */
    InvoiceCountryCode;
}
export class NoteQueryResponse {
    /** @param {{Id?:string,Text?:string,CreatedUtc?:string,ModifiedUtc?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    Text;
    /** @type {string} */
    CreatedUtc;
    /** @type {string} */
    ModifiedUtc;
}
export class InvoiceDraftQueryResponse {
    /** @param {{InvoiceId?:string,CreatedDate?:string,TotalAmount?:number,TotalVatAmount?:number,CustomerId?:string,Rows?:InvoiceDraftLineQueryResponse[],InvoiceDate?:string,DueDate?:string,DeliveryDate?:string,Persons?:Person[],InvoiceCustomerName?:string,InvoiceAddress?:InvoiceAddress,CustomerIsPrivatePerson?:boolean,CustomerNumber?:string,Notes?:NoteQueryResponse[],NoteIds?:string[],CreatedUtc?:string,IncludesVat?:boolean,PriceSign?:string,BookingId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    InvoiceId;
    /** @type {?string} */
    CreatedDate;
    /** @type {?number} */
    TotalAmount;
    /** @type {?number} */
    TotalVatAmount;
    /** @type {string} */
    CustomerId;
    /** @type {InvoiceDraftLineQueryResponse[]} */
    Rows;
    /** @type {string} */
    InvoiceDate;
    /** @type {string} */
    DueDate;
    /** @type {?string} */
    DeliveryDate;
    /** @type {Person[]} */
    Persons;
    /** @type {string} */
    InvoiceCustomerName;
    /** @type {InvoiceAddress} */
    InvoiceAddress;
    /** @type {boolean} */
    CustomerIsPrivatePerson;
    /** @type {string} */
    CustomerNumber;
    /** @type {NoteQueryResponse[]} */
    Notes;
    /** @type {string[]} */
    NoteIds;
    /** @type {string} */
    CreatedUtc;
    /** @type {boolean} */
    IncludesVat;
    /** @type {string} */
    PriceSign;
    /** @type {string} */
    BookingId;
}
export class EAccountingInvoiceDraftQuery extends EAccountingPagination {
    /** @param {{BookingId?:number,IncludeInvoiceLines?:boolean,IncludeInvoiceNotes?:boolean,CompanyId?:string,PageNumber?:number,PageSize?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    BookingId;
    /** @type {boolean} */
    IncludeInvoiceLines;
    /** @type {boolean} */
    IncludeInvoiceNotes;
    /** @type {?string} */
    CompanyId;
}

JavaScript EAccountingInvoiceDraftQuery DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /eaccounting/invoicedrafts HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EAccountingDtos.InvoiceDraftQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <BookingId>String</BookingId>
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <CreatedUtc>0001-01-01T00:00:00</CreatedUtc>
  <CustomerId>String</CustomerId>
  <CustomerIsPrivatePerson>false</CustomerIsPrivatePerson>
  <CustomerNumber>String</CustomerNumber>
  <DeliveryDate>0001-01-01T00:00:00</DeliveryDate>
  <DueDate>String</DueDate>
  <IncludesVat>false</IncludesVat>
  <InvoiceAddress>
    <CorporateIdentityNumber>String</CorporateIdentityNumber>
    <InvoiceAddress1>String</InvoiceAddress1>
    <InvoiceAddress2>String</InvoiceAddress2>
    <InvoiceCity>String</InvoiceCity>
    <InvoiceCountryCode>String</InvoiceCountryCode>
    <InvoicePostalCode>String</InvoicePostalCode>
  </InvoiceAddress>
  <InvoiceCustomerName>String</InvoiceCustomerName>
  <InvoiceDate>String</InvoiceDate>
  <InvoiceId>00000000-0000-0000-0000-000000000000</InvoiceId>
  <NoteIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </NoteIds>
  <Notes>
    <EAccountingDtos.NoteQueryResponse>
      <CreatedUtc>0001-01-01T00:00:00</CreatedUtc>
      <Id>String</Id>
      <ModifiedUtc>0001-01-01T00:00:00</ModifiedUtc>
      <Text>String</Text>
    </EAccountingDtos.NoteQueryResponse>
  </Notes>
  <Persons>
    <EAccountingClientDtos.Person>
      <Amount>0</Amount>
      <Ssn>String</Ssn>
    </EAccountingClientDtos.Person>
  </Persons>
  <PriceSign>String</PriceSign>
  <Rows>
    <EAccountingDtos.InvoiceDraftLineQueryResponse>
      <AmountNoVat>0</AmountNoVat>
      <ArticleId>String</ArticleId>
      <ArticleNumber>String</ArticleNumber>
      <ContributionMargin>
        <Amount>0</Amount>
        <Percentage>0</Percentage>
      </ContributionMargin>
      <CostCenterItemId1>String</CostCenterItemId1>
      <CostCenterItemId2>String</CostCenterItemId2>
      <CostCenterItemId3>String</CostCenterItemId3>
      <DiscountPercentage>0</DiscountPercentage>
      <GreenTechnologyType>None</GreenTechnologyType>
      <IsServiceArticle>false</IsServiceArticle>
      <IsTextRow>false</IsTextRow>
      <IsVatFree>false</IsVatFree>
      <IsWorkCost>false</IsWorkCost>
      <LineNumber>0</LineNumber>
      <MaterialCosts>0</MaterialCosts>
      <PercentVat>0</PercentVat>
      <ProjectId>String</ProjectId>
      <Quantity>0</Quantity>
      <Text>String</Text>
      <UnitAbbreviation>String</UnitAbbreviation>
      <UnitAbbreviationEnglish>String</UnitAbbreviationEnglish>
      <UnitId>String</UnitId>
      <UnitPrice>0</UnitPrice>
      <WorkCostType>0</WorkCostType>
      <WorkHours>0</WorkHours>
    </EAccountingDtos.InvoiceDraftLineQueryResponse>
  </Rows>
  <TotalAmount>0</TotalAmount>
  <TotalVatAmount>0</TotalVatAmount>
</EAccountingDtos.InvoiceDraftQueryResponse>