📦 Contents

⚙️ Installation

npm install @elbstack/lexoffice-client-js

yarn add @elbstack/lexoffice-client-js

📚 Documentation

🔑 Usage

import{Client}from'@elbstack/lexoffice-client-js';constclient=newClient(YOUR_LEXOFFICE_API_KEY);

💡 Examples

Retrieve an invoice

constinvoiceResult=awaitclient.retrieveInvoice('caf4e0c3-c3e8-4a06-bcfe-346bc7190b2');if(invoiceResult.ok){constinvoice=invoiceResult.val;}else{console.error('An error occured');}

Create an invoice

constinvoice={voucherDate:'2017-02-22T00:00:00.000+01:00',address:{name:'Bike & Ride GmbH & Co. KG',supplement:'Gebäude 10',street:'Musterstraße 42',city:'Freiburg',zip:'79112',countryCode:'DE',},lineItems:[{type:'custom',name:'Energieriegel Testpaket',quantity:1,unitName:'Stück',unitPrice:{currency:'EUR',netAmount:5,taxRatePercentage:0,},discountPercentage:0,},{type:'text',name:'Strukturieren Sie Ihre Belege durch Text-Elemente.',description:'Das hilft beim Verständnis',},],totalPrice:{currency:'EUR',},taxConditions:{taxType:'net',},shippingConditions:{shippingDate:'2017-04-22T00:00:00.000+02:00',shippingType:'delivery',},title:'Rechnung',introduction:'Ihre bestellten Positionen stellen wir Ihnen hiermit in Rechnung',remark:'Vielen Dank für Ihren Einkauf',};constcreatedInvoiceResult=awaitclient.createInvoice(invoice,{finalize:true});if(createdInvoiceResult.ok){constinvoice=createdInvoiceResult.val;}else{console.error('An error occured');}

Upload File

letfs=require('fs');letFormData=require('form-data');letdata=newFormData();data.append('file',fs.createReadStream(__dirname+'/yourFolder/yourFile'));data.append('type','voucher');constuploadedFileResult=awaitclient.uploadFile(data);if(uploadedFileResult.ok){constinvoice=uploadedFileResult.val;}else{console.error('An error occured');}

❌ Error handling

if(YOUR_RESULT.ok){constYOUR_VARIABLE=YOUR_RESULT.val;// Work with your result}else{// Your request returned an errorconsterror=YOUR_RESULT.val;console.log('error:',error);// Further error checking is possible byif(errorinstanceofRequestError){console.log('Hello instance of RequestError!');if(errorinstanceofRequestNotFoundError){console.log('Wow, it looks like you have many instances!');}if(errorinstanceofRequestMethodNotAcceptableLegacyError){console.log('Seems, that you take care of your legacy!');}}}

Error codes and types

🛠 Provided methods grouped by endpoint

Contact

createContact(contact:ContactCreatePerson|ContactCreateCompany):Promise<Result<ContactCreateResponse,RequestError>>retrieveContact(id:string):Promise<Result<ContactRetrieveResponse,RequestError>>updateContact(id:string,contact:ContactUpdatePerson|ContactUpdateCompany):Promise<Result<ContactUpdateResponse,RequestError>>filterContact(filter?:OptionalFilters&Partial<PagingParameters>):Promise<Result<ContactFilterRetrieveResponse,RequestError>>

Country

retrieveListOfCountries():Promise<Result<Country[],RequestError>>

Credit note

createCreditNote(creditNote:CreditNoteCreate,optionalFinalized?:OptionalFinalized):Promise<Result<CreditNoteCreateResponse,RequestError>>retrieveCreditNote(id:string):Promise<Result<CreditNoteRetrieveResponse,RequestError>>renderCreditNoteDocumentFileId(id:string):Promise<Result<DocumentFileId,RequestError>>

Down payment invoice

retrieveDownPaymentInvoice(id:string):Promise<Result<DownPaymentInvoice,RequestError>>

Event subscription

createEventSubscription(eventSubscription:EventSubscriptionCreate):Promise<Result<EventSubscription,RequestError>>retrieveEventSubscription(id:string):Promise<Result<EventSubscription,RequestError>>retrieveAllEventSubscriptions():Promise<Result<EventSubscriptions,RequestError>>deleteEventSubscription(id:string):Promise<Result<unknown,RequestError>>

File

uploadFile(data:FormData):Promise<Result<FileResponse,RequestError>>downloadFile(documentFileId: string,optionalParameter?:RenderType):Promise<Result<unknown,RequestError>>

Invoice

createInvoice(invoice:InvoiceCreate|XRechnung,optionalFinalized?:OptionalFinalized):Promise<Result<InvoiceCreateResponse,RequestError>>retrieveInvoice(id:string):Promise<Result<InvoiceRetrieveResponse,RequestError>>renderInvoiceDocumentFileId(id:string):Promise<Result<DocumentFileId,RequestError>>

Order confirmation

createOrderConfirmation(orderConfirmation:OrderConfirmation):Promise<Result<OrderConfirmationResponse,RequestError>>retrieveOrderConfirmation(id:string):Promise<Result<OrderConfirmationRetrieveResponse,RequestError>>renderOrderConfirmationDocumentFileId(id:string):Promise<Result<DocumentFileId,RequestError>>

Payment

retrievePayment(id:string):Promise<Result<Payment,RequestError>>

Payment condition

retrievePaymentConditionList():Promise<Result<PaymentCondition,RequestError>>

Posting category

retrieveListPostingCategories():Promise<Result<PostingCategory[],RequestError>>

Profile

retrieveProfile():Promise<Result<Profile,RequestError>>

Quotation

createQuotation(quotation:QuotationCreate,optionalFilter?:OptionalFinalized):Promise<Result<QuotationCreate,RequestError>>retrieveQuotation(id:string):Promise<Result<Partial<Quotation>,RequestError>>renderQuotationDocumentFileId(id:string):Promise<Result<DocumentFileId,RequestError>>

Recurring template

retrieveRecurringTemplate(id:string):Promise<Result<Partial<RecurringTemplate>,RequestError>>retrieveAllRecurringTemplates(optionalFilter?:PagingParameters):Promise<Result<RecurringTemplates,RequestError>>

Voucher

createVoucher(voucher:CreateVoucher):Promise<Result<VoucherCreateResponse,RequestError>>retrieveVoucher(id:string):Promise<Result<Partial<Voucher>,RequestError>>updateVoucher(id:string,voucher:CreateVoucher):Promise<Result<VoucherCreateResponse,RequestError>>filterVoucher(voucherNumber:VoucherNumber):Promise<Result<Partial<Vouchers>,RequestError>>uploadFileToVoucher(data:FormData,id:string):Promise<Result<FileResponse,RequestError>>

Voucherlist

retrieveVoucherlist(filterParameter:FilterParameter):Promise<Result<Voucherlist,RequestError>>

🔖 Side notes

Updating

Rendering Document File Id

Download File

renderCreditNoteDocumentFileId(id);renderInvoiceDocumentFileId(id);renderOrderConfirmationDocumentFileId(id);renderQuotationDocumentFileId(id);

This package has been brought to you by elbstack!

👩🏻‍💻👨🏽‍💻 We are hiring!