{"openapi":"3.1.0","info":{"title":"Let’s Peppol App API","description":"Application, document, partner, product, company, and statistics endpoints.\n\n`/api/**` endpoints are public. `/sapi/**` endpoints require an access token\nissued by KYC's OAuth 2.0 Authorization Code + PKCE flow. The App validates JWT\nsignature through KYC JWKS, plus expiry, configured issuer, and audience\n`letspeppol-api`. It forwards the user's token when a downstream KYC or Proxy\noperation must retain user/company context. Scheduled jobs and sponsor invoice\ncreation instead use the trusted `kyc-service` client-credentials grant.\n\nError bodies use either `{ \"errorCode\": \"...\" }` or `{ \"message\": \"...\" }`;\nvalidation failures include an `errors` field map. Downstream KYC/Proxy failures\npreserve their meaningful HTTP status where possible.\n","contact":{"name":"Let’s Peppol"},"version":"v1"},"servers":[{"url":"/app","description":"App API through the public reverse proxy"}],"tags":[{"name":"App Sponsors","description":"Public sponsor information and authenticated sponsor-invoice creation."},{"name":"App Company","description":"Endpoints for loading and maintaining the application-specific company profile used by the frontend."},{"name":"App Products","description":"Product catalog endpoints used to manage reusable invoice and catalog items in the application."},{"name":"App Product Categories","description":"Endpoints for maintaining the product category tree used to organize products in the application."},{"name":"App Statistics","description":"Endpoints for public donation statistics and authenticated account-level dashboard totals."},{"name":"App Peppol Directory","description":"Public lookup endpoint that proxies selected Peppol Directory search capabilities for the frontend."},{"name":"App Accountant","description":"Endpoints that support accountant-to-customer linking and access to customer document views."},{"name":"App Partners","description":"Partner master-data endpoints used to manage customers, suppliers, and counterparties inside the app."},{"name":"App Documents","description":"Endpoints for validating, listing, editing, sending, and rendering business documents inside the application."},{"name":"App Welcome Notifications","description":"Contextual onboarding notifications for the authenticated company's dashboard."},{"name":"App Invoice VAT Feedback","description":"Records the VAT-reason choices made while composing invoices so rules and UX can be evaluated."}],"paths":{"/sapi/product/{id}":{"put":{"tags":["App Products"],"summary":"Update product","description":"Updates one product record in the authenticated company's catalog.","operationId":"updateProduct","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ProductDto"}}}}},"security":[{"oauth2":["openid"]}]},"delete":{"tags":["App Products"],"summary":"Delete product","description":"Deletes a product from the authenticated company's catalog.","operationId":"deleteProduct","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}},"security":[{"oauth2":["openid"]}]}},"/sapi/product-category/{id}":{"get":{"tags":["App Product Categories"],"summary":"Get category by id","description":"Returns one product category for the authenticated company, optionally with its nested children.","operationId":"getCategory","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"deep","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ProductCategoryDto"}}}}},"security":[{"oauth2":["openid"]}]},"put":{"tags":["App Product Categories"],"summary":"Update category","description":"Updates an existing product category owned by the authenticated company.","operationId":"update","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductCategoryDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ProductCategoryDto"}}}}},"security":[{"oauth2":["openid"]}]},"delete":{"tags":["App Product Categories"],"summary":"Delete category","description":"Deletes a product category owned by the authenticated company.","operationId":"delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}},"security":[{"oauth2":["openid"]}]}},"/sapi/partner/{id}":{"put":{"tags":["App Partners"],"summary":"Update partner","description":"Updates one partner record used by the authenticated company.","operationId":"updatePartner","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PartnerDto"}}}}},"security":[{"oauth2":["openid"]}]},"delete":{"tags":["App Partners"],"summary":"Delete partner","description":"Deletes one partner record from the authenticated company's address book.","operationId":"deletePartner","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}},"security":[{"oauth2":["openid"]}]}},"/sapi/document/{id}":{"get":{"tags":["App Documents"],"summary":"Get document by id","description":"Loads one stored document visible to the authenticated company.","operationId":"getById","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DocumentDto"}}}}},"security":[{"oauth2":["openid"]}]},"put":{"tags":["App Documents"],"summary":"Update document","description":"Updates an existing document's UBL payload and send scheduling information.","operationId":"update_1","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"draft","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"schedule","in":"query","required":false,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DocumentDto"}}}}},"security":[{"oauth2":["openid"]}]},"delete":{"tags":["App Documents"],"summary":"Delete document","description":"Deletes a stored document owned by the authenticated company.","operationId":"delete_1","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK"}},"security":[{"oauth2":["openid"]}]}},"/sapi/document/{id}/send":{"put":{"tags":["App Documents"],"summary":"Send or schedule document","description":"Marks a document for transmission through Peppol immediately or at a scheduled time.","operationId":"send","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"schedule","in":"query","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DocumentDto"}}}}},"security":[{"oauth2":["openid"]}]}},"/sapi/document/{id}/reschedule":{"put":{"tags":["App Documents"],"summary":"Reschedule document","description":"Changes the scheduled transmission time of an outbound document and propagates it to Proxy when required.","operationId":"reschedule","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"schedule","in":"query","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DocumentDto"}}}}},"security":[{"oauth2":["openid"]}]}},"/sapi/document/{id}/read":{"put":{"tags":["App Documents"],"summary":"Mark document as read","description":"Updates the document workflow state to indicate it has been read by the current company.","operationId":"read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DocumentDto"}}}}},"security":[{"oauth2":["openid"]}]}},"/sapi/document/{id}/paid":{"put":{"tags":["App Documents"],"summary":"Mark document as paid","description":"Updates the document workflow state to indicate it has been paid.","operationId":"paid","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DocumentDto"}}}}},"security":[{"oauth2":["openid"]}]}},"/sapi/document/{id}/error-seen":{"put":{"tags":["App Documents"],"summary":"Acknowledge document error","description":"Marks the current transmission error as seen so the UI no longer presents it as new.","operationId":"markErrorSeen","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DocumentDto"}}}}},"security":[{"oauth2":["openid"]}]}},"/sapi/company":{"get":{"tags":["App Company"],"summary":"Get company profile","description":"Loads the company profile displayed in the app immediately after authentication.","operationId":"getCompany","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CompanyDto"}}}}},"security":[{"oauth2":["openid"]}]},"put":{"tags":["App Company"],"summary":"Update company profile","description":"Updates application-managed company fields while enforcing that the authenticated company can only modify its own profile.","operationId":"updateCompany","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CompanyDto"}}}}},"security":[{"oauth2":["openid"]}]}},"/sapi/company/peppol-registration/settings":{"get":{"tags":["App Company"],"summary":"Get company receiving settings","operationId":"getSettings","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PeppolSettings"}}}}},"security":[{"oauth2":["openid"]}]},"put":{"tags":["App Company"],"summary":"Update company receiving settings","operationId":"updateSettings","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeppolSettings"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PeppolSettings"}}}}},"security":[{"oauth2":["openid"]}]}},"/sapi/sponsors":{"post":{"tags":["App Sponsors"],"summary":"Create sponsor invoice","description":"Creates and submits a sponsor invoice for the authenticated company. App obtains its downstream Proxy token with client credentials and forwards the user token as acting-user context.","operationId":"createSponsorInvoice","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SponsorInvoiceRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SponsorInvoiceResponse"}}}}},"security":[{"oauth2":["openid"]}]}},"/sapi/product":{"get":{"tags":["App Products"],"summary":"List products","description":"Returns the product catalog owned by the authenticated company.","operationId":"getParties","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProductDto"}}}}}},"security":[{"oauth2":["openid"]}]},"post":{"tags":["App Products"],"summary":"Create product","description":"Creates a new product in the authenticated company's catalog.","operationId":"createProduct","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ProductDto"}}}}},"security":[{"oauth2":["openid"]}]}},"/sapi/product-category":{"get":{"tags":["App Product Categories"],"summary":"List root categories","description":"Returns the top-level product categories for the authenticated company, optionally expanded recursively.","operationId":"listRoot","parameters":[{"name":"deep","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProductCategoryDto"}}}}}},"security":[{"oauth2":["openid"]}]},"post":{"tags":["App Product Categories"],"summary":"Create category","description":"Creates a new product category for the authenticated company.","operationId":"create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductCategoryDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ProductCategoryDto"}}}}},"security":[{"oauth2":["openid"]}]}},"/sapi/partner":{"get":{"tags":["App Partners"],"summary":"List partners","description":"Returns the partner records owned by the authenticated company.","operationId":"getParties_1","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PartnerDto"}}}}}},"security":[{"oauth2":["openid"]}]},"post":{"tags":["App Partners"],"summary":"Create partner","description":"Creates a new partner record for the authenticated company.","operationId":"createPartner","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PartnerDto"}}}}},"security":[{"oauth2":["openid"]}]}},"/sapi/invoice-vat-reason-selection":{"post":{"tags":["App Invoice VAT Feedback"],"summary":"Record VAT-reason selections","description":"Stores a batch of VAT-reason selections for the authenticated company. This telemetry contains rule choices, not invoice contents.","operationId":"create_1","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VatReasonSelectionDto"}}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"oauth2":["openid"]}]}},"/sapi/download-jobs":{"get":{"tags":["download-job-controller"],"operationId":"findAll","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DownloadJobDto"}}}}}}},"post":{"tags":["download-job-controller"],"operationId":"create_2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDownloadJobRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DownloadJobDto"}}}}}}},"/sapi/download-jobs/{id}/retry":{"post":{"tags":["download-job-controller"],"operationId":"retry","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DownloadJobDto"}}}}}}},"/sapi/document":{"get":{"tags":["App Documents"],"summary":"List documents","description":"Returns the authenticated company's documents with optional filters for type, direction, partner, and workflow state.","operationId":"getAll","parameters":[{"name":"type","in":"query","required":false,"schema":{"type":"string","enum":["INVOICE","CREDIT_NOTE","SELF_BILLING_INVOICE","SELF_BILLING_CREDIT_NOTE"]}},{"name":"direction","in":"query","required":false,"schema":{"type":"string","enum":["INCOMING","OUTGOING"]}},{"name":"partnerName","in":"query","required":false,"schema":{"type":"string"}},{"name":"partnerPeppolId","in":"query","required":false,"schema":{"type":"string"}},{"name":"invoiceReference","in":"query","required":false,"schema":{"type":"string"}},{"name":"paid","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"overdue","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"errored","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"read","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"draft","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"pageable","in":"query","required":true,"schema":{"$ref":"#/components/schemas/Pageable"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PageResponseDocumentDto"}}}}},"security":[{"oauth2":["openid"]}]},"post":{"tags":["App Documents"],"summary":"Create document","description":"Creates a new document from UBL XML. If the company is not yet Peppol-active, the document is forced into draft mode.","operationId":"create_3","parameters":[{"name":"draft","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"schedule","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"createdExternally","in":"query","required":false,"schema":{"type":"boolean","default":true}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DocumentDto"}}}}},"security":[{"oauth2":["openid"]}]}},"/sapi/document/validate":{"post":{"tags":["App Documents"],"summary":"Validate UBL XML","description":"Checks whether a raw UBL XML payload is structurally and semantically valid before it is stored or sent.","operationId":"validate","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Validation result","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ValidationResultDto"}}}},"400":{"description":"Missing XML content","content":{"*/*":{"schema":{"type":"string"}}}}},"security":[{"oauth2":["openid"]}]}},"/sapi/accountant/link-customer":{"post":{"tags":["App Accountant"],"summary":"Request customer link","description":"Starts the workflow where an accountant asks to be linked to a customer company.","operationId":"linkCustomer","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkCustomerDto"}}},"required":true},"responses":{"200":{"description":"OK"}},"security":[{"oauth2":["openid"]}]}},"/sapi/accountant/confirm-customer-link":{"post":{"tags":["App Accountant"],"summary":"Confirm customer link","description":"Confirms a previously requested accountant-customer relationship using the supplied token.","operationId":"confirmLink","parameters":[{"name":"token","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}},"security":[{"oauth2":["openid"]}]}},"/sapi/welcome-notifications":{"get":{"tags":["App Welcome Notifications"],"summary":"List welcome notifications","description":"Returns onboarding and configuration prompts that currently apply to the authenticated company.","operationId":"getWelcomeNotifications","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/WelcomeNotificationsResponse"}}}}},"security":[{"oauth2":["openid"]}]}},"/sapi/stats/account":{"get":{"tags":["App Statistics"],"summary":"Get account dashboard totals","description":"Returns authenticated dashboard totals for the current company account.","operationId":"getAccountTotals","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TotalsDto"}}}}},"security":[{"oauth2":["openid"]}]}},"/sapi/product-category/all":{"get":{"tags":["App Product Categories"],"summary":"List all categories flat","description":"Returns all product categories for the authenticated company as a flat list.","operationId":"listAllFlat","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProductCategoryDto"}}}}}},"security":[{"oauth2":["openid"]}]}},"/sapi/partner/search":{"get":{"tags":["App Partners"],"summary":"Search partner by Peppol identifier","description":"Looks up an existing partner record for the authenticated company using a Peppol identifier.","operationId":"search","parameters":[{"name":"peppolId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PartnerDto"}}}}}},"security":[{"oauth2":["openid"]}]}},"/sapi/download-jobs/{id}/file":{"get":{"tags":["download-job-controller"],"operationId":"download","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/StreamingResponseBody"}}}}}}},"/sapi/document/{id}/pdf":{"get":{"tags":["App Documents"],"summary":"Render document as PDF","description":"Generates a PDF view of the stored UBL document for preview or download.","operationId":"getPdf","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"mode","in":"query","required":false,"schema":{"type":"string","default":"FINAL","enum":["FINAL","DRAFT","PROFORMA"]}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}}},"security":[{"oauth2":["openid"]}]}},"/sapi/document/{id}/details":{"get":{"tags":["App Documents"],"summary":"Get document details","description":"Returns the extended UBL-derived details used by the document editor and detail view.","operationId":"getDetails","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DocumentDetailsDto"}}}}},"security":[{"oauth2":["openid"]}]}},"/sapi/company/peppol-registration":{"get":{"tags":["App Company"],"summary":"Get company Peppol registration","description":"Reads the authenticated company's current Access Point and the configured default for new registrations from the proxy.","operationId":"getRegistration","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PeppolRegistrationDto"}}}}},"security":[{"oauth2":["openid"]}]}},"/sapi/company/peppol-registration/receiving-availability":{"get":{"tags":["App Company"],"summary":"Check receiving availability for the authenticated company","description":"Looks up the current SMP using the Peppol ID from the JWT. No company identifier parameter is accepted or required.","operationId":"getReceivingAvailability","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PeppolSettings"}}}}},"security":[{"oauth2":["openid"]}]}},"/sapi/accountant/documents":{"get":{"tags":["App Accountant"],"summary":"List customer documents","description":"Returns paged documents for one linked customer so accountants can review customer traffic.","operationId":"getCustomerDocuments","parameters":[{"name":"customerPeppolId","in":"query","required":true,"schema":{"type":"string"}},{"name":"pageable","in":"query","required":true,"schema":{"$ref":"#/components/schemas/Pageable"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PageResponseDocumentDto"}}}}},"security":[{"oauth2":["openid"]}]}},"/sapi/accountant/customers":{"get":{"tags":["App Accountant"],"summary":"List linked customers","description":"Returns the customer companies currently linked to the authenticated accountant.","operationId":"getCustomersForAccountant","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomerDto"}}}}}},"security":[{"oauth2":["openid"]}]}},"/api/stats/donation":{"get":{"tags":["App Statistics"],"summary":"Get donation statistics","description":"Returns public donation metrics used to display project funding information.","operationId":"getOpenCollectiveAccount","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DonationStatsDto"}}}}}}},"/api/sponsors":{"get":{"tags":["App Sponsors"],"summary":"List sponsors","description":"Returns public sponsor names, logo URLs, and website links configured for the project website.","operationId":"getSponsors","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SponsorsResponseDto"}}}}}}},"/api/sponsors/contributions":{"get":{"tags":["App Sponsors"],"summary":"List sponsor contributions","description":"Returns public aggregate sponsor contribution information derived from sponsor invoices.","operationId":"getSponsorContributions","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SponsorContributionDto"}}}}}}}},"/api/peppol-directory":{"get":{"tags":["App Peppol Directory"],"summary":"Search Peppol Directory","description":"Searches the external Peppol Directory either by participant identifier or by organization name.","operationId":"find","parameters":[{"name":"name","in":"query","required":false,"schema":{"type":"string"}},{"name":"participant","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/sapi/download-jobs/{id}":{"delete":{"tags":["download-job-controller"],"operationId":"delete_2","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"No Content"}}}}},"components":{"schemas":{"ProductDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"description":{"type":"string"},"reference":{"type":"string"},"barcode":{"type":"string"},"costPrice":{"type":"number"},"salePrice":{"type":"number"},"taxPercentage":{"type":"number"},"stockQuantity":{"type":"number"},"categoryId":{"type":"integer","format":"int64"}}},"ProductCategoryDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"color":{"type":"string"},"parentId":{"type":"integer","format":"int64"},"children":{"type":"array","items":{"$ref":"#/components/schemas/ProductCategoryDto"}}}},"AddressDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"city":{"type":"string"},"postalCode":{"type":"string"},"street":{"type":"string"},"countryCode":{"type":"string"}}},"PartnerDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"identifier":{"type":"string"},"vatNumber":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"peppolId":{"type":"string"},"customer":{"type":"boolean"},"supplier":{"type":"boolean"},"paymentTerms":{"type":"string"},"iban":{"type":"string"},"paymentAccountName":{"type":"string"},"registeredOffice":{"$ref":"#/components/schemas/AddressDto"}}},"DocumentDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"direction":{"type":"string","enum":["INCOMING","OUTGOING"]},"ownerPeppolId":{"type":"string"},"partnerPeppolId":{"type":"string"},"proxyOn":{"type":"string","format":"date-time"},"scheduledOn":{"type":"string","format":"date-time"},"processedOn":{"type":"string","format":"date-time"},"processedStatus":{"type":"string"},"ubl":{"type":"string"},"draftedOn":{"type":"string","format":"date-time"},"readOn":{"type":"string","format":"date-time"},"paidOn":{"type":"string","format":"date-time"},"errorSeenOn":{"type":"string","format":"date-time"},"partnerName":{"type":"string"},"invoiceReference":{"type":"string"},"type":{"type":"string","enum":["INVOICE","CREDIT_NOTE","SELF_BILLING_INVOICE","SELF_BILLING_CREDIT_NOTE"]},"currency":{"type":"object","properties":{"currencyCode":{"type":"string"},"displayName":{"type":"string"},"symbol":{"type":"string"},"defaultFractionDigits":{"type":"integer","format":"int32"},"numericCode":{"type":"integer","format":"int32"},"numericCodeAsString":{"type":"string"}}},"amountInclVat":{"type":"number"},"amountExclVat":{"type":"number"},"issueDate":{"type":"string","format":"date-time"},"dueDate":{"type":"string","format":"date-time"},"paymentTerms":{"type":"string"},"createdExternally":{"type":"boolean"}}},"CompanyDto":{"type":"object","properties":{"peppolId":{"type":"string"},"identifier":{"type":"string"},"vatNumber":{"type":"string"},"name":{"type":"string"},"displayName":{"type":"string"},"subscriber":{"type":"string"},"subscriberEmail":{"type":"string"},"paymentTerms":{"type":"string"},"iban":{"type":"string"},"bic":{"type":"string"},"paymentAccountName":{"type":"string"},"vatRuleset":{"type":"string","enum":["VAT_REGISTERED","VAT_EXEMPT_ART_56BIS","VAT_EXEMPT_ART_44"]},"lastInvoiceReference":{"type":"string"},"lastCreditNoteReference":{"type":"string"},"peppolActive":{"type":"boolean"},"enableEmailNotification":{"type":"boolean"},"addAttachmentToNotification":{"type":"boolean"},"addPdfToSendingInvoice":{"type":"boolean"},"emailNotificationCcListIncoming":{"type":"string"},"emailNotificationCcListOutgoing":{"type":"string"},"companyGroup":{"type":"string","enum":["USER","ONCE","SPONSOR","SPECIAL","EDITOR"]},"registeredOffice":{"$ref":"#/components/schemas/AddressDto"}}},"PeppolSettings":{"type":"object","properties":{"receiveDocuments":{"type":"boolean"},"receivingSmpUrl":{"type":"string"}}},"SponsorInvoiceRequest":{"type":"object","properties":{"amount":{"type":"number","minimum":1.00},"currency":{"type":"object","properties":{"currencyCode":{"type":"string"},"displayName":{"type":"string"},"symbol":{"type":"string"},"defaultFractionDigits":{"type":"integer","format":"int32"},"numericCode":{"type":"integer","format":"int32"},"numericCodeAsString":{"type":"string"}}},"name":{"type":"string","maxLength":64,"minLength":0},"message":{"type":"string","maxLength":255,"minLength":0}},"required":["amount","currency","message","name"]},"SponsorInvoiceResponse":{"type":"object","properties":{"status":{"type":"string"},"message":{"type":"string"},"document":{"$ref":"#/components/schemas/UblDocumentDto"}}},"UblDocumentDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"direction":{"type":"string","enum":["INCOMING","OUTGOING"]},"type":{"type":"string","enum":["INVOICE","CREDIT_NOTE","SELF_BILLING_INVOICE","SELF_BILLING_CREDIT_NOTE"]},"ownerPeppolId":{"type":"string"},"partnerPeppolId":{"type":"string"},"createdOn":{"type":"string","format":"date-time"},"scheduledOn":{"type":"string","format":"date-time"},"processedOn":{"type":"string","format":"date-time"},"processedStatus":{"type":"string"},"ubl":{"type":"string"}}},"VatReasonSelectionDto":{"type":"object","properties":{"documentId":{"type":"string","format":"uuid"},"selectedTaxCategoryId":{"type":"string"},"writtenReason":{"type":"string"},"duringDraft":{"type":"boolean"}}},"CreateDownloadJobRequest":{"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"toDate":{"type":"string","format":"date"}},"required":["fromDate","toDate"]},"DownloadJobDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"fromDate":{"type":"string","format":"date"},"toDate":{"type":"string","format":"date"},"status":{"type":"string","enum":["PENDING","PROCESSING","READY","FAILED"]},"filename":{"type":"string"},"sizeBytes":{"type":"integer","format":"int64"},"createdOn":{"type":"string","format":"date-time"},"completedOn":{"type":"string","format":"date-time"},"expiresOn":{"type":"string","format":"date-time"},"downloadCount":{"type":"integer","format":"int32"},"failureMessage":{"type":"string"}}},"ValidationErrorDto":{"type":"object","properties":{"column":{"type":"integer","format":"int32"},"line":{"type":"integer","format":"int32"},"message":{"type":"string"},"severity":{"type":"string"}}},"ValidationResultDto":{"type":"object","properties":{"isValid":{"type":"boolean"},"errorCount":{"type":"integer","format":"int32"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"vesId":{"type":"string"},"detectedVESIDRaw":{"type":"string"}}},"LinkCustomerDto":{"type":"object","properties":{"customerPeppolId":{"type":"string"},"customerEmail":{"type":"string"},"customerName":{"type":"string"}}},"WelcomeNotificationDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"htmlCodeEn":{"type":"string"},"htmlCodeNl":{"type":"string"},"htmlCodeFr":{"type":"string"},"htmlCodeDe":{"type":"string"},"notificationGroup":{"type":"string","enum":["USER","ONCE","SPONSOR","SPECIAL","EDITOR"]}}},"WelcomeNotificationsResponse":{"type":"object","properties":{"peppolId":{"type":"string"},"companyGroup":{"type":"string","enum":["USER","ONCE","SPONSOR","SPECIAL","EDITOR"]},"notifications":{"type":"array","items":{"$ref":"#/components/schemas/WelcomeNotificationDto"}}}},"DirectionTotals":{"type":"object","properties":{"payableOpen":{"type":"number"},"payableOverdue":{"type":"number"},"payableThisYear":{"type":"number"},"receivableOpen":{"type":"number"},"receivableOverdue":{"type":"number"},"receivableThisYear":{"type":"number"}}},"TotalsDto":{"type":"object","properties":{"inclVat":{"$ref":"#/components/schemas/DirectionTotals"},"exclVat":{"$ref":"#/components/schemas/DirectionTotals"},"erroredUnseenCount":{"type":"integer","format":"int64"}}},"StreamingResponseBody":{},"Pageable":{"type":"object","properties":{"page":{"type":"integer","format":"int32","minimum":0},"size":{"type":"integer","format":"int32","minimum":1},"sort":{"type":"array","items":{"type":"string"}}}},"PageResponseDocumentDto":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/DocumentDto"}},"page":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"last":{"type":"boolean"}}},"DocumentDetailsDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"invoiceReference":{"type":"string"},"ownerPeppolId":{"type":"string"},"partnerPeppolId":{"type":"string"},"accessPoint":{"type":"string"},"accessPointId":{"type":"string"},"processedOn":{"type":"string","format":"date-time"},"processedStatus":{"type":"string"},"partnerPeppolAccessPoint":{"type":"string"},"partnerPeppolMessageId":{"type":"string"},"partnerPeppolMessageOn":{"type":"string","format":"date-time"}}},"PeppolRegistrationDto":{"type":"object","properties":{"peppolId":{"type":"string"},"peppolActive":{"type":"boolean"},"accessPoint":{"type":"string"},"defaultAccessPoint":{"type":"string"}}},"CustomerDto":{"type":"object","properties":{"customerPeppolId":{"type":"string"},"customerEmail":{"type":"string"},"customerName":{"type":"string"},"invitedOn":{"type":"string","format":"date-time"},"verifiedOn":{"type":"string","format":"date-time"},"lastDownloadCreatedOn":{"type":"string","format":"date-time"},"lastDownloadIssuedOn":{"type":"string","format":"date-time"}}},"Amount":{"type":"object","properties":{"value":{"type":"number"},"currency":{"type":"string"}}},"DonationStatsDto":{"type":"object","properties":{"totalContributions":{"type":"integer","format":"int64"},"totalProcessed":{"type":"integer","format":"int64"},"processedToday":{"type":"integer","format":"int64"},"maxProcessedLastWeek":{"type":"integer","format":"int64"},"invoicesRemaining":{"type":"integer","format":"int64"},"activeCompanies":{"type":"integer","format":"int64"},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/Transaction"}},"contributions":{"type":"array","items":{"$ref":"#/components/schemas/SponsorContributionDto"}}}},"FromAccount":{"type":"object","properties":{"name":{"type":"string"},"slug":{"type":"string"}}},"SponsorContributionDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"},"amount":{"type":"number"},"currency":{"type":"string"},"date":{"type":"string","format":"date-time"}}},"Transaction":{"type":"object","properties":{"type":{"type":"string"},"fromAccount":{"$ref":"#/components/schemas/FromAccount"},"amount":{"$ref":"#/components/schemas/Amount"},"createdAt":{"type":"string"}}},"SponsorDto":{"type":"object","properties":{"name":{"type":"string"},"logoUrl":{"type":"string"},"url":{"type":"string"}}},"SponsorsResponseDto":{"type":"object","properties":{"sponsors":{"type":"array","items":{"$ref":"#/components/schemas/SponsorDto"}}}}},"securitySchemes":{"oauth2":{"type":"oauth2","description":"KYC browser Authorization Code flow. PKCE (S256) is mandatory.","flows":{"authorizationCode":{"authorizationUrl":"/kyc/auth/oauth2/authorize","tokenUrl":"/kyc/auth/oauth2/token","scopes":{"openid":"OpenID Connect sign-in"}}}},"bearerAuth":{"type":"http","description":"Manual JWT entry for diagnostics; normal browser clients use OAuth2 + PKCE.","scheme":"bearer","bearerFormat":"JWT"}}}}