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
EAccountingInvoiceDraftConvertQuery Parameters:
NameParameterData TypeRequiredDescription
InvoiceDraftIdbodystringNo
BookingIdbodyintNo
SendTypebodyEAccountingInvoiceSendTypes?YesUsed for sending the invoice via Auto-invoice Default:None, 0 = None, 1 = AutoInvoiceElectronic, 2 = AutoInvoicePrint, 3 = AutoInvoiceB2C = ['0', '1', '2', '3'].
CompanyIdbodyGuid?No
EAccountingInvoiceSendTypes Enum:
None
AutoInvoiceElectronic
AutoInvoicePrint
AutoInvoiceB2C
CreateInvoiceQueryResponse Parameters:
NameParameterData TypeRequiredDescription
InvoiceformInvoiceQueryResponseNo
InvoiceUriformstringNo
ResponseStatusformResponseStatusNo
InvoiceQueryResponse Parameters:
NameParameterData TypeRequiredDescription
InvoiceIdformGuidNo
CreatedDateformDateTimeNo
TotalAmountformdecimalNo
TotalVatAmountformdecimalNo
CustomerIdformstringNo
RowsformList<InvoiceLineQueryResponse>No
VatSpecificationformList<VatSpecificationQueryResponse>No
InvoiceDateformstringNo
DueDateformstringNo
DeliveryDateformDateTime?No
PersonsformList<Person>No
InvoiceCustomerNameformstringNo
InvoiceAddressformInvoiceAddressNo
CustomerIsPrivatePersonformboolNo
TermsOfPaymentIdformstringNo
TermsOfPaymentDataformEAccountingTermsOfPaymentQueryResponseNo
CustomerEmailformstringNo
InvoiceNumberformintNo
CustomerNumberformstringNo
NotesformList<NoteQueryResponse>No
NoteIdsformList<string>No
CreatedUtcformDateTimeNo
ModifiedUtcformDateTimeNo
IncludesVatformboolNo
SendTypeformEAccountingInvoiceSendTypes?No
IsSoldformboolNo
PaymentDateformDateTime?No
PaymentStatusformPaymentStatusNo
PaymentStatusTitleformstringNo
CreditedByformList<CreditedBy>No
PriceSignformstringNo
BookingIdformstringNo
InvoiceLineQueryResponse Parameters:
NameParameterData TypeRequiredDescription
ArticleNumberformstringNo
ArticleIdformstringNo
IsServiceArticleformboolNo
AmountNoVatformdecimalNo
PercentVatformdecimal?No
LineNumberformintNo
IsTextRowformboolNo
TextformstringNo
UnitPriceformdecimalNo
UnitAbbreviationformstringNo
UnitAbbreviationEnglishformstringNo
DiscountPercentageformdecimalNo
QuantityformfloatNo
IsWorkCostformboolNo
IsVatFreeformboolNo
CostCenterItemId1formstringNo
CostCenterItemId2formstringNo
CostCenterItemId3formstringNo
UnitIdformstringNo
ProjectIdformstringNo
WorkCostTypeformint?No
WorkHoursformfloat?No
MaterialCostsformdecimal?No
GreenTechnologyTypeformGreenTechnologyType?No
ContributionMarginformContributionMarginNo
GreenTechnologyType Enum:
None
SolarCellInstallation
ElectricEnergyStorageInstallation
ElectricVehicleChargingPointInstallation
ContributionMargin Parameters:
NameParameterData TypeRequiredDescription
Amountformint?No
Percentageformint?No
VatSpecificationQueryResponse Parameters:
NameParameterData TypeRequiredDescription
AmountInvoiceCurrencyformdecimalNo
VatAmountInvoiceCurrencyformdecimalNo
VatPercentformdecimalNo
Person Parameters:
NameParameterData TypeRequiredDescription
SsnformstringNo
AmountformintNo
InvoiceAddress Parameters:
NameParameterData TypeRequiredDescription
CorporateIdentityNumberformstringNo
InvoiceAddress1formstringNo
InvoiceAddress2formstringNo
InvoiceCityformstringNo
InvoicePostalCodeformstringNo
InvoiceCountryCodeformstringNo
EAccountingTermsOfPaymentQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
NameEnglishformstringNo
NumberOfDaysformintNo
TermsOfPaymentTypeIdformintNo
TermsOfPaymentTypeTextformstringNo
AvailableForSalesformboolNo
AvailableForPurchaseformboolNo
NoteQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
TextformstringNo
CreatedUtcformDateTimeNo
ModifiedUtcformDateTimeNo
PaymentStatus Enum:
Paid
Unpaid
Overdue
CreditedBy Parameters:
NameParameterData TypeRequiredDescription
CreditInvoiceIdformstringNo

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: testapi.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>