{"openapi":"3.1.0","info":{"title":"e-invoice.be Peppol Access Point API","version":"1.1.0","x-logo":{"url":"https://e-invoice.be/einvoice.svg"}},"servers":[{"url":"https://api.e-invoice.be","description":"Production"},{"url":"https://api-dev.e-invoice.be","description":"Staging"}],"paths":{"/api/documents/":{"post":{"tags":["Documents"],"summary":"Create Document","description":"Create a new invoice or credit note","operationId":"post_document_api_documents__post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"construct_pdf","in":"query","required":false,"schema":{"type":"boolean","description":"If true, generate a constructed PDF from the document and include it both as document attachment and embedded in the UBL.","default":false,"title":"Construct Pdf"},"description":"If true, generate a constructed PDF from the document and include it both as document attachment and embedded in the UBL."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentResponse"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Not Acceptable: Document is not valid according to Peppol BIS Billing 3.0","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable Entity: Invalid response data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/documents/{document_id}/send":{"post":{"tags":["Documents"],"summary":"Send Document","description":"Send an invoice or credit note via Peppol. By default, the sender and receiver Peppol IDs are derived from the company (tax) IDs in the document, regardless of whether the document was created from a UBL with a different endpoint ID. To explicitly set the sender or receiver Peppol ID, provide them via the query parameters (sender_peppol_scheme, sender_peppol_id, receiver_peppol_scheme, receiver_peppol_id).","operationId":"post_document_send_api_documents__document_id__send_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}},{"name":"sender_peppol_scheme","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sender Peppol Scheme"}},{"name":"sender_peppol_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sender Peppol Id"}},{"name":"receiver_peppol_scheme","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receiver Peppol Scheme"}},{"name":"receiver_peppol_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receiver Peppol Id"}},{"name":"email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentResponse"}}}},"400":{"description":"Bad Request: Document UBL is not validated yet or missing Peppol information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found: Document with the specified ID doesn't exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"405":{"description":"Method Not Allowed: Document is not in draft state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"406":{"description":"Not Acceptable: Document can not be validated as valid UBL document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict: Document is not allowed to send from the given Peppol ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/documents/{document_id}/validate":{"post":{"tags":["Documents"],"summary":"Validate Document","description":"Validate a UBL document according to Peppol BIS Billing 3.0","operationId":"post_document_validate_api_documents__document_id__validate_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UBLDocumentValidationResponse"}}}},"400":{"description":"Bad Request: Document is invalid according to Peppol BIS Billing 3.0","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found: Document with the specified ID doesn't exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable Entity: Invalid response data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/documents/{document_id}/attachments":{"post":{"tags":["Documents"],"summary":"Add Attachment","description":"Add one or more attachments to an invoice. Be careful: the attachments ARE NOT ADDED to the UBL! They are only stored in our database and can be downloaded later. To add attachments to the UBL, you need to add the attachment(s) via POST /api/documents","operationId":"post_document_attachments_api_documents__document_id__attachments_post","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_post_document_attachments_api_documents__document_id__attachments_post"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentAttachment"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found: Document with the specified ID doesn't exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable Entity: Invalid response data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"tags":["Documents"],"summary":"Get Document Attachments","description":"Get all attachments for an invoice or credit note","operationId":"get_document_attachments","security":[{"HTTPBearer":[]}],"parameters":[{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DocumentAttachment"},"title":"Response Get Document Attachments"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found: Document with the specified ID doesn't exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable Entity: Invalid response data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/documents/{document_id}":{"get":{"tags":["Documents"],"summary":"Get Document","description":"Get an invoice or credit note by ID","operationId":"get_document","security":[{"HTTPBearer":[]}],"parameters":[{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentResponse"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found: Document with the specified ID doesn't exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Documents"],"summary":"Delete Document","description":"Delete an invoice or credit note","operationId":"delete_document","security":[{"HTTPBearer":[]}],"parameters":[{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentDelete"}}}},"400":{"description":"Bad Request: Document is not in draft state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found: Document with the specified ID doesn't exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/documents/{document_id}/attachments/{attachment_id}":{"get":{"tags":["Documents"],"summary":"Get Document Attachment","description":"Get attachment details with for an invoice or credit note with link to download file (signed URL, valid for 1 hour)","operationId":"get_document_attachment","security":[{"HTTPBearer":[]}],"parameters":[{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}},{"name":"attachment_id","in":"path","required":true,"schema":{"type":"string","title":"Attachment Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentAttachment"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found: Document Attachment with the specified ID doesn't exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable Entity: Invalid response data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"tags":["Documents"],"summary":"Delete Document Attachment","description":"Delete an attachment from an invoice or credit note","operationId":"delete_document_attachment","security":[{"HTTPBearer":[]}],"parameters":[{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}},{"name":"attachment_id","in":"path","required":true,"schema":{"type":"string","title":"Attachment Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentAttachmentDelete"}}}},"400":{"description":"Bad Request: Document is not in draft state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found: Document with the specified ID doesn't exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/documents/{document_id}/ubl":{"get":{"tags":["Documents"],"summary":"Get Document UBL","description":"Get the UBL for an invoice or credit note","operationId":"get_document_ubl","security":[{"HTTPBearer":[]}],"parameters":[{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentUBL"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found: Document with the specified ID doesn't exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable Entity: Invalid response data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/documents/ubl":{"post":{"tags":["Documents"],"summary":"Create Document from UBL","description":"Create a new invoice or credit note from a UBL file","operationId":"post_document_ubl","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_post_document_ubl"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentResponse"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found: Document with the specified ID doesn't exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"415":{"description":"Unsupported Media Type: UBL file is not valid or empty","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable Entity: Invalid response data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/documents/pdf":{"post":{"tags":["Documents"],"summary":"Create Document from PDF","description":"Create a new invoice or credit note from a PDF file. If the 'ubl_document' field is set in the response, it indicates that sufficient details were extracted from the PDF to automatically generate a valid UBL document ready for sending. If 'ubl_document' is not set, human intervention may be required to ensure compliance.","operationId":"post_document_pdf","security":[{"HTTPBearer":[]}],"parameters":[{"name":"vendor_tax_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Tax Id"}},{"name":"customer_tax_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Tax Id"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_post_document_pdf"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCreateFromPdf"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"415":{"description":"Unsupported Media Type: PDF file is not valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable Entity: Invalid response data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/documents/{document_id}/timeline":{"get":{"tags":["Documents"],"summary":"Get Document Timeline","description":"Get the timeline of events for an invoice or credit note, including creation, validation, transmission, and delivery events","operationId":"get_document_timeline","security":[{"HTTPBearer":[]}],"parameters":[{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentTimeline"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found: Document with the specified ID doesn't exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/inbox/":{"get":{"tags":["Inbox"],"summary":"List Received Documents","description":"Retrieve a paginated list of received documents with filtering options including state, type, sender, date range, and text search.","operationId":"get_inbox","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Number of items per page","default":20,"title":"Page Size"},"description":"Number of items per page"},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/DocumentType"},{"type":"null"}],"description":"Filter by document type. If not provided, returns all types.","title":"Type"},"description":"Filter by document type. If not provided, returns all types."},{"name":"sender","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by sender (vendor_name, vendor_email, vendor_tax_id, vendor_company_id)","title":"Sender"},"description":"Filter by sender (vendor_name, vendor_email, vendor_tax_id, vendor_company_id)"},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter by issue date (from)","title":"Date From"},"description":"Filter by issue date (from)"},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter by issue date (to)","title":"Date To"},"description":"Filter by issue date (to)"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search in invoice number, seller/buyer names","title":"Search"},"description":"Search in invoice number, seller/buyer names"},{"name":"sort_by","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SortField","description":"Field to sort by","default":"created_at"},"description":"Field to sort by"},{"name":"sort_order","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SortOrder","description":"Sort direction (asc/desc)","default":"desc"},"description":"Sort direction (asc/desc)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_DocumentResponse_"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/inbox/invoices":{"get":{"tags":["Inbox"],"summary":"List Received Invoices","description":"Retrieve a paginated list of received invoices with filtering options.","operationId":"get_inbox_invoices","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Number of items per page","default":20,"title":"Page Size"},"description":"Number of items per page"},{"name":"sort_by","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SortField","description":"Field to sort by","default":"created_at"},"description":"Field to sort by"},{"name":"sort_order","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SortOrder","description":"Sort direction (asc/desc)","default":"desc"},"description":"Sort direction (asc/desc)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_DocumentResponse_"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/inbox/credit-notes":{"get":{"tags":["Inbox"],"summary":"List Received Credit Notes","description":"Retrieve a paginated list of received credit notes with filtering options.","operationId":"get_inbox_credit_notes","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Number of items per page","default":20,"title":"Page Size"},"description":"Number of items per page"},{"name":"sort_by","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SortField","description":"Field to sort by","default":"created_at"},"description":"Field to sort by"},{"name":"sort_order","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SortOrder","description":"Sort direction (asc/desc)","default":"desc"},"description":"Sort direction (asc/desc)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_DocumentResponse_"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/mailbox/":{"get":{"tags":["Mailbox"],"summary":"List Inbound Emails","description":"Retrieve a paginated list of received inbound emails with filtering, search, and sorting options.","operationId":"list_mailbox","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Number of items per page","default":20,"title":"Page Size"},"description":"Number of items per page"},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/InboundEmailStatus"},{"type":"null"}],"description":"Filter by status: pending, success, or failed. Takes precedence over `processed` if both are provided.","title":"Status"},"description":"Filter by status: pending, success, or failed. Takes precedence over `processed` if both are provided."},{"name":"processed","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter by processing status. If not provided, returns all. Ignored when `status` is set.","title":"Processed"},"description":"Filter by processing status. If not provided, returns all. Ignored when `status` is set."},{"name":"received_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Inclusive lower bound on received date (falls back to created_at when received_at is null)","title":"Received From"},"description":"Inclusive lower bound on received date (falls back to created_at when received_at is null)"},{"name":"received_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Inclusive upper bound on received date (falls back to created_at when received_at is null)","title":"Received To"},"description":"Inclusive upper bound on received date (falls back to created_at when received_at is null)"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Case-insensitive search across sender email, subject, message ID, and attachment filenames","title":"Search"},"description":"Case-insensitive search across sender email, subject, message ID, and attachment filenames"},{"name":"sort_by","in":"query","required":false,"schema":{"$ref":"#/components/schemas/InboundEmailSortField","description":"Field to sort by","default":"received_at"},"description":"Field to sort by"},{"name":"sort_order","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SortOrder","description":"Sort direction (asc/desc)","default":"desc"},"description":"Sort direction (asc/desc)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_InboundEmailResponse_"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/mailbox/{inbound_email_id}":{"get":{"tags":["Mailbox"],"summary":"Get Inbound Email Detail","description":"Retrieve a single inbound email by ID, scoped to the caller's tenant.","operationId":"get_mailbox_email","security":[{"HTTPBearer":[]}],"parameters":[{"name":"inbound_email_id","in":"path","required":true,"schema":{"type":"string","title":"Inbound Email Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundEmailResponse"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found: Inbound email not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/mailbox/{inbound_email_id}/attachments/{filename}":{"get":{"tags":["Mailbox"],"summary":"Download Inbound Email Attachment","description":"Download a specific attachment from an inbound email by filename. Returns the binary content with the correct Content-Type.","operationId":"download_mailbox_attachment","security":[{"HTTPBearer":[]}],"parameters":[{"name":"inbound_email_id","in":"path","required":true,"schema":{"type":"string","title":"Inbound Email Id"}},{"name":"filename","in":"path","required":true,"schema":{"type":"string","title":"Filename"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found: Email or attachment not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/mailbox/{inbound_email_id}/reprocess":{"post":{"tags":["Mailbox"],"summary":"Reprocess Failed Inbound Email","description":"Retry processing of a previously failed inbound email by replaying the original Postmark payload.","operationId":"reprocess_mailbox_email","security":[{"HTTPBearer":[]}],"parameters":[{"name":"inbound_email_id","in":"path","required":true,"schema":{"type":"string","title":"Inbound Email Id"}}],"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundEmailResponse"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found: Inbound email not found or belongs to another tenant","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict: Email is not in a reprocessable state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable Entity: Original payload not available in storage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/outbox/":{"get":{"tags":["Outbox"],"summary":"List Sent Documents","description":"Retrieve a paginated list of sent documents with filtering options including state, type, sender, date range, and text search.","operationId":"get_outbox","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Number of items per page","default":20,"title":"Page Size"},"description":"Number of items per page"},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/DocumentType"},{"type":"null"}],"description":"Filter by document type. If not provided, returns all types.","title":"Type"},"description":"Filter by document type. If not provided, returns all types."},{"name":"sender","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"(Deprecated) Filter by sender ID","title":"Sender"},"description":"(Deprecated) Filter by sender ID"},{"name":"receiver","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by receiver (customer_name, customer_email, customer_tax_id, customer_company_id, customer_id)","title":"Receiver"},"description":"Filter by receiver (customer_name, customer_email, customer_tax_id, customer_company_id, customer_id)"},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter by issue date (from)","title":"Date From"},"description":"Filter by issue date (from)"},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter by issue date (to)","title":"Date To"},"description":"Filter by issue date (to)"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search in invoice number, seller/buyer names","title":"Search"},"description":"Search in invoice number, seller/buyer names"},{"name":"sort_by","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SortField","description":"Field to sort by","default":"created_at"},"description":"Field to sort by"},{"name":"sort_order","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SortOrder","description":"Sort direction (asc/desc)","default":"desc"},"description":"Sort direction (asc/desc)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_DocumentResponse_"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/outbox/drafts":{"get":{"tags":["Outbox"],"summary":"List Draft Documents","description":"Retrieve a paginated list of draft documents with filtering options including state and text search.","operationId":"get_outbox_drafts","deprecated":true,"security":[{"HTTPBearer":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Number of items per page","default":20,"title":"Page Size"},"description":"Number of items per page"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/DocumentState"},{"type":"null"}],"description":"Filter by document state","title":"State"},"description":"Filter by document state"},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/DocumentType"},{"type":"null"}],"description":"Filter by document type","title":"Type"},"description":"Filter by document type"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search in invoice number, seller/buyer names","title":"Search"},"description":"Search in invoice number, seller/buyer names"},{"name":"sort_by","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SortField","description":"Field to sort by","default":"created_at"},"description":"Field to sort by"},{"name":"sort_order","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SortOrder","description":"Sort direction (asc/desc)","default":"desc"},"description":"Sort direction (asc/desc)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_DocumentResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/drafts/":{"get":{"tags":["Drafts"],"summary":"List Draft Documents","description":"Retrieve a paginated list of draft documents with filtering options including state and text search.","operationId":"get_drafts","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Number of items per page","default":20,"title":"Page Size"},"description":"Number of items per page"},{"name":"state","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/DocumentState"},{"type":"null"}],"description":"Filter by document state. By default return all states (DRAFT, TRANSIT, FAILED).","title":"State"},"description":"Filter by document state. By default return all states (DRAFT, TRANSIT, FAILED)."},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/DocumentType"},{"type":"null"}],"description":"Filter by document type","title":"Type"},"description":"Filter by document type"},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter by issue date (from)","title":"Date From"},"description":"Filter by issue date (from)"},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter by issue date (to)","title":"Date To"},"description":"Filter by issue date (to)"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search in invoice number, seller/buyer names","title":"Search"},"description":"Search in invoice number, seller/buyer names"},{"name":"sort_by","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SortField","description":"Field to sort by","default":"created_at"},"description":"Field to sort by"},{"name":"sort_order","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SortOrder","description":"Sort direction (asc/desc)","default":"desc"},"description":"Sort direction (asc/desc)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_DocumentResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/validate/ubl":{"post":{"tags":["Validate"],"summary":"Validate UBL Document","description":"Validate the correctness of a UBL document","operationId":"validate_ubl_api_validate_ubl_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_validate_ubl_api_validate_ubl_post"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UBLDocumentValidationResponse"}}}},"422":{"description":"Unprocessable File: Invalid file type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/validate/json":{"post":{"tags":["Validate"],"summary":"Validate JSON Document","description":"Validate if the JSON document can be converted to a valid UBL document","operationId":"validate_json_api_validate_json_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCreate"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UBLDocumentValidationResponse"}}}},"422":{"description":"Unprocessable File: Invalid file type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/validate/peppol-id":{"get":{"tags":["Validate"],"summary":"Validate Peppol ID","description":"Validate if a Peppol ID exists in the Peppol network and retrieve supported document types. The peppol_id must be in the form of `<scheme>:<id>`. The scheme is a 4-digit code representing the identifier scheme, and the id is the actual identifier value. For example, for a Belgian company it is `0208:0123456789` (where 0208 is the scheme for Belgian enterprises, followed by the 10 digits of the official BTW / KBO number).","operationId":"validate_peppol_id_api_validate_peppol_id_get","parameters":[{"name":"peppol_id","in":"query","required":true,"schema":{"type":"string","description":"Peppol ID in the format `<scheme>:<id>`. Example: `0208:1018265814` for a Belgian company.","title":"Peppol Id"},"description":"Peppol ID in the format `<scheme>:<id>`. Example: `0208:1018265814` for a Belgian company."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeppolIdValidationResponse"}}}},"422":{"description":"Unprocessable Entity: Invalid Peppol ID format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/lookup":{"get":{"tags":["Lookup"],"summary":"Lookup Peppol ID","description":"Lookup Peppol ID. The peppol_id must be in the form of `<scheme>:<id>`. The scheme is a 4-digit code representing the identifier scheme, and the id is the actual identifier value. For example, for a Belgian company it is `0208:0123456789` (where 0208 is the scheme for Belgian enterprises, followed by the 10 digits of the official BTW / KBO number).","operationId":"get_lookup_peppol_id","parameters":[{"name":"peppol_id","in":"query","required":true,"schema":{"type":"string","description":"Peppol ID in the format `<scheme>:<id>`. Example: `0208:1018265814` for a Belgian company.","title":"Peppol Id"},"description":"Peppol ID in the format `<scheme>:<id>`. Example: `0208:1018265814` for a Belgian company."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeppolIdLookupResponse"}}}},"422":{"description":"Unprocessable Entity: Invalid Peppol ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/lookup/participants":{"get":{"tags":["Lookup"],"summary":"Lookup Peppol participants","description":"Lookup Peppol participants by name or other identifiers. You can limit the search to a specific country by providing the country code.","operationId":"get_lookup_participants","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","description":"Query to lookup","title":"Query"},"description":"Query to lookup"},{"name":"country_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Country code of the company to lookup. If not provided, the search will be global.","title":"Country Code"},"description":"Country code of the company to lookup. If not provided, the search will be global."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeppolSearchResult"}}}},"422":{"description":"Unprocessable Entity: Invalid query","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/me/":{"get":{"tags":["Tenant"],"summary":"Get information about your account","description":"Retrieve information about your account.","operationId":"get_me_api_me__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantPublic"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found: Tenant not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/webhooks/":{"get":{"tags":["Webhooks"],"summary":"Get All Webhooks","description":"Get all webhooks for the current tenant","operationId":"get_webhooks_api_webhooks__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/WebhookResponse"},"type":"array","title":"Response Get Webhooks Api Webhooks  Get"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTPBearer":[]}]},"post":{"tags":["Webhooks"],"summary":"Create Webhook","description":"Create a new webhook","operationId":"create_webhook_api_webhooks__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreate"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookResponse"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable Entity: Invalid webhook data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/webhooks/{webhook_id}":{"get":{"tags":["Webhooks"],"summary":"Get Webhook","description":"Get a webhook by ID","operationId":"get_webhook_api_webhooks__webhook_id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"webhook_id","in":"path","required":true,"schema":{"type":"string","title":"Webhook Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookResponse"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found: Webhook with the specified ID doesn't exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Webhooks"],"summary":"Update Webhook","description":"Update a webhook by ID","operationId":"update_webhook_api_webhooks__webhook_id__put","security":[{"HTTPBearer":[]}],"parameters":[{"name":"webhook_id","in":"path","required":true,"schema":{"type":"string","title":"Webhook Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookResponse"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found: Webhook with the specified ID doesn't exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable Entity: Invalid response data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"tags":["Webhooks"],"summary":"Delete Webhook","description":"Delete a webhook","operationId":"delete_webhook_api_webhooks__webhook_id__delete","security":[{"HTTPBearer":[]}],"parameters":[{"name":"webhook_id","in":"path","required":true,"schema":{"type":"string","title":"Webhook Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDelete"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found: Webhook with the specified ID doesn't exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/webhooks/{webhook_id}/history":{"get":{"tags":["Webhooks"],"summary":"Get Webhook History","description":"Get the history of a webhook","operationId":"get_webhook_history_api_webhooks__webhook_id__history_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"webhook_id","in":"path","required":true,"schema":{"type":"string","title":"Webhook Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEventHistoryResponse"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/webhooks/{webhook_id}/test":{"post":{"tags":["Webhooks"],"summary":"Test Webhook","description":"Send a test event to a webhook for testing and debugging purposes","operationId":"test_webhook_api_webhooks__webhook_id__test_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"webhook_id","in":"path","required":true,"schema":{"type":"string","title":"Webhook Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookTestRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookTestResponse"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found: Webhook with the specified ID doesn't exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Unprocessable Entity: Invalid event_type or event_type not subscribed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api/conversion/pdf":{"post":{"tags":["Conversion"],"summary":"Convert a PDF to a document","description":"Convert a PDF to a document","operationId":"post_document_pdf_async_api_conversion_pdf_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_post_document_pdf_async_api_conversion_pdf_post"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCreateFromPdfTask"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found: Tenant not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/conversion/pdf/{task_id}":{"get":{"tags":["Conversion"],"summary":"Get PDF conversion status","description":"Get the status of a PDF conversion task","operationId":"get_document_pdf_async_api_conversion_pdf__task_id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"string","title":"Task Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCreateFromPdfTask"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found: Task not found or expired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/conversion/pdf/{task_id}/result":{"get":{"tags":["Conversion"],"summary":"Get PDF conversion result","description":"Get the result of a PDF conversion task","operationId":"get_document_pdf_async_result_api_conversion_pdf__task_id__result_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"string","title":"Task Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCreateFromPdf"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"PDF conversion result not found or expired","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/stats":{"get":{"tags":["Tenant"],"summary":"Get Usage Statistics","description":"Retrieve usage statistics for billing purposes. Returns statistics for document sent and document received actions, grouped by aggregation period (day/week/month). If no date parameters are provided, returns daily stats for all available data.","operationId":"get_stats","security":[{"HTTPBearer":[]}],"parameters":[{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Start date in yyyy-mm-dd format. If not provided, queries from earliest available data.","title":"Start Date"},"description":"Start date in yyyy-mm-dd format. If not provided, queries from earliest available data."},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"End date in yyyy-mm-dd format. If not provided, queries to latest available data.","title":"End Date"},"description":"End date in yyyy-mm-dd format. If not provided, queries to latest available data."},{"name":"aggregation","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/StatsAggregationType"},{"type":"null"}],"description":"Aggregation type: DAY, WEEK, or MONTH. Defaults to DAY.","default":"DAY","title":"Aggregation"},"description":"Aggregation type: DAY, WEEK, or MONTH. Defaults to DAY."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatsResponse"}}}},"401":{"description":"Unauthorized: API key is missing, invalid, or inactive","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"400":{"description":"Bad Request: Invalid date range or format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error: Unexpected server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"ActionStats":{"properties":{"action":{"$ref":"#/components/schemas/ActionType","description":"Type of action"},"stat_date":{"type":"string","format":"date","title":"Stat Date","description":"The date/period this stat represents. For DAY aggregation this is the specific day, for WEEK it's the start of the week, for MONTH it's the first day of the month"},"count":{"type":"integer","minimum":0.0,"title":"Count","description":"Number of occurrences of this action in this period"}},"type":"object","required":["action","stat_date","count"],"title":"ActionStats","description":"Statistics for a specific action in a specific time period."},"ActionType":{"type":"string","enum":["DOCUMENT_SENT","DOCUMENT_RECEIVED"],"title":"ActionType"},"Allowance-Input":{"properties":{"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason","description":"The reason for the allowance"},"reason_code":{"anyOf":[{"$ref":"#/components/schemas/AllowanceReasonCode"},{"type":"null"}],"description":"The code for the allowance reason."},"multiplier_factor":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"string"},{"type":"null"}],"title":"Multiplier Factor","description":"The percentage that may be used, in conjunction with the allowance base amount, to calculate the allowance amount. To state 20%, use value 20. Must be rounded to maximum 2 decimals"},"amount":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Amount","description":"The allowance amount, without VAT. Must be rounded to maximum 2 decimals"},"base_amount":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Base Amount","description":"The base amount that may be used, in conjunction with the allowance percentage, to calculate the allowance amount. Must be rounded to maximum 2 decimals"},"tax_rate":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"string"},{"type":"null"}],"title":"Tax Rate","description":"The VAT rate, represented as percentage that applies to the allowance. Must be rounded to maximum 2 decimals","default":21.0},"tax_code":{"$ref":"#/components/schemas/TaxCategoryCode","description":"The VAT category code that applies to the allowance","default":"S"}},"type":"object","title":"Allowance","description":"An allowance is a discount for example for early payment, volume discount, etc."},"Allowance-Output":{"properties":{"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason","description":"The reason for the allowance"},"reason_code":{"anyOf":[{"$ref":"#/components/schemas/AllowanceReasonCode"},{"type":"null"}],"description":"The code for the allowance reason."},"multiplier_factor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Multiplier Factor","description":"The percentage that may be used, in conjunction with the allowance base amount, to calculate the allowance amount. To state 20%, use value 20. Must be rounded to maximum 2 decimals"},"amount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Amount","description":"The allowance amount, without VAT. Must be rounded to maximum 2 decimals"},"base_amount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Base Amount","description":"The base amount that may be used, in conjunction with the allowance percentage, to calculate the allowance amount. Must be rounded to maximum 2 decimals"},"tax_rate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Rate","description":"The VAT rate, represented as percentage that applies to the allowance. Must be rounded to maximum 2 decimals","default":21.0},"tax_code":{"$ref":"#/components/schemas/TaxCategoryCode","description":"The VAT category code that applies to the allowance","default":"S"}},"type":"object","title":"Allowance","description":"An allowance is a discount for example for early payment, volume discount, etc."},"AllowanceBase":{"properties":{"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason","description":"The reason for the allowance"},"reason_code":{"anyOf":[{"$ref":"#/components/schemas/AllowanceReasonCode"},{"type":"null"}],"description":"The code for the allowance reason."},"multiplier_factor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Multiplier Factor","description":"The percentage that may be used, in conjunction with the allowance base amount, to calculate the allowance amount. To state 20%, use value 20. Must be rounded to maximum 2 decimals"},"amount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Amount","description":"The allowance amount, without VAT. Must be rounded to maximum 2 decimals"},"base_amount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Base Amount","description":"The base amount that may be used, in conjunction with the allowance percentage, to calculate the allowance amount. Must be rounded to maximum 2 decimals"},"tax_rate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Rate","description":"The VAT rate, represented as percentage that applies to the allowance. Must be rounded to maximum 2 decimals","default":21.0},"tax_code":{"$ref":"#/components/schemas/TaxCategoryCode","description":"The VAT category code that applies to the allowance","default":"S"}},"type":"object","title":"AllowanceBase"},"AllowanceReasonCode":{"type":"string","enum":["41","42","60","62","63","64","65","66","67","68","70","71","88","95","100","102","103","104","105"],"title":"AllowanceReasonCode","description":"Allowance reason codes for invoice discounts and charges"},"AttachmentInfo":{"properties":{"filename":{"type":"string","title":"Filename"},"size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Size"},"content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content Type"}},"type":"object","required":["filename"],"title":"AttachmentInfo"},"Body_post_document_attachments_api_documents__document_id__attachments_post":{"properties":{"file":{"type":"string","format":"binary","title":"File"}},"type":"object","required":["file"],"title":"Body_post_document_attachments_api_documents__document_id__attachments_post"},"Body_post_document_pdf":{"properties":{"file":{"type":"string","format":"binary","title":"File"}},"type":"object","required":["file"],"title":"Body_post_document_pdf"},"Body_post_document_pdf_async_api_conversion_pdf_post":{"properties":{"file":{"type":"string","format":"binary","title":"File"}},"type":"object","required":["file"],"title":"Body_post_document_pdf_async_api_conversion_pdf_post"},"Body_post_document_ubl":{"properties":{"file":{"type":"string","format":"binary","title":"File"}},"type":"object","required":["file"],"title":"Body_post_document_ubl"},"Body_validate_ubl_api_validate_ubl_post":{"properties":{"file":{"type":"string","format":"binary","title":"File"}},"type":"object","required":["file"],"title":"Body_validate_ubl_api_validate_ubl_post"},"BusinessEntity":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the business entity","examples":["Example Corporation Ltd"]},"countryCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Countrycode","description":"ISO 3166-1 alpha-2 country code of the business entity","examples":["NO"]},"registrationDate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registrationdate","description":"ISO 8601 date of when the entity was registered in Peppol","examples":["2021-06-15T00:00:00Z"]},"additionalInformation":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Additionalinformation","description":"Additional information about the business entity","examples":[["VAT: BE1018265814","Organization number: 1018.265.814"]]}},"type":"object","title":"BusinessEntity","description":"Business entity information in the Peppol network."},"Certificate":{"properties":{"status":{"type":"string","title":"Status","description":"Status of the certificate validation: 'success', 'error', or 'pending'","examples":["success"]},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details","description":"Details about the certificate including subject, issuer, validity dates, etc."},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error","description":"Error message if certificate validation failed","examples":["Certificate expired"]}},"type":"object","required":["status"],"title":"Certificate","description":"Certificate information for a Peppol endpoint."},"Charge-Input":{"properties":{"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason","description":"The reason for the charge"},"reason_code":{"anyOf":[{"$ref":"#/components/schemas/ChargeReasonCode"},{"type":"null"}],"description":"The code for the charge reason. "},"multiplier_factor":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"string"},{"type":"null"}],"title":"Multiplier Factor","description":"The percentage that may be used, in conjunction with the charge base amount, to calculate the charge amount. To state 20%, use value 20"},"amount":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Amount","description":"The charge amount, without VAT. Must be rounded to maximum 2 decimals"},"base_amount":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Base Amount","description":"The base amount that may be used, in conjunction with the charge percentage, to calculate the charge amount. Must be rounded to maximum 2 decimals"},"tax_rate":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"string"},{"type":"null"}],"title":"Tax Rate","description":"The VAT rate, represented as percentage that applies to the charge","default":21.0,"examples":["21.00","0.00","6.00"]},"tax_code":{"anyOf":[{"$ref":"#/components/schemas/TaxCategoryCode"},{"type":"null"}],"description":"The VAT category code that applies to the charge","default":"S"}},"type":"object","title":"Charge","description":"A charge is an additional fee for example for late payment, late delivery, etc."},"Charge-Output":{"properties":{"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason","description":"The reason for the charge"},"reason_code":{"anyOf":[{"$ref":"#/components/schemas/ChargeReasonCode"},{"type":"null"}],"description":"The code for the charge reason. "},"multiplier_factor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Multiplier Factor","description":"The percentage that may be used, in conjunction with the charge base amount, to calculate the charge amount. To state 20%, use value 20"},"amount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Amount","description":"The charge amount, without VAT. Must be rounded to maximum 2 decimals"},"base_amount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Base Amount","description":"The base amount that may be used, in conjunction with the charge percentage, to calculate the charge amount. Must be rounded to maximum 2 decimals"},"tax_rate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Rate","description":"The VAT rate, represented as percentage that applies to the charge","default":21.0,"examples":["21.00","0.00","6.00"]},"tax_code":{"anyOf":[{"$ref":"#/components/schemas/TaxCategoryCode"},{"type":"null"}],"description":"The VAT category code that applies to the charge","default":"S"}},"type":"object","title":"Charge","description":"A charge is an additional fee for example for late payment, late delivery, etc."},"ChargeBase":{"properties":{"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason","description":"The reason for the charge"},"reason_code":{"anyOf":[{"$ref":"#/components/schemas/ChargeReasonCode"},{"type":"null"}],"description":"The code for the charge reason. "},"multiplier_factor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Multiplier Factor","description":"The percentage that may be used, in conjunction with the charge base amount, to calculate the charge amount. To state 20%, use value 20"},"amount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Amount","description":"The charge amount, without VAT. Must be rounded to maximum 2 decimals"},"base_amount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Base Amount","description":"The base amount that may be used, in conjunction with the charge percentage, to calculate the charge amount. Must be rounded to maximum 2 decimals"},"tax_rate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Rate","description":"The VAT rate, represented as percentage that applies to the charge","default":21.0,"examples":["21.00","0.00","6.00"]},"tax_code":{"anyOf":[{"$ref":"#/components/schemas/TaxCategoryCode"},{"type":"null"}],"description":"The VAT category code that applies to the charge","default":"S"}},"type":"object","title":"ChargeBase"},"ChargeReasonCode":{"type":"string","enum":["AA","AAA","AAC","AAD","AAE","AAF","AAH","AAI","AAS","AAT","AAV","AAY","AAZ","ABA","ABB","ABC","ABD","ABF","ABK","ABL","ABN","ABR","ABS","ABT","ABU","ACF","ACG","ACH","ACI","ACJ","ACK","ACL","ACM","ACS","ADC","ADE","ADJ","ADK","ADL","ADM","ADN","ADO","ADP","ADQ","ADR","ADT","ADW","ADY","ADZ","AEA","AEB","AEC","AED","AEF","AEH","AEI","AEJ","AEK","AEL","AEM","AEN","AEO","AEP","AES","AET","AEU","AEV","AEW","AEX","AEY","AEZ","AJ","AU","CA","CAB","CAD","CAE","CAF","CAI","CAJ","CAK","CAL","CAM","CAN","CAO","CAP","CAQ","CAR","CAS","CAT","CAU","CAV","CAW","CAX","CAY","CAZ","CD","CG","CS","CT","DAB","DAC","DAD","DAF","DAG","DAH","DAI","DAJ","DAK","DAL","DAM","DAN","DAO","DAP","DAQ","DL","EG","EP","ER","FAA","FAB","FAC","FC","FH","FI","GAA","HAA","HD","HH","IAA","IAB","ID","IF","IR","IS","KO","L1","LA","LAA","LAB","LF","MAE","MI","ML","NAA","OA","PA","PAA","PC","PL","PRV","RAB","RAC","RAD","RAF","RE","RF","RH","RV","SA","SAA","SAD","SAE","SAI","SG","SH","SM","SU","TAB","TAC","TT","TV","V1","V2","WH","XAA","YY","ZZZ"],"title":"ChargeReasonCode","description":"Charge reason codes for invoice charges and fees"},"CurrencyCode":{"type":"string","enum":["EUR","USD","GBP","JPY","CHF","CAD","AUD","NZD","CNY","INR","SEK","NOK","DKK","SGD","HKD"],"title":"CurrencyCode"},"DnsInfo":{"properties":{"status":{"type":"string","title":"Status","description":"Status of the DNS lookup: 'success', 'error', or 'pending'","examples":["success"]},"smpHostname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Smphostname","description":"Hostname of the SMP (Service Metadata Publisher) discovered via DNS","examples":["smp.e-invoice.be"]},"smlHostname":{"type":"string","title":"Smlhostname","description":"Hostname of the SML used for the query","examples":["edelivery.tech.ec.europa.eu"]},"dnsRecords":{"items":{"$ref":"#/components/schemas/DnsRecord"},"type":"array","title":"Dnsrecords","description":"List of DNS records found for the Peppol participant"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error","description":"Error message if the DNS lookup failed","examples":["DNS lookup failed: no such domain"]},"lookupMethod":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lookupmethod","description":"DNS lookup method used: 'naptr' (new spec) or 'busdox' (legacy)","examples":["naptr"]}},"type":"object","required":["status","smlHostname","dnsRecords"],"title":"DnsInfo","description":"Information about the DNS lookup for the Peppol participant."},"DnsRecord":{"properties":{"ip":{"type":"string","title":"Ip","description":"IP address found in the DNS record","examples":["193.140.151.175"]}},"type":"object","required":["ip"],"title":"DnsRecord","description":"DNS record information for a Peppol participant."},"DocumentAttachment":{"properties":{"file_name":{"type":"string","title":"File Name"},"file_type":{"type":"string","title":"File Type","default":"application/pdf"},"file_size":{"type":"integer","title":"File Size","default":0},"id":{"type":"string","title":"Id"},"file_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Url"}},"type":"object","required":["file_name","id"],"title":"DocumentAttachment"},"DocumentAttachmentCreate":{"properties":{"file_name":{"type":"string","title":"File Name"},"file_type":{"type":"string","title":"File Type","default":"application/pdf"},"file_size":{"type":"integer","title":"File Size","default":0},"file_data":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Data","description":"Base64 encoded file data"}},"type":"object","required":["file_name"],"title":"DocumentAttachmentCreate"},"DocumentAttachmentDelete":{"properties":{"is_deleted":{"type":"boolean","title":"Is Deleted"}},"type":"object","required":["is_deleted"],"title":"DocumentAttachmentDelete"},"DocumentCreate":{"properties":{"document_type":{"$ref":"#/components/schemas/DocumentType","description":"The type of document: INVOICE, CREDIT_NOTE, or DEBIT_NOTE","default":"INVOICE"},"state":{"$ref":"#/components/schemas/DocumentState","description":"The current state of the document: DRAFT, TRANSIT, FAILED, SENT, or RECEIVED","default":"DRAFT"},"direction":{"$ref":"#/components/schemas/DocumentDirection","description":"The direction of the document: INBOUND (purchases) or OUTBOUND (sales)","default":"OUTBOUND"},"customer_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Name","description":"The company name of the customer/buyer"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id","description":"The unique identifier for the customer in your system"},"customer_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Email","description":"The email address of the customer"},"purchase_order":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Purchase Order","description":"The purchase order reference number"},"invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Id","description":"The unique invoice identifier/number"},"invoice_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Invoice Date","description":"The date when the invoice was issued"},"due_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due Date","description":"The date when payment is due"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Additional notes or comments for the invoice"},"vendor_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Name","description":"The name of the vendor/seller/supplier"},"vendor_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Email","description":"The email address of the vendor"},"vendor_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Address","description":"The address of the vendor/seller"},"vendor_address_recipient":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Address Recipient","description":"The recipient name at the vendor address"},"customer_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Address","description":"The address of the customer/buyer"},"customer_address_recipient":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Address Recipient","description":"The recipient name at the customer address"},"billing_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Address","description":"The billing address (if different from customer address)"},"billing_address_recipient":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Address Recipient","description":"The recipient name at the billing address"},"shipping_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Shipping Address","description":"The shipping/delivery address"},"shipping_address_recipient":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Shipping Address Recipient","description":"The recipient name at the shipping address"},"currency":{"$ref":"#/components/schemas/CurrencyCode","description":"Currency of the invoice (ISO 4217 currency code)","default":"EUR"},"tax_code":{"$ref":"#/components/schemas/TaxCategoryCode","description":"Tax category code of the invoice (e.g., S for standard rate, Z for zero rate, E for exempt)","default":"S"},"vatex":{"anyOf":[{"$ref":"#/components/schemas/VATExemptionCode"},{"type":"null"}],"description":"VAT exemption reason code (required when tax_code is E or other exempt categories)"},"vatex_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vatex Note","description":"Textual explanation for VAT exemption"},"subtotal":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Subtotal","description":"The taxable base of the invoice. Should be the sum of all line items - allowances (for example commercial discounts) + charges with impact on VAT. Must be positive and rounded to maximum 2 decimals"},"total_discount":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Total Discount","description":"The net financial discount/charge of the invoice (non-VAT charges minus non-VAT allowances). Can be positive (net charge), negative (net discount), or zero. Must be rounded to maximum 2 decimals"},"total_tax":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Total Tax","description":"The total tax amount of the invoice. Must be positive and rounded to maximum 2 decimals"},"invoice_total":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Invoice Total","description":"The total amount of the invoice including tax (invoice_total = subtotal + total_tax + total_discount). Must be positive and rounded to maximum 2 decimals"},"amount_due":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Amount Due","description":"The amount due for payment. Must be positive and rounded to maximum 2 decimals"},"previous_unpaid_balance":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Previous Unpaid Balance","description":"The previous unpaid balance from prior invoices, if any. Must be positive and rounded to maximum 2 decimals","hidden":true},"remittance_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remittance Address","description":"The address where payment should be sent or remitted to"},"remittance_address_recipient":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remittance Address Recipient","description":"The recipient name at the remittance address"},"service_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Service Address","description":"The address where services were performed or goods were delivered"},"service_address_recipient":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Service Address Recipient","description":"The recipient name at the service address"},"service_start_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Service Start Date","description":"The start date of the service period or delivery period"},"service_end_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Service End Date","description":"The end date of the service period or delivery period"},"vendor_tax_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Tax Id","description":"Vendor tax ID. For Belgium this is the VAT number. Must include the country prefix","examples":["BE1018265814"]},"vendor_company_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Company Id","description":"Vendor company ID. For Belgium this is the CBE number or their EUID (European Unique Identifier) number. In the Netherlands this is the KVK number.","examples":["1018265814"]},"customer_tax_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Tax Id","description":"Customer tax ID. For Belgium this is the VAT number. Must include the country prefix","examples":["BE1018265814"]},"customer_company_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Company Id","description":"Customer company ID. For Belgium this is the CBE number or their EUID (European Unique Identifier) number. In the Netherlands this is the KVK number.","examples":["1018265814"]},"customer_peppol_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Peppol Id","description":"Customer Peppol ID","examples":["0208:0123456789"]},"payment_term":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Term","description":"The payment terms (e.g., 'Net 30', 'Due on receipt', '2/10 Net 30')"},"payment_details":{"anyOf":[{"items":{"$ref":"#/components/schemas/PaymentDetailCreate"},"type":"array"},{"type":"null"}],"title":"Payment Details"},"tax_details":{"anyOf":[{"items":{"$ref":"#/components/schemas/TaxDetailCreate-Input"},"type":"array"},{"type":"null"}],"title":"Tax Details"},"items":{"items":{"$ref":"#/components/schemas/LineItemCreate-Input"},"type":"array","minItems":1,"title":"Items","description":"At least one line item is required"},"attachments":{"anyOf":[{"items":{"$ref":"#/components/schemas/DocumentAttachmentCreate"},"type":"array"},{"type":"null"}],"title":"Attachments"},"allowances":{"anyOf":[{"items":{"$ref":"#/components/schemas/Allowance-Input"},"type":"array"},{"type":"null"}],"title":"Allowances"},"charges":{"anyOf":[{"items":{"$ref":"#/components/schemas/Charge-Input"},"type":"array"},{"type":"null"}],"title":"Charges"}},"type":"object","title":"DocumentCreate"},"DocumentCreateFromPdf":{"properties":{"document_type":{"$ref":"#/components/schemas/DocumentType","description":"The type of document: INVOICE, CREDIT_NOTE, or DEBIT_NOTE","default":"INVOICE"},"state":{"$ref":"#/components/schemas/DocumentState","description":"The current state of the document: DRAFT, TRANSIT, FAILED, SENT, or RECEIVED","default":"DRAFT"},"direction":{"$ref":"#/components/schemas/DocumentDirection","description":"The direction of the document: INBOUND (purchases) or OUTBOUND (sales)","default":"OUTBOUND"},"customer_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Name","description":"The company name of the customer/buyer"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id","description":"The unique identifier for the customer in your system"},"customer_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Email","description":"The email address of the customer"},"purchase_order":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Purchase Order","description":"The purchase order reference number"},"invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Id","description":"The unique invoice identifier/number"},"invoice_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Invoice Date","description":"The date when the invoice was issued"},"due_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due Date","description":"The date when payment is due"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Additional notes or comments for the invoice"},"vendor_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Name","description":"The name of the vendor/seller/supplier"},"vendor_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Email","description":"The email address of the vendor"},"vendor_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Address","description":"The address of the vendor/seller"},"vendor_address_recipient":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Address Recipient","description":"The recipient name at the vendor address"},"customer_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Address","description":"The address of the customer/buyer"},"customer_address_recipient":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Address Recipient","description":"The recipient name at the customer address"},"billing_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Address","description":"The billing address (if different from customer address)"},"billing_address_recipient":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Address Recipient","description":"The recipient name at the billing address"},"shipping_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Shipping Address","description":"The shipping/delivery address"},"shipping_address_recipient":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Shipping Address Recipient","description":"The recipient name at the shipping address"},"currency":{"$ref":"#/components/schemas/CurrencyCode","description":"Currency of the invoice (ISO 4217 currency code)","default":"EUR"},"tax_code":{"$ref":"#/components/schemas/TaxCategoryCode","description":"Tax category code of the invoice (e.g., S for standard rate, Z for zero rate, E for exempt)","default":"S"},"vatex":{"anyOf":[{"$ref":"#/components/schemas/VATExemptionCode"},{"type":"null"}],"description":"VAT exemption reason code (required when tax_code is E or other exempt categories)"},"vatex_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vatex Note","description":"Textual explanation for VAT exemption"},"subtotal":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subtotal","description":"The taxable base of the invoice. Should be the sum of all line items - allowances (for example commercial discounts) + charges with impact on VAT. Must be positive and rounded to maximum 2 decimals"},"total_discount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Total Discount","description":"The net financial discount/charge of the invoice (non-VAT charges minus non-VAT allowances). Can be positive (net charge), negative (net discount), or zero. Must be rounded to maximum 2 decimals"},"total_tax":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Total Tax","description":"The total tax amount of the invoice. Must be positive and rounded to maximum 2 decimals"},"invoice_total":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Total","description":"The total amount of the invoice including tax (invoice_total = subtotal + total_tax + total_discount). Must be positive and rounded to maximum 2 decimals"},"amount_due":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Amount Due","description":"The amount due for payment. Must be positive and rounded to maximum 2 decimals"},"remittance_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remittance Address","description":"The address where payment should be sent or remitted to"},"remittance_address_recipient":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remittance Address Recipient","description":"The recipient name at the remittance address"},"service_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Service Address","description":"The address where services were performed or goods were delivered"},"service_address_recipient":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Service Address Recipient","description":"The recipient name at the service address"},"service_start_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Service Start Date","description":"The start date of the service period or delivery period"},"service_end_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Service End Date","description":"The end date of the service period or delivery period"},"vendor_tax_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Tax Id","description":"Vendor tax ID. For Belgium this is the VAT number. Must include the country prefix","examples":["BE1018265814"]},"vendor_company_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Company Id","description":"Vendor company ID. For Belgium this is the CBE number or their EUID (European Unique Identifier) number. In the Netherlands this is the KVK number.","examples":["1018265814"]},"customer_tax_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Tax Id","description":"Customer tax ID. For Belgium this is the VAT number. Must include the country prefix","examples":["BE1018265814"]},"customer_company_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Company Id","description":"Customer company ID. For Belgium this is the CBE number or their EUID (European Unique Identifier) number. In the Netherlands this is the KVK number.","examples":["1018265814"]},"customer_peppol_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Peppol Id","description":"Customer Peppol ID","examples":["0208:0123456789"]},"payment_term":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Term","description":"The payment terms (e.g., 'Net 30', 'Due on receipt', '2/10 Net 30')"},"payment_details":{"anyOf":[{"items":{"$ref":"#/components/schemas/PaymentDetailCreate"},"type":"array"},{"type":"null"}],"title":"Payment Details"},"tax_details":{"anyOf":[{"items":{"$ref":"#/components/schemas/TaxDetailCreate-Output"},"type":"array"},{"type":"null"}],"title":"Tax Details"},"items":{"items":{"$ref":"#/components/schemas/LineItemCreate-Output"},"type":"array","minItems":1,"title":"Items","description":"At least one line item is required"},"attachments":{"anyOf":[{"items":{"$ref":"#/components/schemas/DocumentAttachmentCreate"},"type":"array"},{"type":"null"}],"title":"Attachments"},"allowances":{"anyOf":[{"items":{"$ref":"#/components/schemas/Allowance-Output"},"type":"array"},{"type":"null"}],"title":"Allowances"},"charges":{"anyOf":[{"items":{"$ref":"#/components/schemas/Charge-Output"},"type":"array"},{"type":"null"}],"title":"Charges"},"success":{"type":"boolean","title":"Success","description":"Whether the PDF was successfully converted into a compliant e-invoice","default":true},"ubl_document":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ubl Document","description":"The UBL document as an XML string"}},"type":"object","title":"DocumentCreateFromPdf"},"DocumentCreateFromPdfTask":{"properties":{"task_id":{"type":"string","title":"Task Id","description":"The ID of the task that will process the PDF"},"status":{"$ref":"#/components/schemas/DocumentCreateFromPdfTaskStatus","description":"The status of the task","default":"pending"}},"type":"object","required":["task_id"],"title":"DocumentCreateFromPdfTask"},"DocumentCreateFromPdfTaskStatus":{"type":"string","enum":["pending","completed","failed"],"title":"DocumentCreateFromPdfTaskStatus"},"DocumentDelete":{"properties":{"is_deleted":{"type":"boolean","title":"Is Deleted"}},"type":"object","required":["is_deleted"],"title":"DocumentDelete"},"DocumentDirection":{"type":"string","enum":["INBOUND","OUTBOUND"],"title":"DocumentDirection"},"DocumentResponse":{"properties":{"document_type":{"$ref":"#/components/schemas/DocumentType","description":"The type of document: INVOICE, CREDIT_NOTE, or DEBIT_NOTE","default":"INVOICE"},"state":{"$ref":"#/components/schemas/DocumentState","description":"The current state of the document: DRAFT, TRANSIT, FAILED, SENT, or RECEIVED","default":"DRAFT"},"direction":{"$ref":"#/components/schemas/DocumentDirection","description":"The direction of the document: INBOUND (purchases) or OUTBOUND (sales)","default":"OUTBOUND"},"customer_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Name","description":"The company name of the customer/buyer"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id","description":"The unique identifier for the customer in your system"},"customer_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Email","description":"The email address of the customer"},"purchase_order":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Purchase Order","description":"The purchase order reference number"},"invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Id","description":"The unique invoice identifier/number"},"invoice_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Invoice Date","description":"The date when the invoice was issued"},"due_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due Date","description":"The date when payment is due"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Additional notes or comments for the invoice"},"vendor_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Name","description":"The name of the vendor/seller/supplier"},"vendor_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Email","description":"The email address of the vendor"},"vendor_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Address","description":"The address of the vendor/seller"},"vendor_address_recipient":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Address Recipient","description":"The recipient name at the vendor address"},"customer_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Address","description":"The address of the customer/buyer"},"customer_address_recipient":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Address Recipient","description":"The recipient name at the customer address"},"billing_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Address","description":"The billing address (if different from customer address)"},"billing_address_recipient":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Address Recipient","description":"The recipient name at the billing address"},"shipping_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Shipping Address","description":"The shipping/delivery address"},"shipping_address_recipient":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Shipping Address Recipient","description":"The recipient name at the shipping address"},"currency":{"$ref":"#/components/schemas/CurrencyCode","description":"Currency of the invoice (ISO 4217 currency code)","default":"EUR"},"tax_code":{"$ref":"#/components/schemas/TaxCategoryCode","description":"Tax category code of the invoice (e.g., S for standard rate, Z for zero rate, E for exempt)","default":"S"},"vatex":{"anyOf":[{"$ref":"#/components/schemas/VATExemptionCode"},{"type":"null"}],"description":"VAT exemption reason code (required when tax_code is E or other exempt categories)"},"vatex_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vatex Note","description":"Textual explanation for VAT exemption"},"subtotal":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subtotal","description":"The taxable base of the invoice. Should be the sum of all line items - allowances (for example commercial discounts) + charges with impact on VAT. Must be positive and rounded to maximum 2 decimals"},"total_discount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Total Discount","description":"The net financial discount/charge of the invoice (non-VAT charges minus non-VAT allowances). Can be positive (net charge), negative (net discount), or zero. Must be rounded to maximum 2 decimals"},"total_tax":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Total Tax","description":"The total tax amount of the invoice. Must be positive and rounded to maximum 2 decimals"},"invoice_total":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Total","description":"The total amount of the invoice including tax (invoice_total = subtotal + total_tax + total_discount). Must be positive and rounded to maximum 2 decimals"},"amount_due":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Amount Due","description":"The amount due for payment. Must be positive and rounded to maximum 2 decimals"},"remittance_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remittance Address","description":"The address where payment should be sent or remitted to"},"remittance_address_recipient":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Remittance Address Recipient","description":"The recipient name at the remittance address"},"service_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Service Address","description":"The address where services were performed or goods were delivered"},"service_address_recipient":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Service Address Recipient","description":"The recipient name at the service address"},"service_start_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Service Start Date","description":"The start date of the service period or delivery period"},"service_end_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Service End Date","description":"The end date of the service period or delivery period"},"vendor_tax_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Tax Id","description":"Vendor tax ID. For Belgium this is the VAT number. Must include the country prefix","examples":["BE1018265814"]},"vendor_company_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Company Id","description":"Vendor company ID. For Belgium this is the CBE number or their EUID (European Unique Identifier) number. In the Netherlands this is the KVK number.","examples":["1018265814"]},"customer_tax_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Tax Id","description":"Customer tax ID. For Belgium this is the VAT number. Must include the country prefix","examples":["BE1018265814"]},"customer_company_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Company Id","description":"Customer company ID. For Belgium this is the CBE number or their EUID (European Unique Identifier) number. In the Netherlands this is the KVK number.","examples":["1018265814"]},"customer_peppol_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Peppol Id","description":"Customer Peppol ID","examples":["0208:0123456789"]},"payment_term":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Term","description":"The payment terms (e.g., 'Net 30', 'Due on receipt', '2/10 Net 30')"},"id":{"type":"string","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"payment_details":{"anyOf":[{"items":{"$ref":"#/components/schemas/PaymentDetail"},"type":"array"},{"type":"null"}],"title":"Payment Details"},"tax_details":{"anyOf":[{"items":{"$ref":"#/components/schemas/TaxDetail"},"type":"array"},{"type":"null"}],"title":"Tax Details"},"items":{"anyOf":[{"items":{"$ref":"#/components/schemas/LineItem"},"type":"array"},{"type":"null"}],"title":"Items"},"attachments":{"anyOf":[{"items":{"$ref":"#/components/schemas/DocumentAttachment"},"type":"array"},{"type":"null"}],"title":"Attachments"},"allowances":{"anyOf":[{"items":{"$ref":"#/components/schemas/AllowanceBase"},"type":"array"},{"type":"null"}],"title":"Allowances"},"charges":{"anyOf":[{"items":{"$ref":"#/components/schemas/ChargeBase"},"type":"array"},{"type":"null"}],"title":"Charges"}},"type":"object","required":["id","created_at"],"title":"DocumentResponse"},"DocumentState":{"type":"string","enum":["DRAFT","TRANSIT","FAILED","SENT","RECEIVED"],"title":"DocumentState"},"DocumentTimeline":{"properties":{"document_id":{"type":"string","title":"Document Id"},"events":{"items":{"$ref":"#/components/schemas/TimelineEvent"},"type":"array","title":"Events"}},"type":"object","required":["document_id","events"],"title":"DocumentTimeline"},"DocumentType":{"type":"string","enum":["INVOICE","CREDIT_NOTE","DEBIT_NOTE","SELFBILLING_INVOICE","SELFBILLING_CREDIT_NOTE"],"title":"DocumentType"},"DocumentUBL":{"properties":{"file_name":{"type":"string","title":"File Name"},"file_size":{"type":"integer","title":"File Size","default":0},"signed_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Signed Url"},"sender_peppol_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sender Peppol Id"},"sender_peppol_scheme":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sender Peppol Scheme"},"receiver_peppol_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receiver Peppol Id"},"receiver_peppol_scheme":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receiver Peppol Scheme"},"file_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Hash"},"validated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Validated At"},"id":{"type":"string","title":"Id"}},"type":"object","required":["file_name","id"],"title":"DocumentUBL"},"Endpoint":{"properties":{"status":{"type":"string","title":"Status","description":"Status of the endpoint lookup: 'success', 'error', or 'pending'","examples":["success"]},"url":{"type":"string","title":"Url","description":"URL of the endpoint","examples":["https://ap.e-invoice.be/as4"]},"documentTypes":{"items":{"$ref":"#/components/schemas/SupportedDocumentType"},"type":"array","title":"Documenttypes","description":"List of document types supported by this endpoint"},"processes":{"anyOf":[{"items":{"$ref":"#/components/schemas/Process"},"type":"array"},{"type":"null"}],"title":"Processes","description":"List of processes supported by this endpoint"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error","description":"Error message if endpoint lookup failed","examples":["Connection timeout"]}},"type":"object","required":["status","url","documentTypes"],"title":"Endpoint","description":"Information about a Peppol participant's endpoint."},"ErrorResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"ErrorResponse","description":"Error response model."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"InboundEmailResponse":{"properties":{"id":{"type":"string","title":"Id"},"message_id":{"type":"string","title":"Message Id"},"sender_email":{"type":"string","title":"Sender Email"},"sender_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sender Name"},"to_addresses":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To Addresses"},"cc_addresses":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cc Addresses"},"bcc_addresses":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bcc Addresses"},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subject"},"attachments":{"items":{"$ref":"#/components/schemas/AttachmentInfo"},"type":"array","title":"Attachments","default":[]},"attachment_count":{"type":"integer","title":"Attachment Count","default":0},"processed":{"type":"boolean","title":"Processed","default":false},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Message"},"received_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Received At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"processed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Processed At"},"document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Id"}},"type":"object","required":["id","message_id","sender_email","created_at"],"title":"InboundEmailResponse"},"InboundEmailSortField":{"type":"string","enum":["received_at","created_at"],"title":"InboundEmailSortField"},"InboundEmailStatus":{"type":"string","enum":["pending","success","failed"],"title":"InboundEmailStatus"},"IssueType":{"type":"string","enum":["error","warning"],"title":"IssueType"},"LineItem":{"properties":{"amount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Amount","description":"The invoice line net amount (BT-131), exclusive of VAT, inclusive of line level allowances and charges. Calculated as: ((unit_price / price_base_quantity) * quantity) - allowances + charges. Must be rounded to maximum 2 decimals. Can be negative for credit notes or corrections."},"date":{"type":"null","title":"Date"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"The description of the line item."},"quantity":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quantity","description":"The quantity of items (goods or services) that is the subject of the line item. Must be rounded to maximum 4 decimals. Can be negative for credit notes or corrections."},"product_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product Code","description":"The product code of the line item."},"tax":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax","description":"The total VAT amount for the line item. Must be rounded to maximum 2 decimals. Can be negative for credit notes or corrections."},"tax_rate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Rate","description":"The VAT rate of the line item expressed as percentage with 2 decimals","default":0.0,"examples":["21.00","0.00","6.00"]},"unit":{"anyOf":[{"$ref":"#/components/schemas/UnitOfMeasureCode"},{"type":"null"}],"description":"The unit of measure of the line item."},"unit_price":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit Price","description":"The item net price (BT-146). The price of an item, exclusive of VAT, after subtracting item price discount. Must be rounded to maximum 4 decimals"},"allowances":{"anyOf":[{"items":{"$ref":"#/components/schemas/Allowance-Output"},"type":"array"},{"type":"null"}],"title":"Allowances","description":"The allowances of the line item."},"charges":{"anyOf":[{"items":{"$ref":"#/components/schemas/Charge-Output"},"type":"array"},{"type":"null"}],"title":"Charges","description":"The charges of the line item."}},"type":"object","title":"LineItem"},"LineItemCreate-Input":{"properties":{"amount":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Amount","description":"The invoice line net amount (BT-131), exclusive of VAT, inclusive of line level allowances and charges. Calculated as: ((unit_price / price_base_quantity) * quantity) - allowances + charges. Must be rounded to maximum 2 decimals. Can be negative for credit notes or corrections."},"date":{"type":"null","title":"Date"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"The description of the line item."},"quantity":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Quantity","description":"The quantity of items (goods or services) that is the subject of the line item. Must be rounded to maximum 4 decimals. Can be negative for credit notes or corrections."},"product_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product Code","description":"The product code of the line item."},"tax":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Tax","description":"The total VAT amount for the line item. Must be rounded to maximum 2 decimals. Can be negative for credit notes or corrections."},"tax_rate":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"string"},{"type":"null"}],"title":"Tax Rate","description":"The VAT rate of the line item expressed as percentage with 2 decimals","default":0.0,"examples":["21.00","0.00","6.00"]},"unit":{"anyOf":[{"$ref":"#/components/schemas/UnitOfMeasureCode"},{"type":"null"}],"description":"The unit of measure of the line item."},"unit_price":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Unit Price","description":"The item net price (BT-146). The price of an item, exclusive of VAT, after subtracting item price discount. Must be rounded to maximum 4 decimals"},"allowances":{"anyOf":[{"items":{"$ref":"#/components/schemas/Allowance-Input"},"type":"array"},{"type":"null"}],"title":"Allowances","description":"The allowances of the line item."},"charges":{"anyOf":[{"items":{"$ref":"#/components/schemas/Charge-Input"},"type":"array"},{"type":"null"}],"title":"Charges","description":"The charges of the line item."}},"type":"object","title":"LineItemCreate"},"LineItemCreate-Output":{"properties":{"amount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Amount","description":"The invoice line net amount (BT-131), exclusive of VAT, inclusive of line level allowances and charges. Calculated as: ((unit_price / price_base_quantity) * quantity) - allowances + charges. Must be rounded to maximum 2 decimals. Can be negative for credit notes or corrections."},"date":{"type":"null","title":"Date"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"The description of the line item."},"quantity":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quantity","description":"The quantity of items (goods or services) that is the subject of the line item. Must be rounded to maximum 4 decimals. Can be negative for credit notes or corrections."},"product_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Product Code","description":"The product code of the line item."},"tax":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax","description":"The total VAT amount for the line item. Must be rounded to maximum 2 decimals. Can be negative for credit notes or corrections."},"tax_rate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Rate","description":"The VAT rate of the line item expressed as percentage with 2 decimals","default":0.0,"examples":["21.00","0.00","6.00"]},"unit":{"anyOf":[{"$ref":"#/components/schemas/UnitOfMeasureCode"},{"type":"null"}],"description":"The unit of measure of the line item."},"unit_price":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit Price","description":"The item net price (BT-146). The price of an item, exclusive of VAT, after subtracting item price discount. Must be rounded to maximum 4 decimals"},"allowances":{"anyOf":[{"items":{"$ref":"#/components/schemas/Allowance-Output"},"type":"array"},{"type":"null"}],"title":"Allowances","description":"The allowances of the line item."},"charges":{"anyOf":[{"items":{"$ref":"#/components/schemas/Charge-Output"},"type":"array"},{"type":"null"}],"title":"Charges","description":"The charges of the line item."}},"type":"object","title":"LineItemCreate"},"PaginatedResponse_DocumentResponse_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/DocumentResponse"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"},"pages":{"type":"integer","title":"Pages"},"has_next_page":{"type":"boolean","title":"Has Next Page"}},"type":"object","required":["items","total","page","page_size","pages","has_next_page"],"title":"PaginatedResponse[DocumentResponse]"},"PaginatedResponse_InboundEmailResponse_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/InboundEmailResponse"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"},"pages":{"type":"integer","title":"Pages"},"has_next_page":{"type":"boolean","title":"Has Next Page"}},"type":"object","required":["items","total","page","page_size","pages","has_next_page"],"title":"PaginatedResponse[InboundEmailResponse]"},"PaymentDetail":{"properties":{"iban":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Iban","description":"International Bank Account Number for payment transfers"},"swift":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Swift","description":"SWIFT/BIC code of the bank"},"bank_account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Account Number","description":"Bank account number (for non-IBAN accounts)"},"payment_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Reference","description":"Structured payment reference or communication (e.g., structured communication for Belgian bank transfers)"}},"type":"object","title":"PaymentDetail"},"PaymentDetailCreate":{"properties":{"iban":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Iban","description":"International Bank Account Number for payment transfers"},"swift":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Swift","description":"SWIFT/BIC code of the bank"},"bank_account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Account Number","description":"Bank account number (for non-IBAN accounts)"},"payment_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Reference","description":"Structured payment reference or communication (e.g., structured communication for Belgian bank transfers)"}},"type":"object","title":"PaymentDetailCreate"},"PeppolDocumentType":{"properties":{"scheme":{"type":"string","title":"Scheme","description":"Document type scheme"},"value":{"type":"string","title":"Value","description":"Document type value"}},"type":"object","required":["scheme","value"],"title":"PeppolDocumentType","description":"Represents a supported document type"},"PeppolEntity":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Business entity name"},"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Code","description":"Country code"},"website":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website","description":"Website URL"},"geo_info":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Geo Info","description":"Geographic information"},"additional_info":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Additional Info","description":"Additional information"},"registration_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registration Date","description":"Registration date"},"identifiers":{"items":{"$ref":"#/components/schemas/PeppolIdentifier"},"type":"array","title":"Identifiers","description":"List of business identifiers"}},"type":"object","title":"PeppolEntity","description":"Represents a business entity"},"PeppolIdLookupResponse":{"properties":{"queryMetadata":{"$ref":"#/components/schemas/QueryMetadata","description":"Metadata about the query that was performed"},"status":{"type":"string","title":"Status","description":"Overall status of the lookup: 'success' or 'error'","examples":["success"]},"errors":{"items":{"type":"string"},"type":"array","title":"Errors","description":"List of error messages if any errors occurred during the lookup","examples":[["DNS lookup failed","Business card not available"]]},"dnsInfo":{"$ref":"#/components/schemas/DnsInfo","description":"Information about the DNS lookup performed"},"serviceMetadata":{"$ref":"#/components/schemas/ServiceMetadata","description":"Service metadata information for the Peppol participant"},"businessCard":{"$ref":"#/components/schemas/app__schemas__peppol_id__BusinessCard","description":"Business card information for the Peppol participant"},"certificates":{"items":{"$ref":"#/components/schemas/Certificate"},"type":"array","title":"Certificates","description":"List of certificates found for the Peppol participant"},"executionTimeMs":{"type":"number","title":"Executiontimems","description":"Total execution time of the lookup operation in milliseconds","examples":[895.32]}},"type":"object","required":["queryMetadata","status","errors","dnsInfo","serviceMetadata","businessCard","certificates","executionTimeMs"],"title":"PeppolIdLookupResponse","description":"Response from a Peppol ID lookup operation.\n\nThis model represents the complete result of validating and looking up a Peppol ID\nin the Peppol network, including DNS information, service metadata, business card\ndetails, and certificate information.\n\nExample:\n    A successful lookup for a Peppol ID \"0192:991825827\" would return DNS information,\n    service metadata with supported document types and processes, business card information\n    with organization details, and certificate data."},"PeppolIdValidationResponse":{"properties":{"is_valid":{"type":"boolean","title":"Is Valid","description":"Whether the Peppol ID is valid and registered in the Peppol network","example":true},"dns_valid":{"type":"boolean","title":"Dns Valid","description":"Whether the DNS resolves to a valid SMP","example":true},"business_card_valid":{"type":"boolean","title":"Business Card Valid","description":"Whether a business card is set at the SMP","example":true},"supported_document_types":{"items":{"type":"string"},"type":"array","title":"Supported Document Types"},"business_card":{"anyOf":[{"$ref":"#/components/schemas/app__schemas__validation__BusinessCard"},{"type":"null"}],"description":"Business card information for the Peppol ID","example":{"country_code":"BE","name":"Example Corporation Ltd","registration_date":"2021-06-15"}}},"type":"object","required":["is_valid","dns_valid","business_card_valid"],"title":"PeppolIdValidationResponse","description":"Response for a Peppol ID validation request.\n\nThis model represents the validation result of a Peppol ID in the Peppol network,\nincluding whether the ID is valid and what document types it supports."},"PeppolIdentifier":{"properties":{"scheme":{"type":"string","title":"Scheme","description":"Identifier scheme"},"value":{"type":"string","title":"Value","description":"Identifier value"}},"type":"object","required":["scheme","value"],"title":"PeppolIdentifier","description":"Represents a business identifier"},"PeppolParticipant":{"properties":{"peppol_id":{"type":"string","title":"Peppol Id","description":"Peppol ID of the participant"},"peppol_scheme":{"type":"string","title":"Peppol Scheme","description":"Peppol scheme of the participant"},"entities":{"items":{"$ref":"#/components/schemas/PeppolEntity"},"type":"array","title":"Entities","description":"List of business entities"},"document_types":{"items":{"$ref":"#/components/schemas/PeppolDocumentType"},"type":"array","title":"Document Types","description":"List of supported document types"}},"type":"object","required":["peppol_id","peppol_scheme"],"title":"PeppolParticipant","description":"Represents a Peppol participant with their details"},"PeppolSearchResult":{"properties":{"total_count":{"type":"integer","title":"Total Count","description":"Total number of results"},"used_count":{"type":"integer","title":"Used Count","description":"Number of results returned by the API"},"participants":{"items":{"$ref":"#/components/schemas/PeppolParticipant"},"type":"array","title":"Participants","description":"List of participants"},"query_terms":{"type":"string","title":"Query Terms","description":"Query terms used for search"},"search_date":{"type":"string","title":"Search Date","description":"Search date of the result"}},"type":"object","required":["total_count","used_count","query_terms","search_date"],"title":"PeppolSearchResult","description":"Represents the result of a Peppol directory search"},"Process":{"properties":{"processId":{"$ref":"#/components/schemas/ProcessIdentifier","description":"Identifier of the process"},"endpoints":{"items":{"$ref":"#/components/schemas/ProcessEndpoint"},"type":"array","title":"Endpoints","description":"List of endpoints supporting this process"}},"type":"object","required":["processId","endpoints"],"title":"Process","description":"Process information in the Peppol network."},"ProcessEndpoint":{"properties":{"transportProfile":{"type":"string","title":"Transportprofile","description":"Transport profile used by this endpoint","examples":["peppol-transport-as4-v2_0"]},"address":{"type":"string","title":"Address","description":"URL or address of the endpoint","examples":["https://ap.e-invoice.be/as4"]},"serviceActivationDate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Serviceactivationdate","description":"ISO 8601 date when the service was activated","examples":["2022-01-01T00:00:00Z"]},"serviceExpirationDate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Serviceexpirationdate","description":"ISO 8601 date when the service will expire","examples":["2025-01-01T00:00:00Z"]},"serviceDescription":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Servicedescription","description":"Human-readable description of the service","examples":["Company XYZ's AP service"]},"technicalContactUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Technicalcontacturl","description":"URL for technical contact information","examples":["https://support.e-invoice.be"]},"technicalInformationUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Technicalinformationurl","description":"URL for technical documentation","examples":["https://api.e-invoice.be"]},"certificate":{"anyOf":[{"$ref":"#/components/schemas/Certificate"},{"type":"null"}],"description":"Certificate information for this endpoint"}},"type":"object","required":["transportProfile","address"],"title":"ProcessEndpoint","description":"Endpoint information for a specific Peppol process."},"ProcessIdentifier":{"properties":{"scheme":{"type":"string","title":"Scheme","description":"Scheme of the process identifier","examples":["cenbii-procid-ubl"]},"value":{"type":"string","title":"Value","description":"Value of the process identifier","examples":["urn:fdc:peppol.eu:2017:poacc:billing:01:1.0"]}},"type":"object","required":["scheme","value"],"title":"ProcessIdentifier","description":"Process identifier in the Peppol network."},"QueryMetadata":{"properties":{"identifierScheme":{"type":"string","title":"Identifierscheme","description":"Scheme of the identifier, typically 'iso6523-actorid-upis'","examples":["iso6523-actorid-upis"]},"identifierValue":{"type":"string","title":"Identifiervalue","description":"The actual Peppol ID value being queried","examples":["0208:1018265814"]},"smlDomain":{"type":"string","title":"Smldomain","description":"Domain of the SML (Service Metadata Locator) used for the lookup","examples":["edelivery.tech.ec.europa.eu"]},"timestamp":{"type":"string","title":"Timestamp","description":"ISO 8601 timestamp of when the query was executed","examples":["2026-01-12T14:32:10.123456"]},"version":{"type":"string","title":"Version","description":"Version of the API used for the lookup","examples":["1.0.0"]}},"type":"object","required":["identifierScheme","identifierValue","smlDomain","timestamp","version"],"title":"QueryMetadata","description":"Metadata about the Peppol ID lookup query."},"ServiceMetadata":{"properties":{"status":{"type":"string","title":"Status","description":"Status of the service metadata lookup: 'success', 'error', or 'pending'","examples":["success"]},"queryTimeMs":{"type":"number","title":"Querytimems","description":"Time taken to query the service metadata in milliseconds","examples":[245.67]},"endpoints":{"items":{"$ref":"#/components/schemas/Endpoint"},"type":"array","title":"Endpoints","description":"List of endpoints found for the Peppol participant"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error","description":"Error message if service metadata lookup failed","examples":["Service unavailable"]}},"type":"object","required":["status","queryTimeMs","endpoints"],"title":"ServiceMetadata","description":"Service metadata information for a Peppol participant."},"SortField":{"type":"string","enum":["created_at","invoice_date","due_date","invoice_total","customer_name","vendor_name","invoice_id"],"title":"SortField","description":"Sort field options for document listing."},"SortOrder":{"type":"string","enum":["asc","desc"],"title":"SortOrder","description":"Sort order options."},"StatsAggregationType":{"type":"string","enum":["DAY","WEEK","MONTH"],"title":"StatsAggregationType"},"StatsResponse":{"properties":{"tenant_id":{"type":"string","title":"Tenant Id","description":"Tenant ID"},"period_start":{"type":"string","format":"date","title":"Period Start","description":"Start date of the period"},"period_end":{"type":"string","format":"date","title":"Period End","description":"End date of the period"},"aggregation":{"$ref":"#/components/schemas/StatsAggregationType","description":"Aggregation type used"},"actions":{"items":{"$ref":"#/components/schemas/ActionStats"},"type":"array","title":"Actions","description":"List of action statistics, one entry per aggregation period per action"},"total_days":{"type":"integer","minimum":1.0,"title":"Total Days","description":"Number of days in the period"},"average_daily_usage":{"type":"number","minimum":0.0,"title":"Average Daily Usage","description":"Average daily usage (total actions / total days)"},"budget_estimation_days":{"type":"number","minimum":0.0,"title":"Budget Estimation Days","description":"Estimated days until credits run out (credit_balance / average_daily_usage). 0.0 if average_daily_usage is 0 or credit_balance is None","default":0.0}},"type":"object","required":["tenant_id","period_start","period_end","aggregation","actions","total_days","average_daily_usage"],"title":"StatsResponse","description":"Statistics response for a tenant."},"SupportedDocumentType":{"properties":{"scheme":{"type":"string","title":"Scheme","description":"Scheme of the document type identifier","examples":["busdox-docid-qns"]},"value":{"type":"string","title":"Value","description":"Value of the document type identifier","examples":["urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0::2.1"]}},"type":"object","required":["scheme","value"],"title":"SupportedDocumentType","description":"Document type supported by a Peppol participant."},"TaxCategoryCode":{"type":"string","enum":["AE","E","S","Z","G","O","K","L","M","B"],"title":"TaxCategoryCode","description":"Duty or tax or fee category codes (Subset of UNCL5305)\n\nAgency: UN/CEFACT\nVersion: D.16B\nSubset: OpenPEPPOL"},"TaxDetail":{"properties":{"amount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Amount","description":"The tax amount for this tax category. Must be rounded to maximum 2 decimals"},"rate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rate","description":"The tax rate as a percentage (e.g., '21.00', '6.00', '0.00')"}},"type":"object","title":"TaxDetail"},"TaxDetailCreate-Input":{"properties":{"amount":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Amount","description":"The tax amount for this tax category. Must be rounded to maximum 2 decimals"},"rate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rate","description":"The tax rate as a percentage (e.g., '21.00', '6.00', '0.00')"}},"type":"object","title":"TaxDetailCreate"},"TaxDetailCreate-Output":{"properties":{"amount":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Amount","description":"The tax amount for this tax category. Must be rounded to maximum 2 decimals"},"rate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rate","description":"The tax rate as a percentage (e.g., '21.00', '6.00', '0.00')"}},"type":"object","title":"TaxDetailCreate"},"TenantPlan":{"type":"string","enum":["starter","pro","enterprise"],"title":"TenantPlan"},"TenantPublic":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"plan":{"$ref":"#/components/schemas/TenantPlan","description":"Plan of the tenant","default":"enterprise"},"credit_balance":{"type":"integer","title":"Credit Balance","description":"Credit balance of the tenant","default":999999999},"peppol_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Peppol Ids","description":"Peppol IDs of the tenant"},"ibans":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Ibans","description":"IBANs of the tenant"},"company_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Number","description":"Company number. For Belgium this is the CBE number or their EUID (European Unique Identifier) number","examples":["1018265814"]},"company_tax_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Tax Id","description":"Company tax ID. For Belgium this is the VAT number. Must include the country prefix","examples":["BE1018265814"]},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name","description":"Name of the company. Must include the company type. For example: `BV`, `NV`, `CVBA`, `VOF`","examples":["E-INVOICE BV"]},"company_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Address","description":"Address of the company. Must be in the form of `Street Name Street Number`","examples":["Brusselsesteenweg 119/A"]},"company_zip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Zip","description":"Zip code of the company","examples":["1980"]},"company_city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company City","description":"City of the company","examples":["Zemst"]},"company_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Country","description":"Country of the company","examples":["Belgium"]},"company_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Email","description":"Email of the company","examples":["info@e-invoice.be"]},"smp_registration":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Smp Registration","description":"Whether the tenant is registered on our SMP","default":false},"smp_registration_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Smp Registration Date","description":"Date when the tenant was registered on SMP"},"bcc_recipient_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bcc Recipient Email","description":"BCC recipient email to deliver documents"}},"type":"object","required":["name"],"title":"TenantPublic"},"TimelineEvent":{"properties":{"event_type":{"$ref":"#/components/schemas/TimelineEventType"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"details":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Details"}},"type":"object","required":["event_type","timestamp"],"title":"TimelineEvent"},"TimelineEventType":{"type":"string","enum":["email_received","email_processed","document_created","send_attempted","send_failed","send_success","receive_success","mlr_received","imr_received"],"title":"TimelineEventType"},"UBLDocumentValidationResponse":{"properties":{"id":{"type":"string","title":"Id"},"file_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Name"},"is_valid":{"type":"boolean","title":"Is Valid"},"issues":{"items":{"$ref":"#/components/schemas/ValidationIssue"},"type":"array","title":"Issues"},"ubl_document":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ubl Document"}},"type":"object","required":["id","file_name","is_valid","issues"],"title":"UBLDocumentValidationResponse"},"UnitOfMeasureCode":{"type":"string","enum":["10","11","13","14","15","20","21","22","23","24","25","27","28","33","34","35","37","38","40","41","56","57","58","59","60","61","74","77","80","81","85","87","89","91","1I","EA","E01","E07","E09","E10","E12","E14","E17","E20","E23","E25","E27","E31","E34","E35","E36","E37","E38","E39","E40","E41","E42","E43","E44","E45","E46","E47","E48","E49","E50","E51","E52","E53","E54","E55","E56","E57","E58","E60","E62","E65","E66","E67","E69","E70","E71","E73","E75","E76","2A","2B","2C","2G","2H","2I","2J","2K","2L","2M","2N","2P","2Q","2R","2U","2X","2Y","2Z","3B","3C","4C","4G","4H","4K","4L","4M","4N","4O","4P","4Q","4R","4T","4U","4W","4X","5A","5B","5E","5J","A10","A11","A12","A13","A14","A15","A16","A17","A18","A19","A2","A20","A21","A22","A23","A24","A26","A27","A28","A29","A3","A30","A31","A32","A33","A34","A35","A36","A37","A38","A39","A4","A40","A41","A42","A43","A44","A45","A46","A47","A48","A49","A5","A50","A51","A52","A53","A54","A55","A56","A57","A58","A59","A6","A60","A61","A62","A63","A64","A65","A66","A67","A68","A69","A7","A70","A71","A72","A73","A74","A75","A76","A77","A78","A79","A8","A80","A81","A82","A83","A84","A85","A86","A87","A88","A89","A9","A90","A91","A92","A93","A94","A95","A96","A97","A98","A99","ACR","AH","AI","AK","AMH","AMT","ANN","B1","B11","B12","B13","B14","B15","B16","B17","B18","B19","B20","B21","B22","B23","B24","B25","B26","B27","B28","B29","B3","B30","B31","B32","B33","B34","B35","B36","B37","B38","B39","B4","B40","B41","B42","B43","B44","B45","B46","B47","B48","B49","B5","B50","B52","B53","B54","B55","B56","B57","B58","B59","B6","B60","B61","B62","B63","B64","B65","B66","B67","B68","B69","B7","B70","B71","B72","B73","B74","B75","B76","B77","B78","B79","B8","B80","B81","B82","B83","B84","B85","B86","B87","B88","B89","B9","B90","B91","B92","B93","B94","B95","B96","B97","B98","B99","BAR","BB","BFT","BHP","BIL","BLD","BLL","BUA","BUI","C0","C10","C11","C12","C13","C14","C15","C16","C17","C18","C19","C20","C21","C22","C23","C24","C25","C26","C27","C28","C29","C30","C31","C32","C33","C34","C35","C36","C37","C38","C39","C40","C41","C42","C43","C44","C45","C46","C47","C48","C49","C50","C51","C52","C53","C54","C55","C56","C57","C58","C59","C60","C61","C63","C64","C65","C66","C67","C68","C69","C70","C71","C72","C73","C74","C75","C76","C77","C78","C79","C80","C81","C82","C83","C84","C85","C86","C87","C88","C89","C90","C91","C92","C93","C94","C95","C96","C97","C98","C99","CDL","CEL","CHU","CIU","CLT","CMK","CMQ","CMT","CNP","CNT","COU","CTG","CTN","CUR","CWA","CWI","DAN","DAY","DB","DD","DG","DI","DLT","DMK","DMQ","DMT","DPC","DPT","DRA","DZN","DZP","FOT","GLL","GLI","GRM","GRO","HUR","HTZ","INH","KGM","KMT","MTR","SMI","MIN","MON","ONZ","LBR","QT","SEC","FTK","INK","MTK","YDK","TNE","VLT","WTT","YRD","FTQ","INQ","MTQ","YDQ","HAR","KLT","MLT","MMT","KMK","MMK","XAA","XAB","XAC","XAD","XAE","XAF","XAG","XAH","XAI","XAJ","XAL","XAM","XAP","XAT","XAV","XB4","XBA","XBB","XBC","XBD","XBE","XBF","XBG","XBH","XBI","XBJ","XBK","XBL","XBM","XBN","XBO","XBP","XBQ","XBR","XBS","XBT","XBU","XBV","XBW","XBX","XBY","XBZ","XCA","XCB","XCC","XCD","XCE","XCF","XCG","XCH","XCI","XCJ","XCK","XCL","XCM","XCN","XCO","XCP","XCQ","XCR","XCS","XCT","XCU","XCV","XCW","XCX","XCY","XCZ","XDA","XDB","XDC","XDD","XDE","XDF","XDG","XDH","XDI","XDJ","XDK","XDL","XDM","XDN","XDP","XDQ","XDR","XDS","XDT","XDU","XDV","XDW","XDX","XDY","XDZ","XEA","XEB","XEC","XED","XEE","XEF","XEG","XEH","XEI","XEJ","XEK","XEL","XEM","XEN","XEP","XEQ","XER","XES","XET","XEU","XEV","XEW","XEX","XEY","XFB","XFC","XFD","XFE","XFF","XFG","XFH","XFI","XFJ","XFK","XFL","XFM","XFN","XFO","XFP","XFQ","XFR","XFS","XFT","XFU","XFV","XFW","XFX","XFY","XFZ","XGA","XGB","XGC","XGD","XGE","XGF","XGG","XGH","XGI","XGJ","XGK","XGL","XGM","XGN","XGO","XGP","XGQ","XGR","XGS","XGT","XGU","XGV","XGW","XGX","XGY","XGZ","XHA","XHB","XHC","XHD","XHE","XHF","XHG","XHH","XHI","XHJ","XHK","XHL","XHM","XHN","XHP","XHQ","XHR","XHS","XHT","XHU","XHV","XHW","XHX","XHY","XHZ","XIA","XIB","XIC","XID","XIE","XIF","XIG","XIH","XII","XIJ","XIK","XIL","XIM","XIN","XIO","XJA","XJB","XJC","XJD","XJE","XJF","XJG","XJH","XJI","XJJ","XJK","XJL","XJM","XJN","XJO","XJP","XJQ","XJR","XJS","XJT","XJU","XJV","XJW","XJX","XJY","XJZ","XLA","XLB","XLC","XLD","XLE","XLF","XLG","XLH","XLI","XLJ","XLK","XLL","XLM","XLN","XLO","XLP","XLQ","XLR","XLS","XLT","XLU","XLV","XLW","XLX","XLY","XLZ","XMA","XMB","XMC","XMD","XME","XMF","XMG","XMH","XMI","XMJ","XMK","XML","XMM","XMN","XMO","XMP","XMQ","XMR","XMS","XMT","XMU","XMV","XMW","XMX","XMY","XMZ","XNA","XNB","XNC","XND","XNE","XNF","XNG","XNH","XNI","XNJ","XNK","XNL","XNM","XOA","XOB","XOC","XOD","XOE","XOF","XOG","XOH","XOI","XOJ","XOK","XOL","XOM","XON","XOO","XOP","XOQ","XOR","XOS","XOT","XOU","XOV","XOW","XOX","XOY","XOZ","XP1","XP2","XP3","XP4","XPA","XPB","XPC","XPD","XPE","XPF","XPG","XPH","XPI","XPJ","XPK","XPL","XPM","XPN","XPO","XPP","XPQ","XPR","XPS","XPT","XPU","XPV","XPW","XPX","XPY","XPZ","XQA","XQB","XQC","XQD","XQE","XQF","XQG","XQH","XQI","XQJ","XQK","XQL","XQM","XQN","XQO","XQP","XQQ","XQR","XQS","XRD","XRE","XRF","XRG","XRH","XRI","XRJ","XRK","XRL","XRM","XRN","XRO","XRP","XRQ","XRR","XRS","XRT","XRU","XRV","XRW","XRX","XRY","XRZ","XSA","XSB","XSC","XSD","XSE","XSF","XSG","XSH","XSI","XSJ","XSK","XSL","XSM","XSN","XSO","XSP","XSQ","XSR","XSS","XST","XSU","XSV","XSW","XSX","XSY","XSZ","XTA","XTB","XTC","XTD","XTE","XTF","XTG","XTI","XTJ","XTK","XTL","XTM","XTN","XTO","XTR","XTS","XTT","XTU","XTV","XTW","XTX","XTY","XTZ","XUC","XUN","XVA","XVG","XVI","XVK","XVL","XVN","XVO","XVP","XVQ","XVR","XVS","XVY","XWA","XWB","XWC","XWD","XWF","XWG","XWH","XWJ","XWK","XWL","XWM","XWN","XWP","XWQ","XWR","XWS","XWT","XWU","XWV","XWW","XWX","XWY","XWZ","XXA","XXB","XXC","XXD","XXF","XXG","XXH","XXJ","XXK","XYA","XYB","XYC","XYD","XYF","XYG","XYH","XYJ","XYK","XYL","XYM","XYN","XYP","XYQ","XYR","XYS","XYT","XYV","XYW","XYX","XYY","XYZ","XZA","XZB","XZC","XZD","XZF","XZG","XZH","XZJ","XZK","XZL","XZM","XZN","XZP","XZQ","XZR","XZS","XZT","XZU","XZV","XZW","XZX","XZY","XZZ","ZZ","NAR","C62","LTR","H87"],"title":"UnitOfMeasureCode","description":"Unit of Measure Codes from UNECERec20 used in Peppol BIS Billing 3.0."},"VATExemptionCode":{"type":"string","enum":["VATEX-EU-79-C","VATEX-EU-132","VATEX-EU-132-1A","VATEX-EU-132-1B","VATEX-EU-132-1C","VATEX-EU-132-1D","VATEX-EU-132-1E","VATEX-EU-132-1F","VATEX-EU-132-1G","VATEX-EU-132-1H","VATEX-EU-132-1I","VATEX-EU-132-1J","VATEX-EU-132-1K","VATEX-EU-132-1L","VATEX-EU-132-1M","VATEX-EU-132-1N","VATEX-EU-132-1O","VATEX-EU-132-1P","VATEX-EU-132-1Q","VATEX-EU-143","VATEX-EU-143-1A","VATEX-EU-143-1B","VATEX-EU-143-1C","VATEX-EU-143-1D","VATEX-EU-143-1E","VATEX-EU-143-1F","VATEX-EU-143-1FA","VATEX-EU-143-1G","VATEX-EU-143-1H","VATEX-EU-143-1I","VATEX-EU-143-1J","VATEX-EU-143-1K","VATEX-EU-143-1L","VATEX-EU-144","VATEX-EU-146-1E","VATEX-EU-148","VATEX-EU-148-A","VATEX-EU-148-B","VATEX-EU-148-C","VATEX-EU-148-D","VATEX-EU-148-E","VATEX-EU-148-F","VATEX-EU-148-G","VATEX-EU-151","VATEX-EU-151-1A","VATEX-EU-151-1AA","VATEX-EU-151-1B","VATEX-EU-151-1C","VATEX-EU-151-1D","VATEX-EU-151-1E","VATEX-EU-159","VATEX-EU-309","VATEX-EU-AE","VATEX-EU-D","VATEX-EU-F","VATEX-EU-G","VATEX-EU-I","VATEX-EU-IC","VATEX-EU-O","VATEX-EU-J","VATEX-FR-FRANCHISE","VATEX-FR-CNWVAT"],"title":"VATExemptionCode","description":"VATEX code list for VAT exemption reasons\n\nAgency: CEF\nIdentifier: vatex"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"ValidationIssue":{"properties":{"message":{"type":"string","title":"Message"},"type":{"$ref":"#/components/schemas/IssueType"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location"},"rule_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule Id"},"flag":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Flag"},"test":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Test"},"schematron":{"type":"string","title":"Schematron"}},"type":"object","required":["message","type","schematron"],"title":"ValidationIssue"},"WebhookCreate":{"properties":{"events":{"items":{"type":"string"},"type":"array","title":"Events"},"url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Url"},"enabled":{"type":"boolean","title":"Enabled","default":true}},"type":"object","required":["events","url"],"title":"WebhookCreate","description":"Schema for creating a new webhook."},"WebhookDelete":{"properties":{"is_deleted":{"type":"boolean","title":"Is Deleted"}},"type":"object","required":["is_deleted"],"title":"WebhookDelete","description":"Model for webhook deletion."},"WebhookEventHistoryResponse":{"properties":{"history":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"History"}},"type":"object","required":["history"],"title":"WebhookEventHistoryResponse"},"WebhookResponse":{"properties":{"events":{"items":{"type":"string"},"type":"array","title":"Events"},"url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Url"},"enabled":{"type":"boolean","title":"Enabled","default":true},"id":{"type":"string","title":"Id"},"secret":{"type":"string","title":"Secret"}},"type":"object","required":["events","url","id","secret"],"title":"WebhookResponse","description":"Response model for webhook API endpoints."},"WebhookTestRequest":{"properties":{"event_type":{"type":"string","title":"Event Type","description":"Must be valid WebhookEventType"},"data":{"additionalProperties":true,"type":"object","title":"Data","description":"Custom event data payload"}},"type":"object","required":["event_type","data"],"title":"WebhookTestRequest","description":"Schema for webhook test request."},"WebhookTestResponse":{"properties":{"success":{"type":"boolean","title":"Success","description":"Whether the test completed successfully"},"message":{"type":"string","title":"Message","description":"Descriptive message about the test result"},"webhook_delivery_result":{"additionalProperties":true,"type":"object","title":"Webhook Delivery Result","description":"Result from process_webhook_task"}},"type":"object","required":["success","message","webhook_delivery_result"],"title":"WebhookTestResponse","description":"Schema for webhook test response."},"WebhookUpdate":{"properties":{"events":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Events"},"url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Url"},"enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enabled"}},"type":"object","title":"WebhookUpdate","description":"Schema for updating an existing webhook."},"app__schemas__peppol_id__BusinessCard":{"properties":{"status":{"type":"string","title":"Status","description":"Status of the business card lookup: 'success', 'error', or 'pending'","examples":["success"]},"entities":{"items":{"$ref":"#/components/schemas/BusinessEntity"},"type":"array","title":"Entities","description":"List of business entities associated with the Peppol ID"},"queryTimeMs":{"type":"number","title":"Querytimems","description":"Time taken to query the business card in milliseconds","examples":[123.45]},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error","description":"Error message if business card lookup failed","examples":["Business card not found"]}},"type":"object","required":["status","entities","queryTimeMs"],"title":"BusinessCard","description":"Business card information for a Peppol participant."},"app__schemas__validation__BusinessCard":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Code"},"registration_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Registration Date"}},"type":"object","title":"BusinessCard"}},"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer"}}}}