BokaMera.API.Host

<back to all web services

EAccountingInvoiceDraftConvertQuery

The following routes are available for this service:
POST/eaccounting/invoicedrafts/convertConverts provided invoice draft to invoice in E-Accounting system

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 InvoiceLineQueryResponse
{
    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<InvoiceLineQueryResponse>) { (Object as any).assign(this, init); }
}

export class VatSpecificationQueryResponse
{
    public AmountInvoiceCurrency: number;
    public VatAmountInvoiceCurrency: number;
    public VatPercent: number;

    public constructor(init?: Partial<VatSpecificationQueryResponse>) { (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 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 class EAccountingTermsOfPaymentQueryResponse
{
    public Id: string;
    public Name: string;
    public NameEnglish: string;
    public NumberOfDays: number;
    public TermsOfPaymentTypeId: number;
    public TermsOfPaymentTypeText: string;
    public AvailableForSales: boolean;
    public AvailableForPurchase: boolean;

    public constructor(init?: Partial<EAccountingTermsOfPaymentQueryResponse>) { (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 enum EAccountingInvoiceSendTypes
{
    None = 'None',
    AutoInvoiceElectronic = 'AutoInvoiceElectronic',
    AutoInvoicePrint = 'AutoInvoicePrint',
    AutoInvoiceB2C = 'AutoInvoiceB2C',
}

export enum PaymentStatus
{
    Paid = 'Paid',
    Unpaid = 'Unpaid',
    Overdue = 'Overdue',
}

export class CreditedBy
{
    public CreditInvoiceId: string;

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

export class InvoiceQueryResponse
{
    public InvoiceId: string;
    public CreatedDate: string;
    public TotalAmount: number;
    public TotalVatAmount: number;
    public CustomerId: string;
    public Rows: InvoiceLineQueryResponse[];
    public VatSpecification: VatSpecificationQueryResponse[];
    public InvoiceDate: string;
    public DueDate: string;
    public DeliveryDate?: string;
    public Persons: Person[];
    public InvoiceCustomerName: string;
    public InvoiceAddress: InvoiceAddress;
    public CustomerIsPrivatePerson: boolean;
    public TermsOfPaymentId: string;
    public TermsOfPaymentData: EAccountingTermsOfPaymentQueryResponse;
    public CustomerEmail: string;
    public InvoiceNumber: number;
    public CustomerNumber: string;
    public Notes: NoteQueryResponse[];
    public NoteIds: string[];
    public CreatedUtc: string;
    public ModifiedUtc: string;
    public IncludesVat: boolean;
    public SendType?: EAccountingInvoiceSendTypes;
    public IsSold: boolean;
    public PaymentDate?: string;
    public PaymentStatus: PaymentStatus;
    public PaymentStatusTitle: string;
    public CreditedBy: CreditedBy[];
    public PriceSign: string;
    public BookingId: string;

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

export class CreateInvoiceQueryResponse
{
    public Invoice: InvoiceQueryResponse;
    public InvoiceUri: string;
    public ResponseStatus: ResponseStatus;

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

export class EAccountingInvoiceDraftConvertQuery implements ICompany
{
    public InvoiceDraftId: string;
    public BookingId: number;
    /** @description 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 SendType: EAccountingInvoiceSendTypes;

    public CompanyId?: string;

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

TypeScript EAccountingInvoiceDraftConvertQuery 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.

POST /eaccounting/invoicedrafts/convert HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EAccountingDtos.EAccountingInvoiceDraftConvertQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <BookingId>0</BookingId>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <InvoiceDraftId>String</InvoiceDraftId>
  <SendType>None</SendType>
</EAccountingDtos.EAccountingInvoiceDraftConvertQuery>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EAccountingDtos.CreateInvoiceQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Invoice>
    <BookingId>String</BookingId>
    <CreatedDate>0001-01-01T00:00:00</CreatedDate>
    <CreatedUtc>0001-01-01T00:00:00</CreatedUtc>
    <CreditedBy>
      <EAccountingClientDtos.CreditedBy>
        <CreditInvoiceId>String</CreditInvoiceId>
      </EAccountingClientDtos.CreditedBy>
    </CreditedBy>
    <CustomerEmail>String</CustomerEmail>
    <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>
    <InvoiceNumber>0</InvoiceNumber>
    <IsSold>false</IsSold>
    <ModifiedUtc>0001-01-01T00:00:00</ModifiedUtc>
    <NoteIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1: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>
    <PaymentDate>0001-01-01T00:00:00</PaymentDate>
    <PaymentStatus>Paid</PaymentStatus>
    <PaymentStatusTitle>String</PaymentStatusTitle>
    <Persons>
      <EAccountingClientDtos.Person>
        <Amount>0</Amount>
        <Ssn>String</Ssn>
      </EAccountingClientDtos.Person>
    </Persons>
    <PriceSign>String</PriceSign>
    <Rows>
      <EAccountingDtos.InvoiceLineQueryResponse>
        <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.InvoiceLineQueryResponse>
    </Rows>
    <SendType>None</SendType>
    <TermsOfPaymentData>
      <AvailableForPurchase>false</AvailableForPurchase>
      <AvailableForSales>false</AvailableForSales>
      <Id>String</Id>
      <Name>String</Name>
      <NameEnglish>String</NameEnglish>
      <NumberOfDays>0</NumberOfDays>
      <TermsOfPaymentTypeId>0</TermsOfPaymentTypeId>
      <TermsOfPaymentTypeText>String</TermsOfPaymentTypeText>
    </TermsOfPaymentData>
    <TermsOfPaymentId>String</TermsOfPaymentId>
    <TotalAmount>0</TotalAmount>
    <TotalVatAmount>0</TotalVatAmount>
    <VatSpecification>
      <EAccountingDtos.VatSpecificationQueryResponse>
        <AmountInvoiceCurrency>0</AmountInvoiceCurrency>
        <VatAmountInvoiceCurrency>0</VatAmountInvoiceCurrency>
        <VatPercent>0</VatPercent>
      </EAccountingDtos.VatSpecificationQueryResponse>
    </VatSpecification>
  </Invoice>
  <InvoiceUri>String</InvoiceUri>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</EAccountingDtos.CreateInvoiceQueryResponse>