{"components":{"responses":{"4XX_Client_Error_Response":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorResponse"}}},"description":"error response for all http error codes in range 4XX"},"5XX_Server_Error_Response":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalErrorResponse"}}},"description":"error response for all http error codes in range 5XX"}},"schemas":{"CustomNotificationSecurityConfiguration":{"allOf":[{"$ref":"#/components/schemas/NotificationSecurityConfiguration"},{"properties":{"audience":{"description":"Must not be null.","type":"string"},"keyId":{"description":"Must not be null.","type":"string"},"scope":{"description":"Must not be null.","type":"string"},"subject":{"description":"Must not be null.","type":"string"},"tokenUrl":{"description":"Must not be null.","type":"string"}},"type":"object"}],"required":["audience","keyId","scope","subject","tokenUrl","type"],"type":"object"},"CustomNotificationSecurityUpdateRequest":{"allOf":[{"$ref":"#/components/schemas/NotificationSecurityUpdateRequest"},{"properties":{"audience":{"description":"Must not be empty.","minLength":1,"type":"string"},"keyId":{"description":"Must not be empty.","minLength":1,"type":"string"},"scope":{"description":"Must not be empty.","minLength":1,"type":"string"},"subject":{"description":"Must not be empty.","minLength":1,"type":"string"},"tokenUrl":{"description":"Must not be empty.","minLength":1,"type":"string"}},"type":"object"}],"required":["audience","keyId","scope","subject","tokenUrl"],"type":"object"},"GlobalErrorResponse":{"description":"error response providing details about the error occurred","properties":{"errors":{"description":"optional list of multiple errors occurred","items":{"type":"object"},"type":"array"},"message":{"description":"message describing the error","type":"string"},"path":{"description":"URL path where the error occurred","type":"string"},"status":{"description":"textual representation of http status code, e.g. 'BAD_REQUEST' for status code 400","type":"string"},"timestamp":{"description":"timestamp in UTC when the error occurred","format":"date-time","type":"string"},"uuid":{"description":"UUID generated by the server to identify the error occurred, should be stated in case of any inquiries","format":"uuid","type":"string"}},"type":"object"},"JsonNode":{"description":"The payload","nullable":true,"type":"object"},"NotificationAttemptResponse":{"properties":{"createdDateTime":{"format":"date-time","type":"string"},"ident":{"type":"string"},"responseBody":{"type":"string"},"statusCode":{"format":"int32","type":"integer"}},"type":"object"},"NotificationResponse":{"properties":{"attempts":{"items":{"$ref":"#/components/schemas/NotificationAttemptResponse"},"type":"array"},"createdDateTime":{"format":"date-time","type":"string"},"ident":{"type":"string"},"payloadIdent":{"type":"string"},"requestBody":{"type":"string"},"status":{"enum":["FAILED","SUCCESS","PENDING"],"type":"string"},"type":{"enum":["ADDRESS_CREATED","ADDRESS_UPDATED","BASWARE_WORKFLOW_UPDATED","CLOSING_COMPLETED","CONTRACT_CREATED","CONTRACT_CANCELLED","CONTRACT_RENEWED","CONTRACT_TERMINATED","CONTRACT_UPDATED","CONTRACT_EXPIRED","CUSTOMER_CREATED","CUSTOMER_UPDATED","DOCUMENT_ARCHIVED","DOCUMENT_ATTACHMENT_ARCHIVED","DOCUMENT_CREATED","DUNNING_ISSUED","DUNNING_STATUS_AGGREGATION_UPDATED","DUNNING_ARCHIVED","E_INVOICING_WORKFLOW_UPDATED","INVOICE_UPDATED","ORDER_CANCELLED","ORDER_CREATED","ORDER_UPDATED","PAYMENT_ASSIGNMENT_PROCESSED","PAYMENT_ASSIGNMENT_PROCESSED_BEFORE_SETTLEMENT","PAYMENT_ASSIGNMENT_REVERSED","PAYMENT_ASSIGNMENT_REVERSED_BEFORE_SETTLEMENT","PAYMENT_INTENT_RESULT","PAYMENT_TRANSACTION_CREATED","OPOS_CASE_DECISION","OPOS_CASE_DECISION_REVERSION","OPOS_CASE_UPDATED","SETTLEMENT_CREATED","REPORT_CREATED","VAT_ID_CHECKED","AUTHENTICATION_VERIFICATION"],"type":"string"},"updatedDateTime":{"format":"date-time","type":"string"}},"type":"object"},"NotificationRouteDto":{"properties":{"notificationType":{"description":"Must not be null.","enum":["ADDRESS_CREATED","ADDRESS_UPDATED","BASWARE_WORKFLOW_UPDATED","CLOSING_COMPLETED","CONTRACT_CREATED","CONTRACT_CANCELLED","CONTRACT_RENEWED","CONTRACT_TERMINATED","CONTRACT_UPDATED","CONTRACT_EXPIRED","CUSTOMER_CREATED","CUSTOMER_UPDATED","DOCUMENT_ARCHIVED","DOCUMENT_ATTACHMENT_ARCHIVED","DOCUMENT_CREATED","DUNNING_ISSUED","DUNNING_STATUS_AGGREGATION_UPDATED","DUNNING_ARCHIVED","E_INVOICING_WORKFLOW_UPDATED","INVOICE_UPDATED","ORDER_CANCELLED","ORDER_CREATED","ORDER_UPDATED","PAYMENT_ASSIGNMENT_PROCESSED","PAYMENT_ASSIGNMENT_PROCESSED_BEFORE_SETTLEMENT","PAYMENT_ASSIGNMENT_REVERSED","PAYMENT_ASSIGNMENT_REVERSED_BEFORE_SETTLEMENT","PAYMENT_INTENT_RESULT","PAYMENT_TRANSACTION_CREATED","OPOS_CASE_DECISION","OPOS_CASE_DECISION_REVERSION","OPOS_CASE_UPDATED","SETTLEMENT_CREATED","REPORT_CREATED","VAT_ID_CHECKED","AUTHENTICATION_VERIFICATION"],"type":"string"},"url":{"description":"Must not be null.","format":"url","type":"string"}},"required":["notificationType","url"],"type":"object"},"NotificationSecurityConfiguration":{"discriminator":{"propertyName":"type"},"properties":{"type":{"description":"Must not be null.","enum":["OAUTH","NONE","CUSTOM"],"type":"string"}},"required":["type"],"type":"object"},"NotificationSecurityUpdateRequest":{"discriminator":{"propertyName":"type"},"properties":{"type":{"type":"string"}},"required":["type"],"type":"object"},"OauthNotificationSecurityConfiguration":{"allOf":[{"$ref":"#/components/schemas/NotificationSecurityConfiguration"},{"properties":{"scope":{"type":"string"},"tokenUrl":{"description":"Must not be null.","type":"string"}},"type":"object"}],"required":["tokenUrl","type"],"type":"object"},"OauthNotificationSecurityUpdateRequest":{"allOf":[{"$ref":"#/components/schemas/NotificationSecurityUpdateRequest"},{"properties":{"clientId":{"description":"Must not be empty.","minLength":1,"type":"string"},"clientSecret":{"description":"Must not be empty.","minLength":1,"type":"string"},"scope":{"type":"string"},"tokenUrl":{"description":"Must not be empty.","minLength":1,"type":"string"}},"type":"object"}],"required":["clientId","clientSecret","tokenUrl"],"type":"object"},"OutboxEntryResponse":{"description":"Result list.","properties":{"createdAt":{"description":"Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).","example":"2024-03-08T15:34:00Z","format":"date-time","type":"string"},"deleteAt":{"description":"The delete timestamp","format":"date-time","nullable":true,"type":"string"},"failures":{"description":"Number of failures","format":"int32","type":"integer"},"id":{"description":"The ID of the outbox entry","type":"string"},"ident":{"description":"The ident of the outbox entry. An entry does not necessarily require an ident. It serves as a convenience feature only.","nullable":true,"type":"string"},"lastFailureMessage":{"description":"Last failure message","nullable":true,"type":"string"},"nextRetryAt":{"description":"The next retry timestamp","format":"date-time","nullable":true,"type":"string"},"payload":{"$ref":"#/components/schemas/JsonNode"},"status":{"description":"The status of the outbox entry","enum":["ENQUEUED","PROCESSING","WAITING","PROCESSED","FAILED"],"nullable":true,"type":"string"},"statusHistory":{"description":"The status history","items":{"$ref":"#/components/schemas/StatusHistory"},"type":"array"},"statusTimestamp":{"description":"The timestamp of the last status change","format":"date-time","type":"string"},"tracingAttributes":{"additionalProperties":{"description":"Tracing attributes","type":"string"},"description":"Tracing attributes","type":"object"}},"required":["createdAt","failures","id","statusHistory","statusTimestamp","tracingAttributes"],"type":"object"},"OutboxQueryParams":{"properties":{"createdFrom":{"description":"Start timestamp (inclusive) for filtering by the creation time of the outbox entry.","format":"date-time","nullable":true,"type":"string"},"createdTo":{"description":"End timestamp (inclusive) for filtering by the creation time of the outbox entry.","format":"date-time","nullable":true,"type":"string"},"from":{"description":"Start timestamp (inclusive) for filtering outbox entries based on the status timestamp.","format":"date-time","nullable":true,"type":"string"},"to":{"description":"End timestamp (inclusive) for filtering outbox entries based on the status timestamp.","format":"date-time","nullable":true,"type":"string"}},"type":"object"},"PageInfo":{"description":"Meta data about the current page and query.","properties":{"number":{"description":"Page number of total pages available.","format":"int32","type":"integer"},"size":{"description":"Size of the page as specified by the query.","format":"int32","type":"integer"},"totalElements":{"description":"Total count of all elements available for the query.","format":"int64","type":"integer"},"totalPages":{"description":"Total count of all pages available for the query.","format":"int32","type":"integer"}},"type":"object"},"PagedResponseNotificationResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/NotificationResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseNotificationRouteDto":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/NotificationRouteDto"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseNotificationType":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"description":"Result list.","enum":["ADDRESS_CREATED","ADDRESS_UPDATED","BASWARE_WORKFLOW_UPDATED","CLOSING_COMPLETED","CONTRACT_CREATED","CONTRACT_CANCELLED","CONTRACT_RENEWED","CONTRACT_TERMINATED","CONTRACT_UPDATED","CONTRACT_EXPIRED","CUSTOMER_CREATED","CUSTOMER_UPDATED","DOCUMENT_ARCHIVED","DOCUMENT_ATTACHMENT_ARCHIVED","DOCUMENT_CREATED","DUNNING_ISSUED","DUNNING_STATUS_AGGREGATION_UPDATED","DUNNING_ARCHIVED","E_INVOICING_WORKFLOW_UPDATED","INVOICE_UPDATED","ORDER_CANCELLED","ORDER_CREATED","ORDER_UPDATED","PAYMENT_ASSIGNMENT_PROCESSED","PAYMENT_ASSIGNMENT_PROCESSED_BEFORE_SETTLEMENT","PAYMENT_ASSIGNMENT_REVERSED","PAYMENT_ASSIGNMENT_REVERSED_BEFORE_SETTLEMENT","PAYMENT_INTENT_RESULT","PAYMENT_TRANSACTION_CREATED","OPOS_CASE_DECISION","OPOS_CASE_DECISION_REVERSION","OPOS_CASE_UPDATED","SETTLEMENT_CREATED","REPORT_CREATED","VAT_ID_CHECKED","AUTHENTICATION_VERIFICATION"],"type":"string"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"PagedResponseOutboxEntryResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.","items":{"$ref":"#/components/schemas/OutboxEntryResponse"},"type":"array"},"page":{"$ref":"#/components/schemas/PageInfo"}},"type":"object"},"StatusHistory":{"description":"The status history","properties":{"status":{"description":"The status","enum":["ENQUEUED","PROCESSING","WAITING","PROCESSED","FAILED"],"type":"string"},"timestamp":{"description":"The timestamp when the status occurred","format":"date-time","type":"string"}},"required":["status","timestamp"],"type":"object"},"VerifyResponse":{"description":"Response of the security setup verification endpoint","properties":{"ident":{"description":"Unique identifier of the generated verification notification","example":"123e4567-e89b-12d3-a456-426614174000","type":"string"}},"type":"object"}},"securitySchemes":{"oauth2":{"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://api.nbx-stage-westeurope.nitrobox.io/<tenant_short>/oauth2/token"}},"type":"oauth2"}}},"info":{"description":"API Description for tenant notification via webhooks","title":"Notification API","version":"v2-preview-2.51.0"},"openapi":"3.0.1","paths":{"/v2/notification/configuration/routes":{"get":{"description":"Get routes from notification configuration for tenant.","operationId":"get","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseNotificationRouteDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"summary":"Get Routes","tags":["Notification Configuration"]},"post":{"description":"Add a new routes to the notification configuration for tenant.","operationId":"add","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationRouteDto"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationRouteDto"}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"summary":"Add Notification Route Configuration","tags":["Notification Configuration"]},"put":{"description":"Update the routes for an of the notification configuration for tenant.","operationId":"update","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationRouteDto"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationRouteDto"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"summary":"Update Route for Notification Configuration","tags":["Notification Configuration"]}},"/v2/notification/configuration/routes/types":{"get":{"description":"Get available notification types for notification configuration.","operationId":"getNotificationsTypes","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseNotificationType"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"summary":"Get NotificationTypes","tags":["Notification Configuration"]}},"/v2/notification/configuration/routes/{routes}":{"delete":{"description":"Delete routes from notification configuration for tenant.","operationId":"delete","parameters":[{"description":"Notification type that triggers notification.\nMust not be null.","in":"path","name":"routes","required":true,"schema":{"enum":["ADDRESS_CREATED","ADDRESS_UPDATED","BASWARE_WORKFLOW_UPDATED","CLOSING_COMPLETED","CONTRACT_CREATED","CONTRACT_CANCELLED","CONTRACT_RENEWED","CONTRACT_TERMINATED","CONTRACT_UPDATED","CONTRACT_EXPIRED","CUSTOMER_CREATED","CUSTOMER_UPDATED","DOCUMENT_ARCHIVED","DOCUMENT_ATTACHMENT_ARCHIVED","DOCUMENT_CREATED","DUNNING_ISSUED","DUNNING_STATUS_AGGREGATION_UPDATED","DUNNING_ARCHIVED","E_INVOICING_WORKFLOW_UPDATED","INVOICE_UPDATED","ORDER_CANCELLED","ORDER_CREATED","ORDER_UPDATED","PAYMENT_ASSIGNMENT_PROCESSED","PAYMENT_ASSIGNMENT_PROCESSED_BEFORE_SETTLEMENT","PAYMENT_ASSIGNMENT_REVERSED","PAYMENT_ASSIGNMENT_REVERSED_BEFORE_SETTLEMENT","PAYMENT_INTENT_RESULT","PAYMENT_TRANSACTION_CREATED","OPOS_CASE_DECISION","OPOS_CASE_DECISION_REVERSION","OPOS_CASE_UPDATED","SETTLEMENT_CREATED","REPORT_CREATED","VAT_ID_CHECKED","AUTHENTICATION_VERIFICATION"],"type":"string"}}],"responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"summary":"Delete Notification Route","tags":["Notification Configuration"]}},"/v2/notification/configuration/security":{"delete":{"description":"Delete notification configuration for tenant.","operationId":"delete_1","responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"summary":"Delete Notification Configuration","tags":["Notification Configuration"]},"get":{"description":"Get security of notification configuration for tenant.","operationId":"get_1","responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CustomNotificationSecurityConfiguration"},{"$ref":"#/components/schemas/OauthNotificationSecurityConfiguration"}]}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"summary":"Get Notification Security Configuration","tags":["Notification Configuration"]},"post":{"description":"Create security of notification configuration for tenant.","operationId":"create","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CustomNotificationSecurityUpdateRequest"},{"$ref":"#/components/schemas/OauthNotificationSecurityUpdateRequest"}]}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CustomNotificationSecurityConfiguration"},{"$ref":"#/components/schemas/OauthNotificationSecurityConfiguration"}]}}},"description":"The request has been fulfilled, resulting in the creation of a new resource."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"summary":"Create Notification Security Configuration","tags":["Notification Configuration"]},"put":{"description":"Update security of notification configuration for tenant.","operationId":"update_1","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CustomNotificationSecurityUpdateRequest"},{"$ref":"#/components/schemas/OauthNotificationSecurityUpdateRequest"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/CustomNotificationSecurityConfiguration"},{"$ref":"#/components/schemas/OauthNotificationSecurityConfiguration"}]}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"summary":"Update Notification Security Configuration","tags":["Notification Configuration"]}},"/v2/notification/configuration/security/verify":{"post":{"description":"Trigger a dummy authentication verification notification for the tenant without creating business data.","operationId":"verify","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"summary":"Verify Notification Security Configuration","tags":["Notification Configuration"]}},"/v2/notifications":{"get":{"description":"Get a paged result of all notifications. To reduce the result set, please use the RSQL query.","operationId":"queryNotifications","parameters":[{"description":"Use RSQL query language. Intro here: https://aboullaite.me/rsql/.\n","example":"eventType==(CUSTOMER_CREATED,CUSTOMER_UPDATED)","in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Default is 0.","in":"query","name":"page","schema":{"default":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100, default is 20.","in":"query","name":"size","schema":{"default":20,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.\nIf sorting direction is not provided, default direction is 'desc'.\nDefault sorting criteria: 'createdDateTime'.","in":"query","name":"sort","schema":{"default":["createdDateTime"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResponseNotificationResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"summary":"Query notifications","tags":["Notifications"]}},"/v2/notifications/actions/resend":{"post":{"description":"Resend the 100 oldest failed notifications.","operationId":"resendFailed","responses":{"204":{"description":"The server successfully processed the request, and is not returning any content."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"summary":"Resend notifications","tags":["Notifications"]}},"/v2/notifications/{ident}":{"get":{"description":"Retrieve a notification by ident.","operationId":"retrieveNotification","parameters":[{"description":"The ident of the notification to retrieve.","in":"path","name":"ident","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"summary":"Retrieve notification","tags":["Notifications"]}},"/v2/notifications/{ident}/actions/resend":{"post":{"description":"Resend a notification.","operationId":"resendNotification","parameters":[{"description":"The ident of the notification to resend.","in":"path","name":"ident","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"$ref":"#/components/responses/4XX_Client_Error_Response"},"5XX":{"$ref":"#/components/responses/5XX_Server_Error_Response"}},"summary":"Resend notification","tags":["Notifications"]}}},"security":[{"oauth2":[]}],"servers":[{"description":"Instellix Stage","url":"https://api.nbx-stage-westeurope.nitrobox.io"}],"x-readme":{"explorer-enabled":false,"proxy-enabled":true}}