{"openapi":"3.0.0","paths":{"/api":{"get":{"operationId":"AppController_getData","parameters":[],"responses":{"200":{"description":""}},"tags":["App"]}},"/api/companies":{"post":{"operationId":"CompaniesController_create","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCompanyDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyResponseDto"}}}}},"tags":["Companies"]},"get":{"operationId":"CompaniesController_findAll","parameters":[{"name":"cursor","required":false,"in":"query","schema":{"$ref":"#/components/schemas/Object"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompaniesResponseDto"}}}}},"tags":["Companies"]}},"/api/companies/{id}":{"get":{"operationId":"CompaniesController_findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyResponseDto"}}}}},"tags":["Companies"]},"patch":{"operationId":"CompaniesController_update","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCompanyDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyResponseDto"}}}}},"tags":["Companies"]},"delete":{"operationId":"CompaniesController_remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCompanyResponseDto"}}}}},"tags":["Companies"]}},"/api/companies/{id}/technology-partners":{"get":{"operationId":"CompaniesController_getTechnologyPartners","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TechnologyPartnersResponseDto"}}}}},"tags":["Companies"]}},"/api/companies/{id}/managed-companies":{"get":{"operationId":"CompaniesController_getManagedCompanies","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagedCompaniesResponseDto"}}}}},"tags":["Companies"]}},"/api/company/{companyId}/departments":{"post":{"operationId":"DepartmentsController_create","parameters":[{"name":"companyId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDepartmentDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepartmentResponseDto"}}}}},"tags":["Departments"]},"get":{"operationId":"DepartmentsController_findByCompany","parameters":[{"name":"companyId","required":true,"in":"path","schema":{"type":"string"}},{"name":"cursor","required":false,"in":"query","schema":{"$ref":"#/components/schemas/Object"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepartmentsResponseDto"}}}}},"tags":["Departments"]}},"/api/company/{companyId}/departments/{id}":{"get":{"operationId":"DepartmentsController_findOne","parameters":[{"name":"companyId","required":true,"in":"path","schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepartmentResponseDto"}}}}},"tags":["Departments"]},"patch":{"operationId":"DepartmentsController_update","parameters":[{"name":"companyId","required":true,"in":"path","schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDepartmentDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepartmentResponseDto"}}}}},"tags":["Departments"]},"delete":{"operationId":"DepartmentsController_remove","parameters":[{"name":"companyId","required":true,"in":"path","schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteDepartmentResponseDto"}}}}},"tags":["Departments"]}},"/api/company/{companyId}/users/{id}":{"get":{"operationId":"UsersController_retrieveUser","parameters":[{"name":"companyId","required":true,"in":"path","schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResponseDto"}}}}},"tags":["Users"]},"patch":{"operationId":"UsersController_update","parameters":[{"name":"companyId","required":true,"in":"path","schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResponseDto"}}}}},"tags":["Users"]},"delete":{"operationId":"UsersController_remove","parameters":[{"name":"companyId","required":true,"in":"path","schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUserResponseDto"}}}}},"tags":["Users"]}},"/api/company/{companyId}/users":{"get":{"operationId":"UsersController_findByCompany","parameters":[{"name":"companyId","required":true,"in":"path","schema":{"type":"string"}},{"name":"cursor","required":false,"in":"query","schema":{"$ref":"#/components/schemas/Object"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsersResponseDto"}}}}},"tags":["Users"]},"post":{"operationId":"UsersController_create","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResponseDto"}}}}},"tags":["Users"]}},"/api/company/{companyId}/users/{id}/reset-password":{"post":{"operationId":"UsersController_resetPassword","parameters":[{"name":"companyId","required":true,"in":"path","schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetPasswordResponseDto"}}}}},"tags":["Users"]}},"/api/company/{companyId}/reports":{"post":{"operationId":"ReportsController_create","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReportDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportPresignedURLReponseDto"}}}}},"tags":["Reports"]}},"/api/company/{companyId}/reports/{id}":{"get":{"operationId":"ReportsController_findOne","parameters":[{"name":"companyId","required":true,"in":"path","schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportResponseDto"}}}}},"tags":["Reports"]},"delete":{"operationId":"ReportsController_remove","parameters":[{"name":"companyId","required":true,"in":"path","schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReportResponseDto"}}}}},"tags":["Reports"]}},"/api/company/{companyId}/reports/search":{"post":{"operationId":"ReportsController_search","parameters":[{"name":"companyId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchReportDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportSearchResponseDto"}}}}},"tags":["Reports"]}},"/api/company/{companyId}/reports/{id}/download-url":{"get":{"operationId":"ReportsController_getDownloadUrl","parameters":[{"name":"companyId","required":true,"in":"path","schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"string"}}}}},"tags":["Reports"]}},"/api/news-items":{"post":{"operationId":"NewsItemsController_create","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNewsItemDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewsItemResponseDto"}}}}},"tags":["NewsItems"]}},"/api/news-items/{id}":{"delete":{"operationId":"NewsItemsController_remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteNewsItemResponseDto"}}}}},"tags":["NewsItems"]}},"/api/usage/details":{"get":{"operationId":"UsageController_getUsageDetails","parameters":[{"name":"from","required":true,"in":"query","description":"Start date of the usage data to retrieve, expressed in UTC timezone (format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z')","schema":{"format":"date-time","type":"string"}},{"name":"until","required":true,"in":"query","description":"End date of the usage data to retrieve, expressed in UTC timezone (format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z')","schema":{"format":"date-time","type":"string"}},{"name":"departments","required":false,"in":"query","description":"Optional list of department IDs. When provided, only department-scoped usage data for those departments is returned. Company-level usage data is excluded.","schema":{"type":"array","items":{"type":"string"}}},{"name":"after","required":false,"in":"query","description":"Cursor for pagination. Indicates that the API should return the Usage details which are immediately after this one in the list (the next page)","schema":{"type":"string"}},{"name":"maxItems","required":false,"in":"query","description":"Maximum number (1 - 1000) of Usage details that might be returned. It is possible that the response contains fewer elements. Default to 100","schema":{"minimum":1,"maximum":1000,"default":100,"type":"number"}}],"responses":{"200":{"description":"Array of usage events","content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/UsageEventBaseDto"},{"$ref":"#/components/schemas/UsageEventPOMLinkDto"},{"$ref":"#/components/schemas/UsageEventPagesOCRDto"},{"$ref":"#/components/schemas/UsageEventPdfToUblConversionDto"}]}}}}}},"tags":["Usage"]}}},"info":{"title":"White Label Partner API","description":"Documentation for the White Label Partner (WLP) API","version":"1.0","contact":{}},"tags":[],"servers":[],"components":{"schemas":{"PhysicalAddressDto":{"type":"object","properties":{"street":{"type":"string"},"streetNr":{"type":"string"},"postalCode":{"type":"string"},"box":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string"},"addressAdditionalLine":{"type":"string"}},"required":["street","streetNr","postalCode","city","countryCode"]},"CompanyIdentifierDto":{"type":"object","properties":{"type":{"type":"string","enum":["ENTERPRISE_NUMBER","VAT_NUMBER","DUNS","GLN","LEITWEG_ID","CODE_ROUTAGE","SIRET_NUMBER","NIP","BANK_NAME","BIC","IBAN","KVK_NUMBER","OIN_NUMBER","CFI","PEC","CODDEST","CUU"]},"value":{"type":"string"}},"required":["type","value"]},"CreateCompanyDto":{"type":"object","properties":{"emailAddress":{"type":"string","format":"email"},"id":{"type":"string"},"erpId":{"type":"string"},"identificationNumber":{"type":"string"},"name":{"type":"string"},"headAddress":{"$ref":"#/components/schemas/PhysicalAddressDto"},"phoneNumber":{"type":"string"},"isActive":{"type":"boolean"},"lastModifiedBy":{"type":"string","default":"Partner.API"},"identifiers":{"type":"array","items":{"$ref":"#/components/schemas/CompanyIdentifierDto"}},"isTechnologyPartner":{"type":"boolean"}},"required":["erpId","name","headAddress","isActive","identifiers"]},"CompanyResponseDto":{"type":"object","properties":{"erpId":{"type":"string"},"identificationNumber":{"type":"string"},"name":{"type":"string"},"headAddress":{"$ref":"#/components/schemas/PhysicalAddressDto"},"emailAddress":{"type":"string"},"phoneNumber":{"type":"string"},"isActive":{"type":"boolean"},"id":{"type":"string"},"createdAt":{"type":"string"},"lastModifiedAt":{"type":"string"},"lastModifiedBy":{"type":"string"},"identifiers":{"type":"array","items":{"$ref":"#/components/schemas/CompanyIdentifierDto"}},"isTechnologyPartner":{"type":"boolean"}},"required":["erpId","name","headAddress","isActive","id","createdAt","lastModifiedAt","lastModifiedBy","identifiers"]},"Object":{"type":"object","properties":{}},"CompaniesResponseDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/CompanyResponseDto"}},"cursor":{"type":"string"}},"required":["items"]},"TechnologyPartnersResponseDto":{"type":"object","properties":{"companyId":{"type":"string"},"technologyPartnerCompanyIds":{"type":"array","items":{"type":"string"}}},"required":["companyId","technologyPartnerCompanyIds"]},"ManagedCompaniesResponseDto":{"type":"object","properties":{"companyId":{"type":"string"},"managedCompanyIds":{"type":"array","items":{"type":"string"}}},"required":["companyId","managedCompanyIds"]},"UpdateCompanyDto":{"type":"object","properties":{"emailAddress":{"type":"string","format":"email"},"id":{"type":"string"},"erpId":{"type":"string"},"identificationNumber":{"type":"string"},"name":{"type":"string"},"headAddress":{"$ref":"#/components/schemas/PhysicalAddressDto"},"phoneNumber":{"type":"string"},"isActive":{"type":"boolean"},"lastModifiedBy":{"type":"string","default":"Partner.API"},"identifiers":{"type":"array","items":{"$ref":"#/components/schemas/CompanyIdentifierDto"}},"isTechnologyPartner":{"type":"boolean"}}},"DeleteCompanyResponseDto":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]},"CreateDepartmentDto":{"type":"object","properties":{"emailAddress":{"type":"string","format":"email"},"id":{"type":"string"},"companyId":{"type":"string"},"erpId":{"type":"string"},"identificationNumber":{"type":"string"},"name":{"type":"string"},"headAddress":{"$ref":"#/components/schemas/PhysicalAddressDto"},"phoneNumber":{"type":"string"},"hasSeparateInvoicing":{"type":"boolean"},"isActive":{"type":"boolean"},"lastModifiedBy":{"type":"string","default":"Partner.API"}},"required":["companyId","erpId","name","headAddress","hasSeparateInvoicing","isActive"]},"DepartmentResponseDto":{"type":"object","properties":{"companyId":{"type":"string"},"erpId":{"type":"string"},"identificationNumber":{"type":"string"},"name":{"type":"string"},"headAddress":{"$ref":"#/components/schemas/PhysicalAddressDto"},"emailAddress":{"type":"string"},"phoneNumber":{"type":"string"},"hasSeparateInvoicing":{"type":"boolean"},"isActive":{"type":"boolean"},"id":{"type":"string"},"createdAt":{"type":"string"},"lastModifiedAt":{"type":"string"},"lastModifiedBy":{"type":"string"}},"required":["companyId","erpId","name","headAddress","hasSeparateInvoicing","isActive","id","createdAt","lastModifiedAt","lastModifiedBy"]},"DepartmentsResponseDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DepartmentResponseDto"}},"cursor":{"type":"string"}},"required":["items"]},"UpdateDepartmentDto":{"type":"object","properties":{"emailAddress":{"type":"string","format":"email"},"id":{"type":"string"},"companyId":{"type":"string"},"erpId":{"type":"string"},"identificationNumber":{"type":"string"},"name":{"type":"string"},"headAddress":{"$ref":"#/components/schemas/PhysicalAddressDto"},"phoneNumber":{"type":"string"},"hasSeparateInvoicing":{"type":"boolean"},"isActive":{"type":"boolean"},"lastModifiedBy":{"type":"string","default":"Partner.API"}}},"DeleteDepartmentResponseDto":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]},"UserResponseDto":{"type":"object","properties":{"companyId":{"type":"string"},"username":{"type":"string"},"role":{"enum":["CLIENT_VIEWER","CLIENT_OPERATOR","CLIENT_DEPARTMENT_ADMIN","CLIENT_ADMIN","SUPER_USER"],"type":"string"},"departments":{"type":"array","items":{"type":"string"}},"firstName":{"type":"string"},"lastName":{"type":"string"},"preferredLanguage":{"enum":["EN","NL","FR"],"type":"string"},"emailAddress":{"type":"string"},"hasMFALoginEnabled":{"type":"boolean"},"hasQERDSMandate":{"type":"boolean"},"modulesAccess":{"type":"array","items":{"type":"string","enum":["EASYPOST_CONNECT","EASYPOST_PORTAL","OMNI"]}},"createdAt":{"type":"string"},"lastModifiedAt":{"type":"string"},"lastModifiedBy":{"type":"string"},"enabled":{"type":"boolean"},"id":{"type":"string"}},"required":["companyId","username","role","departments","firstName","lastName","preferredLanguage","emailAddress","hasMFALoginEnabled","hasQERDSMandate","modulesAccess","createdAt","lastModifiedAt","lastModifiedBy","enabled","id"]},"UpdateUserDto":{"type":"object","properties":{"id":{"type":"string"},"companyId":{"type":"string"},"username":{"type":"string"},"role":{"enum":["CLIENT_VIEWER","CLIENT_OPERATOR","CLIENT_DEPARTMENT_ADMIN","CLIENT_ADMIN","SUPER_USER"],"type":"string"},"departments":{"type":"array","items":{"type":"string"}},"firstName":{"type":"string"},"lastName":{"type":"string"},"preferredLanguage":{"enum":["EN","NL","FR"],"type":"string"},"emailAddress":{"type":"string","format":"email"},"hasMFALoginEnabled":{"type":"boolean"},"hasQERDSMandate":{"type":"boolean"},"modulesAccess":{"type":"array","items":{"type":"string","enum":["EASYPOST_CONNECT","EASYPOST_PORTAL","OMNI"]}},"lastModifiedBy":{"type":"string"},"enabled":{"type":"boolean"}}},"UsersResponseDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserResponseDto"}},"cursor":{"type":"string"}},"required":["items"]},"CreateUserDto":{"type":"object","properties":{"id":{"type":"string"},"companyId":{"type":"string"},"username":{"type":"string"},"role":{"type":"string","enum":["CLIENT_VIEWER","CLIENT_OPERATOR","CLIENT_DEPARTMENT_ADMIN","CLIENT_ADMIN","SUPER_USER"]},"departments":{"type":"array","items":{"type":"string"}},"firstName":{"type":"string"},"lastName":{"type":"string"},"preferredLanguage":{"type":"string","enum":["EN","NL","FR"]},"emailAddress":{"type":"string","format":"email"},"hasMFALoginEnabled":{"type":"boolean"},"hasQERDSMandate":{"type":"boolean"},"modulesAccess":{"type":"array","items":{"type":"string","enum":["EASYPOST_CONNECT","EASYPOST_PORTAL","OMNI"]}},"lastModifiedBy":{"type":"string"},"enabled":{"type":"boolean"}},"required":["companyId","username","role","departments","firstName","lastName","preferredLanguage","emailAddress","hasMFALoginEnabled","hasQERDSMandate","modulesAccess","lastModifiedBy","enabled"]},"DeleteUserResponseDto":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]},"ResetPasswordResponseDto":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]},"CreateReportDto":{"type":"object","properties":{"companyId":{"type":"string"},"departmentId":{"type":"string"},"id":{"type":"string"},"reportType":{"type":"string","enum":["Distribution","CustomerInvoice"]},"date":{"type":"string"},"name":{"type":"string"},"filename":{"type":"string"},"lastModifiedBy":{"type":"string","default":"Partner.API"}},"required":["companyId","departmentId","reportType","date","name","filename"]},"ReportPresignedURLReponseDto":{"type":"object","properties":{"companyId":{"type":"string"},"id":{"type":"string"},"uploadUrl":{"type":"string"}},"required":["companyId","id","uploadUrl"]},"ReportResponseDto":{"type":"object","properties":{"companyId":{"type":"string"},"departmentId":{"type":"string"},"id":{"type":"string"},"reportType":{"type":"string","enum":["Distribution","CustomerInvoice"]},"name":{"type":"string"},"date":{"type":"string"},"createdAt":{"type":"string"},"lastModifiedAt":{"type":"string"},"lastModifiedBy":{"type":"string"}},"required":["companyId","departmentId","id","reportType","name","date","createdAt","lastModifiedAt","lastModifiedBy"]},"RangeDateDto":{"type":"object","properties":{"from":{"type":"string"},"until":{"type":"string"}},"required":["from","until"]},"PaginationDto":{"type":"object","properties":{"page":{"type":"number"},"pageSize":{"type":"number"}},"required":["page","pageSize"]},"SearchReportDto":{"type":"object","properties":{"name":{"type":"string"},"reportType":{"type":"string","enum":["Distribution","CustomerInvoice"]},"departments":{"type":"array","items":{"type":"string"}},"range":{"$ref":"#/components/schemas/RangeDateDto"},"pagination":{"$ref":"#/components/schemas/PaginationDto"}},"required":["range","pagination"]},"PaginationResponseDto":{"type":"object","properties":{"page":{"type":"number"},"pageItems":{"type":"number"},"totalItems":{"type":"number"}},"required":["page","pageItems","totalItems"]},"ReportSearchResponseDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ReportResponseDto"}},"pagination":{"$ref":"#/components/schemas/PaginationResponseDto"}},"required":["items","pagination"]},"DeleteReportResponseDto":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]},"MessageDto":{"type":"object","properties":{}},"CreateNewsItemDto":{"type":"object","properties":{"id":{"type":"string"},"communicationType":{"type":"string","enum":["WARNING","OK","NEUTRAL","ALERT"]},"startDate":{"type":"string"},"endDate":{"type":"string"},"message":{"$ref":"#/components/schemas/MessageDto"}},"required":["communicationType","startDate","message"]},"NewsItemResponseDto":{"type":"object","properties":{"id":{"type":"string"},"communicationType":{"type":"string","enum":["WARNING","OK","NEUTRAL","ALERT"]},"startDate":{"type":"string"},"endDate":{"type":"string"},"message":{"$ref":"#/components/schemas/MessageDto"}},"required":["communicationType","startDate","message"]},"DeleteNewsItemResponseDto":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]},"UsageEventBaseDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the Usage Event"},"usageType":{"enum":["USAGE_EMAIL_SENDING","USAGE_ERDS_SENDING","USAGE_QERDS_SENDING","USAGE_PEPPOL_INCOMING_DOCUMENT","USAGE_PEPPOL_OUTGOING_EVENT","USAGE_POM_LINK","USAGE_PONTO_ACCOUNT","USAGE_EBOX_ENTERPRISE_MESSAGE","USAGE_EBOX_CITIZEN_MESSAGE","USAGE_PAGES_OCR","USAGE_DOCCLE_DOCUMENT","USAGE_NOTIFICATION_EMAIL","USAGE_PRINT_SENDING","USAGE_PDF_TO_UBL_CONVERSION","USAGE_ESIGNING_DOCUMENT"],"type":"string","description":"Type of the Usage Event"},"timestamp":{"type":"string","description":"Timestamp of the Usage Event","format":"date-time"},"companyId":{"type":"string","description":"Unique identifier of the company associated with the usage event"},"department":{"type":"string","description":"Department associated with the usage event, if applicable"},"ttl":{"type":"number","description":"Time to live for the usage event record"}},"required":["id","usageType","timestamp","companyId","ttl"]},"UsageEventPOMLinkDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the Usage Event"},"usageType":{"enum":["USAGE_POM_LINK"],"type":"string","description":"Type of the Usage Event"},"timestamp":{"type":"string","description":"Timestamp of the Usage Event","format":"date-time"},"companyId":{"type":"string","description":"Unique identifier of the company associated with the usage event"},"department":{"type":"string","description":"Department associated with the usage event, if applicable"},"ttl":{"type":"number","description":"Time to live for the usage event record"},"paidDate":{"type":"string","description":"Date when the POM link was paid","format":"date-time"},"hasOptin":{"type":"boolean","description":"Whether the user has opted in"}},"required":["id","usageType","timestamp","companyId","ttl","paidDate","hasOptin"]},"UsageEventPagesOCRDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the Usage Event"},"usageType":{"enum":["USAGE_PAGES_OCR"],"type":"string","description":"Type of the Usage Event"},"timestamp":{"type":"string","description":"Timestamp of the Usage Event","format":"date-time"},"companyId":{"type":"string","description":"Unique identifier of the company associated with the usage event"},"department":{"type":"string","description":"Department associated with the usage event, if applicable"},"ttl":{"type":"number","description":"Time to live for the usage event record"},"jobId":{"type":"string","description":"Identifier of the job that processed the pages"},"amountOfPages":{"type":"number","description":"Number of pages processed by OCR"}},"required":["id","usageType","timestamp","companyId","ttl","jobId","amountOfPages"]},"UsageEventPdfToUblConversionDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the Usage Event"},"usageType":{"enum":["USAGE_PDF_TO_UBL_CONVERSION"],"type":"string","description":"Type of the Usage Event"},"timestamp":{"type":"string","description":"Timestamp of the Usage Event","format":"date-time"},"companyId":{"type":"string","description":"Unique identifier of the company associated with the usage event"},"department":{"type":"string","description":"Department associated with the usage event, if applicable"},"ttl":{"type":"number","description":"Time to live for the usage event record"},"inputTokens":{"type":"number","description":"Number of input tokens used in the conversion"},"outputTokens":{"type":"number","description":"Number of output tokens generated in the conversion"},"documentType":{"type":"string","description":"Type of document being converted"},"bedrockModel":{"type":"string","description":"Bedrock model used for the conversion"}},"required":["id","usageType","timestamp","companyId","ttl","inputTokens","outputTokens","documentType","bedrockModel"]}}}}