Billing
Invoices, offers, vouchers, donations, payments and payment providers.
AutoDunning2 Endpoints
BillingDryRun8 Endpoints
- GETThis method will get all BillingDryRun objects - without the simulated invoices
- POSTStart a new simulated billing run ("dry run").
- GETThis method will get a single BillingDryRun with the given id including all simulated invoices
- PUTArchive a BillingDryRun so it disappears from the list without losing its result.
- PATCHArchive a BillingDryRun so it disappears from the list without losing its result.
- DELETEDelete a BillingDryRun together with its simulated invoices.
- + 2 Endpoints
BillingItemType1 Endpoints
BillingPaymentProfile5 Endpoints
BillingPayoutAccount5 Endpoints
BillReminder5 Endpoints
Donation16 Endpoints
- GETAuswertung der Spenden (V1): abgeschlossene Spenden im Zeitraum, gesamt, nur Geld, je Spendenziel, je Monat und je Zahlart. Vorgabe ist das laufende Jahr. Setting donation_report_enabled. Die Buchungsliste dazu ist der Export iw-export-donation-bookings.
- GETList all donations
- POSTCreate a new donation (admin)
- GETGet a single donation
- PUTUpdate a donation (limited fields: status, address, person/company link)
- PATCHUpdate a donation (limited fields: status, address, person/company link)
- + 10 Endpoints
Donation Receipt3 Endpoints
DonationExternal9 Endpoints
DonationGoal7 Endpoints
Invoice23 Endpoints
- GETThis method will get all Invoice Objects
- POSTCreates a single Invoice
- GETReturns the default values used for creating free invoices.
- GETThis method will print an Invoice as PDF (optional with ZUGFeRD XML)
- GETThis method will return the GiroCode (EPC QR code) of an open Invoice for a bank transfer
- GETThis method will print an ZUGFeRD XML
- + 17 Endpoints
InvoicePayment2 Endpoints
Offer8 Endpoints
OfferAccountingType4 Endpoints
Payment Gateway7 Endpoints
- GETGet provider schema from payment gateway (with fallback)
- POSTSetup payment gateway for additional service user
- GETReturn normalized Stripe, Mollie and GoCardless connection states.
- POSTStart provider authorization and return the external authorization URL.
- DELETEDisconnect a connected merchant account.
- GETList profiles belonging to the connected Mollie organization.
- + 1 Endpoints
PaymentGoal6 Endpoints
PaymentTransaction5 Endpoints
PaymentType6 Endpoints
PredefinedBillingItem5 Endpoints
ProductLabel7 Endpoints
- GETPublic JSON endpoint: producer guarantee, EU GARAN eligibility and availability + public URL of every label type. Also answers for unknown products (found=false, all labels unavailable) with the URLs still pointing at the show endpoint, so a shop can embed them blindly.
- GETPublic image endpoint: serves the label of the given type for the product identified by any unique identifier (id, short_identifier, slug, SKU, barcode, import ids). An ECS product is found by both of its import ids, `ecs_118760` and `ecs_{source_system}_item_118760`. A trailing file extension (.png, .jpg, .svg, ...) is ignored, so the URL may look like an image file.
- GETPublic: the GARAN pictogram ("nested label") pre-rendered from the official EU template for a given number of years - independent of a product, e.g. for a shop that knows the years itself. `/garan_pictogram/5`, `/garan_pictogram/5.svg`, `/garan_pictogram/10.png`.
- POSTUpload (replace) one label of a product. Multipart form `attachment[file]`, optional `attachment[producerGuaranteeYears]` (e.g. "5" or "2,5").
- POSTAuto match upload: the file name names the product (SKU, EAN / barcode, short identifier, ...) and optionally the label type (`..._piktogramm.png`, default `attachment[labelType]`, otherwise the GARAN label). The label is linked when exactly one product matches and it has no uploaded label of this type yet - an existing label is never replaced. Business outcomes (no product, ambiguous, label exists, invalid file) are answered with 200 and a status.
- POSTUpload (replace) one label of a product. Multipart form `attachment[file]`, optional `attachment[producerGuaranteeYears]` (e.g. "5" or "2,5").
- + 1 Endpoints
ProformaInvoice3 Endpoints
ProjectTimeReport3 Endpoints
RecurringDonation7 Endpoints
SepaPaymentTransaction3 Endpoints
- GETReturns the names of the generated sepa exports together with the numbers needed to pick one: how many transactions it holds, what they add up to and when it was generated. This is the first step of the review - a name is picked here and passed to the list endpoint.
- GETReturns the duplicate warnings of one generated sepa export: the groups of transactions that debit the same value from the same payment owner or from the same iban, together with the totals of the export. Computed over the whole export, independent of list pagination.
- GETReturns the transactions of one generated sepa export. The export is selected by its name, so `name` is required - without it the endpoint would return every transaction ever generated. Each row carries the duplicate warning flags for the whole export, and `duplicates` restricts the list to the flagged rows.