docs

API Reference

One page per resource method. See examples/ for runnable scripts.

attachments

• list() — Fetch a single page of results.
• all() — Iterate lazily over every item across all pages.
• get()
• create()
• update()
• delete()
• content() — Download the raw binary content of an attachment.

contacts

• list() — Fetch a single page of a customer's contacts.
• all() — Iterate lazily over every contact of a customer across all pages.
• get()
• create()
• update()
• delete()

customerGroups

• list() — Fetch a single page of results.
• all() — Iterate lazily over every item across all pages.
• get()
• create()
• update()
• delete()

customers

• list() — Fetch a single page of results.
• all() — Iterate lazily over every item across all pages.
• get()
• create()
• update()
• delete()
• transferSepaMandate() — Transfer the SEPA mandate of a customer to another payment provider.

discountPositionGroups

• list() — Fetch a single page of results.
• all() — Iterate lazily over every item across all pages.
• get()
• create()
• update()
• delete()

discountPositions

• list() — Fetch a single page of results.
• all() — Iterate lazily over every item across all pages.
• get()
• create()
• update()
• delete()

documentPayments

• list() — Fetch a single page of results.
• all() — Iterate lazily over every item across all pages.
• get()
• create()
• delete()

documents

• list() — Fetch a single page of documents.
• all() — Iterate lazily over every document across all pages.
• get()
• create()
• update()
• delete()
• done() — Mark a document as done (completed).
• cancel() — Cancel a document (creating a cancellation document).
• send() — Send a document via the given channel.
• convert() — Convert a document into another type (e.g. an offer into an invoice).
• pdf() — Download the document as a PDF.
• jpg() — Download the document as a JPG image.
• downloadFile() — Download the document file (e.g. the raw e-invoice XML or PDF).
• versions() — List the versions of a document.
• version() — Fetch a single version of a document.
• downloadVersionItem() — Download a single item of a document version.

logins

• list() — Fetch a single page of results.
• all() — Iterate lazily over every item across all pages.
• get()

pdfTemplates

• list() — Fetch the full set of available PDF templates.
• all() — Fetch the available PDF templates as a plain list.

positionGroups

• list() — Fetch a single page of results.
• all() — Iterate lazily over every item across all pages.
• get()
• create()
• update()
• delete()

positions

• list() — Fetch a single page of results.
• all() — Iterate lazily over every item across all pages.
• get()
• create()
• update()
• delete()

postBoxes

• list() — Fetch a single page of results.
• all() — Iterate lazily over every item across all pages.
• get()
• delete()

projects

• list() — Fetch a single page of results.
• all() — Iterate lazily over every item across all pages.
• get()
• create()
• update()
• delete()

sepaPayments

• list() — Fetch a single page of results.
• all() — Iterate lazily over every item across all pages.
• get()
• create()
• update()
• delete()

serialNumbers

• list() — Fetch a single page of results.
• all() — Iterate lazily over every item across all pages.
• get()
• create()
• delete()

stocks

• list() — Fetch a single page of results.
• all() — Iterate lazily over every item across all pages.
• get()
• create()

tasks

• list() — Fetch a single page of results.
• all() — Iterate lazily over every item across all pages.
• get()
• create()
• update()
• delete()

textTemplates

• list() — Fetch a single page of results.
• all() — Iterate lazily over every item across all pages.
• get()
• create()
• update()
• delete()

timeTrackings

• list() — Fetch a single page of results.
• all() — Iterate lazily over every item across all pages.
• get()
• create()
• update()
• delete()

webhooks

• list() — Fetch a single page of results.
• all() — Iterate lazily over every item across all pages.
• get()
• create()
• update()
• delete()