{"items":[{"type":"link","label":"Reconciliation API","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification","content":{"contentType":"overview","meta":{"name":"Reconciliation API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"reconciliation-api-specification.json","url":"/_bundle/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification.json?download"},{"kind":"download","label":"reconciliation-api-specification.yaml","url":"/_bundle/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://connect.booking.com","url":"https://connect.booking.com"},{"kind":"email","title":"Connectivity Team","email":"connectivity@booking.com","label":"connectivity@booking.com","withCopyButton":true,"copyContent":"connectivity@booking.com"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://payments-api.booking.com/","description":"Test using live endpoint"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Reconciliation API (1.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Generate and download financial reconciliation reports for your properties. Use the Reconciliation API to request payout reports for a specified date range and set of properties, check the report generation status, and retrieve the available filter and configuration options."}],"sectionId":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification"}],"sectionId":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification"}]}]}},{"type":"separator","label":"API Endpoints","content":null},{"type":"group","label":"Reconciliation reports","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/reconciliation-reports","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/reconciliation-reports","items":[{"label":"Generate a reconciliation report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/reconciliation-reports/generatereconreport","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/reconciliation-reports/generatereconreport","metadata":{"seo":{"title":"Generate a reconciliation report","description":"Initiates the asynchronous generation of a financial reconciliation report for one or more properties within a specified date range."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateReconReport","name":"Generate a reconciliation report","isWebhook":false,"pointer":"/paths/~1connectivity-payments~1recon-reports/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate a reconciliation report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiates the asynchronous generation of a financial reconciliation report for one or more properties within a specified date range."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The report is generated asynchronously. The response returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"request_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that you use to poll the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Report-status"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"report status endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"READY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EMPTY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When ready, a pre-signed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"download_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filename"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are returned for downloading the report. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"download_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is valid for approximately 15 minutes (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"download_url_expires_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). To obtain a new download URL after expiry, call this endpoint again to generate a new report. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EMPTY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", stop polling; no report is available for download."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Report-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"report filters endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve the available "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report_configurations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report_filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values before generating a report."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connection type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Reservations connection type is required to access this endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is rate-limited to 10 requests per minute."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Authorization","in":"header","schemaId":"schema_411","description":"Bearer token for authentication.","required":true,"example":"Bearer <your_token>"},{"name":"accept-version","in":"header","schemaId":"schema_412","description":"API version to use.","example":"1.0"}],"pointer":"/paths/~1connectivity-payments~1recon-reports/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReconReportRequest"}},"schemaId":"components/schemas/ReconReportRequest","pointer":"/paths/~1connectivity-payments~1recon-reports/post/requestBody","description":"Parameters for the reconciliation report to generate, including target properties, date range, output format, and optional filters."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/connectivity-payments/recon-reports","servers":[{"url":"/_mock/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://payments-api.booking.com/","description":"Test using live endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Authorization","in":"header","required":true,"example":"Bearer <your_token>","schemaId":"schema_411"},{"name":"accept-version","in":"header","required":false,"example":"1.0","schemaId":"schema_412"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ReconReportRequest"}},"responseCodes":["202","400","401","403","429","500"],"pointer":"/connectivity-payments/recon-reports","href":"reconciliation-reports/generatereconreport","openApiOperationId":"generateReconReport","summary":"Generate a reconciliation report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://payments-api.booking.com/","description":"Test using live endpoint"}],"schemaId":"components/schemas/ReconReportRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReconReportRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report generation request accepted. Use the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"request_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the report status endpoint to check progress and retrieve the download URL."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReconReportGenerationResponse"}},"schemaId":"components/schemas/ReconReportGenerationResponse"},{"code":"400","description":"Invalid request payload.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestErrorResponse"}},"schemaId":"components/schemas/BadRequestErrorResponse"},{"code":"401","description":"Unauthorized. Missing or invalid authentication token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidTokenResponse"}},"schemaId":"components/schemas/InvalidTokenResponse"},{"code":"403","description":"Access Denied!","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedRequestResponse"}},"schemaId":"components/schemas/UnauthorizedRequestResponse"},{"code":"429","description":"Too many requests. Rate limiting is enforced.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RateLimitErrorResponse"}},"schemaId":"components/schemas/RateLimitErrorResponse","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying.","schema":{"type":"integer","format":"int32","minimum":0}}},"headerSchemaId":"schema_413"},{"code":"500","description":"The request failed with an internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalServerErrorResponse"}},"schemaId":"components/schemas/InternalServerErrorResponse"}],"pointer":"/paths/~1connectivity-payments~1recon-reports/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/ReconReportGenerationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReconReportGenerationResponse"}}},{"code":"400","schemaId":"components/schemas/BadRequestErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestErrorResponse"}}},{"code":"401","schemaId":"components/schemas/InvalidTokenResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidTokenResponse"}}},{"code":"403","schemaId":"components/schemas/UnauthorizedRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedRequestResponse"}}},{"code":"429","schemaId":"components/schemas/RateLimitErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RateLimitErrorResponse"}}},{"code":"500","schemaId":"components/schemas/InternalServerErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalServerErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/connectivity-payments/recon-reports"}],"content":{"contentType":"group","meta":{"name":"Reconciliation reports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reconciliation reports","showPageActions":true},{"nodeType":"markdoc","content":"Generate financial reconciliation reports for one or more properties."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/connectivity-payments/recon-reports","summary":"Generate a reconciliation report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reconciliation-reports/generatereconreport","deprecated":false}]}]}]}]}},{"type":"group","label":"Report status","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/report-status","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/report-status","items":[{"label":"Retrieve report status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/report-status/getreconreportstatus","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/report-status/getreconreportstatus","metadata":{"seo":{"title":"Retrieve report status","description":"Retrieves the current processing status of a reconciliation report generation request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReconReportStatus","name":"Retrieve report status","isWebhook":false,"pointer":"/paths/~1connectivity-payments~1recon-reports~1{request-id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve report status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the current processing status of a reconciliation report generation request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Poll this endpoint after calling the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Reconciliation-reports"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"generate report endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"READY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EMPTY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When the report is ready, the response includes a pre-signed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"download_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filename"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The download URL is valid until "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"download_url_expires_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (approximately 15 minutes after generation). Download the report before it expires — to get a new download URL after expiry, call the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Reconciliation-reports"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"generate report endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" again. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EMPTY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", stop polling and submit a new report generation request if needed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connection type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Reservations connection type is required to access this endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is rate-limited to 10 requests per minute."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"request-id","in":"path","schemaId":"schema_411","description":"The unique identifier of the reconciliation report generation request, returned by the generate report endpoint.","required":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}],"pointer":"/paths/~1connectivity-payments~1recon-reports~1{request-id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Authorization","in":"header","schemaId":"schema_411","description":"Bearer token for authentication.","required":true,"example":"Bearer <your_token>"},{"name":"accept-version","in":"header","schemaId":"schema_412","description":"API version to use.","example":"1.0"}],"pointer":"/paths/~1connectivity-payments~1recon-reports~1{request-id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/connectivity-payments/recon-reports/{request-id}","servers":[{"url":"/_mock/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://payments-api.booking.com/","description":"Test using live endpoint"}],"parameters":{"path":[{"name":"request-id","in":"path","required":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","schemaId":"schema_411"}],"query":[],"querystring":[],"header":[{"name":"Authorization","in":"header","required":true,"example":"Bearer <your_token>","schemaId":"schema_411"},{"name":"accept-version","in":"header","required":false,"example":"1.0","schemaId":"schema_412"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/connectivity-payments/recon-reports/{request-id}","href":"report-status/getreconreportstatus","openApiOperationId":"getReconReportStatus","summary":"Retrieve report status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://payments-api.booking.com/","description":"Test using live endpoint"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Report status retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReconReportStatusResponse"}},"schemaId":"components/schemas/ReconReportStatusResponse"},{"code":"400","description":"Invalid request payload.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestErrorResponse"}},"schemaId":"components/schemas/BadRequestErrorResponse"},{"code":"401","description":"Unauthorized. Missing or invalid authentication token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidTokenResponse"}},"schemaId":"components/schemas/InvalidTokenResponse"},{"code":"403","description":"Access Denied!","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedRequestResponse"}},"schemaId":"components/schemas/UnauthorizedRequestResponse"},{"code":"404","description":"The requested report was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundErrorResponse"}},"schemaId":"components/schemas/NotFoundErrorResponse"},{"code":"429","description":"Too many requests. Rate limiting is enforced.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RateLimitErrorResponse"}},"schemaId":"components/schemas/RateLimitErrorResponse","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying.","schema":{"type":"integer","format":"int32","minimum":0}}},"headerSchemaId":"schema_413"},{"code":"500","description":"The request failed with an internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalServerErrorResponse"}},"schemaId":"components/schemas/InternalServerErrorResponse"}],"pointer":"/paths/~1connectivity-payments~1recon-reports~1{request-id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReconReportStatusResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReconReportStatusResponse"}}},{"code":"400","schemaId":"components/schemas/BadRequestErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestErrorResponse"}}},{"code":"401","schemaId":"components/schemas/InvalidTokenResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidTokenResponse"}}},{"code":"403","schemaId":"components/schemas/UnauthorizedRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedRequestResponse"}}},{"code":"404","schemaId":"components/schemas/NotFoundErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundErrorResponse"}}},{"code":"429","schemaId":"components/schemas/RateLimitErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RateLimitErrorResponse"}}},{"code":"500","schemaId":"components/schemas/InternalServerErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalServerErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/connectivity-payments/recon-reports/{request-id}"}],"content":{"contentType":"group","meta":{"name":"Report status"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report status","showPageActions":true},{"nodeType":"markdoc","content":"Check the processing status of a reconciliation report generation request and retrieve the download URL when the report is ready."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/connectivity-payments/recon-reports/{request-id}","summary":"Retrieve report status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/report-status/getreconreportstatus","deprecated":false}]}]}]}]}},{"type":"group","label":"Report filters","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/report-filters","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/report-filters","items":[{"label":"Retrieve report filters and configurations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/report-filters/getreconreportfilters","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/report-filters/getreconreportfilters","metadata":{"seo":{"title":"Retrieve report filters and configurations","description":"Retrieves the available filter and configuration options for generating reconciliation reports for a given legal entity. Use the returned values to populate report_configurations and report_filters in the generate report request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReconReportFilters","name":"Retrieve report filters and configurations","isWebhook":false,"pointer":"/paths/~1connectivity-payments~1recon-reports~1filters/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve report filters and configurations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the available filter and configuration options for generating reconciliation reports for a given legal entity. Use the returned values to populate "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report_configurations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report_filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Reconciliation-reports"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"generate report request"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response also includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_available_from_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which indicates the earliest date for which report data is available."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connection type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Reservations connection type is required to access this endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is rate-limited to 50 requests per minute."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"legal-entity-ids","in":"query","schemaId":"schema_414","description":"One or more legal entity IDs to retrieve filter options for.","required":true,"example":[1234567]}],"pointer":"/paths/~1connectivity-payments~1recon-reports~1filters/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Authorization","in":"header","schemaId":"schema_411","description":"Bearer token for authentication.","required":true,"example":"Bearer <your_token>"},{"name":"accept-version","in":"header","schemaId":"schema_412","description":"API version to use.","example":"1.0"}],"pointer":"/paths/~1connectivity-payments~1recon-reports~1filters/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/connectivity-payments/recon-reports/filters","servers":[{"url":"/_mock/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://payments-api.booking.com/","description":"Test using live endpoint"}],"parameters":{"path":[],"query":[{"name":"legal-entity-ids","in":"query","required":true,"example":[1234567],"schemaId":"schema_414","style":"form","explode":false}],"querystring":[],"header":[{"name":"Authorization","in":"header","required":true,"example":"Bearer <your_token>","schemaId":"schema_411"},{"name":"accept-version","in":"header","required":false,"example":"1.0","schemaId":"schema_412"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","429","500"],"pointer":"/connectivity-payments/recon-reports/filters","href":"report-filters/getreconreportfilters","openApiOperationId":"getReconReportFilters","summary":"Retrieve report filters and configurations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification","description":"Mock (schema only)","isMockServer":true},{"url":"https://payments-api.booking.com/","description":"Test using live endpoint"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Available report filters and configurations retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReconReportFiltersResponse"}},"schemaId":"components/schemas/ReconReportFiltersResponse"},{"code":"400","description":"Invalid request payload.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestErrorResponse"}},"schemaId":"components/schemas/BadRequestErrorResponse"},{"code":"401","description":"Unauthorized. Missing or invalid authentication token.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidTokenResponse"}},"schemaId":"components/schemas/InvalidTokenResponse"},{"code":"403","description":"Access Denied!","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedRequestResponse"}},"schemaId":"components/schemas/UnauthorizedRequestResponse"},{"code":"429","description":"Too many requests. Rate limiting is enforced.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RateLimitErrorResponse"}},"schemaId":"components/schemas/RateLimitErrorResponse","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying.","schema":{"type":"integer","format":"int32","minimum":0}}},"headerSchemaId":"schema_413"},{"code":"500","description":"The request failed with an internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalServerErrorResponse"}},"schemaId":"components/schemas/InternalServerErrorResponse"}],"pointer":"/paths/~1connectivity-payments~1recon-reports~1filters/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReconReportFiltersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReconReportFiltersResponse"}}},{"code":"400","schemaId":"components/schemas/BadRequestErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequestErrorResponse"}}},{"code":"401","schemaId":"components/schemas/InvalidTokenResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvalidTokenResponse"}}},{"code":"403","schemaId":"components/schemas/UnauthorizedRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedRequestResponse"}}},{"code":"429","schemaId":"components/schemas/RateLimitErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RateLimitErrorResponse"}}},{"code":"500","schemaId":"components/schemas/InternalServerErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InternalServerErrorResponse"}}}],"examples":[]}]}]}]},"httpPath":"/connectivity-payments/recon-reports/filters"}],"content":{"contentType":"group","meta":{"name":"Report filters"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report filters","showPageActions":true},{"nodeType":"markdoc","content":"Retrieve the available filter and configuration options for reconciliation report generation."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/connectivity-payments/recon-reports/filters","summary":"Retrieve report filters and configurations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/report-filters/getreconreportfilters","deprecated":false}]}]}]}]}},{"type":"separator","label":"Documentation","content":null},{"type":"group","label":"About Try it","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it","items":[{"type":"link","label":"Environment","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/environment","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/environment","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Environment"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"about-try-it/environment"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environment"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can select between two different environments (top right corner in the UI):"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mock (schema only) (default)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Helps to understand the response data schema"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recommended for all write operations (POST, PUT, PATCH, DELETE)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environment for testing without affecting live/test data"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Make sure to use only test properties as the requests hit the production endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Changes will affect your test property data"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires valid credentials"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Request","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/request","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/request","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Request"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"about-try-it/request"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click on any unresolved placeholders to add a value or edit an existing placeholder value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The portal loads the default request body. Where the specification supports multiple request body examples (for example: Rooms API POST endpoint), you can choose a different request body from the drop-down list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some helpful pointers before running a request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (when using production endpoint): Configure your authentication headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer token (JWT) as required. Use the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Make sure to manage separate machine accounts for test vs. properties in production."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ensure credentials match your selected environment."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Fill in required parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Path parameters (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"propertyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query parameters (like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"language_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST/PUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operations"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Execute"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to send the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request is sent to the selected environment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When sending requests to the production endpoint, a real HTTP request is made to the API"},"children":[]}]}]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Response","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/response","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/response","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Response"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"about-try-it/response"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Try it feature provides comprehensive response information to the extent supported by the OpenAPI specification:"},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Status code","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/status-code","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/status-code","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Status code"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/status-code"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status code"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2xx"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Success responses (200)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4xx"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Client errors (400 Bad Request, 401 Unauthorized, 404 Not Found)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5xx"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Server errors (500 Internal Server Error)"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Response body","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/response-body","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/response-body","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Response body"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/response-body"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response body"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON formatted response data"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the returned response, by default, is unformatted, select the supported Response body format in the UI."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Response headers","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/response-headers","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/response-headers","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Response headers"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/response-headers"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response headers"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content-Type, Content-Length."},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Environments","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/environments","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/environments","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Environments"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"about-try-it/environments"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environments"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab allows you to create variables specific to the environment. For example, you can add a variable to hold the value of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"propertyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" placeholder. The portal inserts the respective value depending on the environment at the time of sending the request."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Variables","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/variables","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/variables","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Variables"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/variables"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Variables"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most of the endpoints (especially POST/PUT/PATCH/DELETE) require you to add a path or query parameter before sending the request. Path parameters use single braces in the OpenAPI specification (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{propertyId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). The portal's Environments tab lets you store values for these parameters as reusable variables."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Path parameters","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/path-parameters","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/path-parameters","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Path parameters"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"about-try-it/path-parameters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Path parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Must be provided to make the request"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type validation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Ensures correct data types (integer, string, etc.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"propertyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/properties/{propertyId}/resource"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Query parameters","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/query-parameters","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/query-parameters","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Query parameters"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"about-try-it/query-parameters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Usually have default values"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"language_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-us"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the default value"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Request body","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/request-body","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/request-body","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Request body"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"about-try-it/request-body"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schema validation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Follows OpenAPI schema definitions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Prepopulated with sample values"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Best practices","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/best-practices","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/best-practices","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Best practices"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"about-try-it/best-practices"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Best practices"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This section provides some basic practice guidelines."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Authentication","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/authentication","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/authentication","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always use separate machine accounts for test properties vs. properties in production."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When testing with the production endpoint, make sure to use only test properties."},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"For Read operations (GET)","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/for-read-operations-(get)","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/for-read-operations-(get)","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"For Read operations (GET)"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/for-read-operations-(get)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Read operations (GET)"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET requests are non-mutating, but use authorised test properties when testing against the production endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use valid IDs that exist in your system"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check response structure for integration planning"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"For Write operations (POST, PUT, PATCH)","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/for-write-operations-(post-put-patch)","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/for-write-operations-(post-put-patch)","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"For Write operations (POST, PUT, PATCH)"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/for-write-operations-(post-put-patch)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Write operations (POST, PUT, PATCH)"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always use Mock (schema only) environment first"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify request payload structure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check response for success confirmation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Test error scenarios with invalid data"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"For Delete operations (DELETE)","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/for-delete-operations-(delete)","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/for-delete-operations-(delete)","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"For Delete operations (DELETE)"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/for-delete-operations-(delete)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Delete operations (DELETE)"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preferable to use Mock (schema only) environment only"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Understand the operation is irreversible"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Have backup data when testing using test properties"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Troubleshooting","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/troubleshooting","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/troubleshooting","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Troubleshooting"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"about-try-it/troubleshooting"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Troubleshooting"},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Common issues","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/common-issues","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/common-issues","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Common issues"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/common-issues"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common issues"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check authentication credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify token is valid and not expired"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ensure credentials match the selected environment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate request payload against schema"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check required fields are provided"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify data types match specification"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404 Not Found"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirm the resource ID exists"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check the endpoint URL is correct"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify you have access to the resource"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Getting help","link":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/getting-help","routeSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification/about-try-it/getting-help","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Getting help"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"about-try-it/getting-help"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting help"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you encounter issues:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check the response error message for details"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify your request matches the API specification"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact the Connectivity Team for support"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This documentation applies to all endpoints in the API. The Try it feature provides a consistent testing experience across all operations."},"children":[]}]}]}]}]}],"panels":[]}]}}],"content":{"contentType":"group","meta":{"name":"About Try it"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"About Try it","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn how to effectively use the Try it feature in the API documentation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Try it"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to send sample requests to API endpoints directly from the developer portal. In the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mock (schema only)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment, Try it returns schema-driven mock responses or pre-built example responses. In the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" environment, it sends the request to the live API and returns dynamic responses from your selected test property."},"children":[]}]}]}]}],"panels":[]}]}}],"store":{"schemaStore":{"components/schemas/DefaultMeta":{"id":"components/schemas/DefaultMeta","kind":"json-schema","title":"DefaultMeta","data":{"type":"object","description":"Metadata for the response","properties":{"ruid":{"type":"string","description":"Request unique identifier","example":"string"}}}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","description":"Error response containing details about the error","properties":{"description":{"type":"string","description":"Description of the error"},"message":{"type":"string","description":"Error message"},"status_code":{"type":"integer","format":"int32","description":"HTTP status code for the error"},"debug_message":{"type":"string","description":"Detailed debug message for the error"}}}},"components/schemas/Warning":{"id":"components/schemas/Warning","kind":"json-schema","title":"Warning","data":{"type":"object","description":"Warning information","properties":{"message":{"type":"string","description":"Warning message","example":"string"}}}},"components/schemas/PropertySelection":{"id":"components/schemas/PropertySelection","kind":"json-schema","title":"PropertySelection","data":{"type":"object","description":"A legal entity and its associated property IDs to include in the reconciliation report.","required":["legal_entity_id","property_ids"],"properties":{"legal_entity_id":{"type":"string","description":"The legal entity identifier.","example":"1234567"},"property_ids":{"type":"array","description":"List of property IDs belonging to the legal entity to include in the report.","items":{"type":"string"},"example":["123456"]}}}},"components/schemas/ReportConfigurationInput":{"id":"components/schemas/ReportConfigurationInput","kind":"json-schema","title":"ReportConfigurationInput","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single report configuration key-value pair. Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Report-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"report filters endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve available "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config_value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" options."},"children":[]}]}]}],"required":["config_key","config_value"],"properties":{"config_key":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The configuration key. Possible values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"format_type"},"config_value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The selected configuration value for the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CSV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"XLS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JSON"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"CSV"}}}},"components/schemas/ReportFilterInput":{"id":"components/schemas/ReportFilterInput","kind":"json-schema","title":"ReportFilterInput","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single report filter with one or more selected values. Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Report-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"report filters endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve available "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter_values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" options."},"children":[]}]}]}],"required":["filter_key","filter_values"],"properties":{"filter_key":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter key. Possible values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bank_accounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payout_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statement_descriptor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"bank_accounts"},"filter_values":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The selected filter values for the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string"},"example":["DE123456789"]}}}},"components/schemas/ReconReportRequest":{"id":"components/schemas/ReconReportRequest","kind":"json-schema","title":"ReconReportRequest","data":{"type":"object","description":"Request body for generating a reconciliation report.","required":["properties","from_date","to_date"],"properties":{"properties":{"type":"array","description":"List of legal entities and their associated property IDs to include in the report.","items":{"$ref":"#/components/schemas/PropertySelection"}},"from_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date of the reporting period (inclusive), in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"example":"2025-04-01"},"to_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date of the reporting period (inclusive), in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"example":"2025-08-01"},"report_configurations":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional list of report configuration options, such as output format and locale. Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Report-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"report filters endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve available options."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ReportConfigurationInput"}},"report_filters":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional list of filters to narrow down the report data, such as specific bank accounts or payout types. Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Report-filters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"report filters endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve available options."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ReportFilterInput"}}}}},"components/schemas/ReconReportGenerationData":{"id":"components/schemas/ReconReportGenerationData","kind":"json-schema","title":"ReconReportGenerationData","data":{"type":"object","description":"Data returned when a reconciliation report generation request is accepted.","properties":{"request_id":{"type":"string","description":"Unique identifier for the report generation request. Use this value to poll the report status endpoint.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"report_status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current status of the report generation. Possible values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GENERATING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"GENERATING"}}}},"components/schemas/ReconReportGenerationResponse":{"id":"components/schemas/ReconReportGenerationResponse","kind":"json-schema","title":"ReconReportGenerationResponse","data":{"type":"object","description":"Response returned when a reconciliation report generation request is accepted.","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/DefaultMeta"}]},"data":{"allOf":[{"$ref":"#/components/schemas/ReconReportGenerationData"}]},"errors":{"type":"array","maxItems":0,"items":{}},"warnings":{"type":"array","maxItems":0,"items":{}}}}},"components/schemas/ReconReportStatusData":{"id":"components/schemas/ReconReportStatusData","kind":"json-schema","title":"ReconReportStatusData","data":{"type":"object","description":"Status and download details for a reconciliation report generation request.","properties":{"request_id":{"type":"string","description":"Unique identifier of the report generation request.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current status of the report. Possible values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GENERATING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"READY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EMPTY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"READY"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp of the most recent status update, in ISO 8601 format.","example":"2026-06-10T08:50:48Z"},"download_url_expires_at":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp at which the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"download_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expires, in ISO 8601 format. Only present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"READY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Download the report before this time."},"children":[]}]}]}],"example":"2026-06-11T08:50:48Z"},"filename":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the generated report file. Only present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"READY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"reconciliation-report.csv"},"download_url":{"type":"string","format":"uri","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pre-signed URL for downloading the generated report. Only present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"READY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This URL is valid for approximately 15 minutes and expires at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"download_url_expires_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". To obtain a new download URL after expiry, call the generate report endpoint again."},"children":[]}]}]}],"example":"https://example.com/path"}}}},"components/schemas/ReconReportStatusResponse":{"id":"components/schemas/ReconReportStatusResponse","kind":"json-schema","title":"ReconReportStatusResponse","data":{"type":"object","description":"Response containing the current status of a reconciliation report generation request.","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/DefaultMeta"}]},"data":{"allOf":[{"$ref":"#/components/schemas/ReconReportStatusData"}]},"errors":{"type":"array","maxItems":0,"items":{}},"warnings":{"type":"array","maxItems":0,"items":{}}}}},"components/schemas/ReportConfigurationOption":{"id":"components/schemas/ReportConfigurationOption","kind":"json-schema","title":"ReportConfigurationOption","data":{"type":"object","description":"An available report configuration option with all supported values and the default.","properties":{"config_key":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The configuration key. Possible values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"format_type"},"config_values":{"type":"array","description":"All supported values for this configuration key.","items":{"type":"string"},"example":["XLS","CSV","JSON"]},"default_value":{"type":"string","description":"The default value applied when this configuration key is not specified in the report generation request.","example":"CSV"}}}},"components/schemas/ReportFilterOption":{"id":"components/schemas/ReportFilterOption","kind":"json-schema","title":"ReportFilterOption","data":{"type":"object","description":"An available report filter with all supported values.","properties":{"filter_key":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter key. Possible values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bank_accounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payout_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statement_descriptor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"bank_accounts"},"filter_values":{"type":"array","description":"All supported filter values for this filter key. An empty array indicates the filter is available but has no pre-defined values.","items":{"type":"string"}}}}},"components/schemas/ReconReportFiltersData":{"id":"components/schemas/ReconReportFiltersData","kind":"json-schema","title":"ReconReportFiltersData","data":{"type":"object","description":"Available filter and configuration options for reconciliation report generation.","properties":{"data_available_from_date":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The earliest date for which reconciliation report data is available, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format."},"children":[]}]}]}],"example":"2019-01-01"},"report_configurations":{"type":"array","description":"Available report configuration options, such as output format and locale.","items":{"$ref":"#/components/schemas/ReportConfigurationOption"}},"report_filters":{"type":"array","description":"Available report filters, such as bank accounts and payout types.","items":{"$ref":"#/components/schemas/ReportFilterOption"}}}}},"components/schemas/ReconReportFiltersResponse":{"id":"components/schemas/ReconReportFiltersResponse","kind":"json-schema","title":"ReconReportFiltersResponse","data":{"type":"object","description":"Response containing available filter and configuration options for reconciliation report generation.","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/DefaultMeta"}]},"data":{"allOf":[{"$ref":"#/components/schemas/ReconReportFiltersData"}]},"errors":{"type":"array","maxItems":0,"items":{}},"warnings":{"type":"array","maxItems":0,"items":{}}}}},"components/schemas/RateLimitErrorResponse":{"id":"components/schemas/RateLimitErrorResponse","kind":"json-schema","title":"RateLimitErrorResponse","data":{"type":"object","description":"Response when the rate limit has been exceeded","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/DefaultMeta"}]},"data":{"type":"object","description":"Data containing required information"},"errors":{"type":"array","description":"List of errors for the response","items":{"$ref":"#/components/schemas/Error"}},"warnings":{"type":"array","description":"List of warnings for the response","items":{"$ref":"#/components/schemas/Warning"}}}}},"components/schemas/BadRequestErrorResponse":{"id":"components/schemas/BadRequestErrorResponse","kind":"json-schema","title":"BadRequestErrorResponse","data":{"type":"object","description":"Response when the request doesn't have valid parameters","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/DefaultMeta"}]},"data":{"type":"object","description":"Data containing required information"},"errors":{"type":"array","description":"List of errors for the response","items":{"$ref":"#/components/schemas/Error"}},"warnings":{"type":"array","description":"List of warnings for the response","items":{"$ref":"#/components/schemas/Warning"}}}}},"components/schemas/InvalidTokenResponse":{"id":"components/schemas/InvalidTokenResponse","kind":"json-schema","title":"InvalidTokenResponse","data":{"type":"object","description":"Response when the authentication token is missing, invalid, or expired.","properties":{"meta":{"$ref":"#/components/schemas/DefaultMeta"},"warnings":{"type":"array","description":"List of warnings for the response","maxItems":0,"items":{}},"errors":{"type":"array","description":"List of errors for the response","items":{"type":"object","properties":{"message":{"type":"string","description":"Error message"},"code":{"type":"string","description":"Error code"},"details":{"type":"string","nullable":true,"description":"Additional error details"}}}}}}},"components/schemas/UnauthorizedRequestResponse":{"id":"components/schemas/UnauthorizedRequestResponse","kind":"json-schema","title":"UnauthorizedRequestResponse","data":{"type":"object","description":"Response when the token is valid but does not have access to the requested resource.","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/DefaultMeta"}]},"data":{"type":"object","description":"Data containing required information"},"errors":{"type":"array","description":"List of errors for the response","items":{"$ref":"#/components/schemas/Error"}},"warnings":{"type":"array","description":"List of warnings for the response","items":{"$ref":"#/components/schemas/Warning"}}}}},"components/schemas/NotFoundErrorResponse":{"id":"components/schemas/NotFoundErrorResponse","kind":"json-schema","title":"NotFoundErrorResponse","data":{"type":"object","description":"Response when the requested resource is not found","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/DefaultMeta"}]},"data":{"type":"object","description":"Data containing required information"},"errors":{"type":"array","description":"List of errors for the response","items":{"$ref":"#/components/schemas/Error"}},"warnings":{"type":"array","description":"List of warnings for the response","items":{"$ref":"#/components/schemas/Warning"}}}}},"components/schemas/InternalServerErrorResponse":{"id":"components/schemas/InternalServerErrorResponse","kind":"json-schema","title":"InternalServerErrorResponse","data":{"type":"object","description":"Response when the request failed with an internal reason","properties":{"meta":{"allOf":[{"$ref":"#/components/schemas/DefaultMeta"}]},"data":{"type":"object","description":"Data containing required information"},"errors":{"type":"array","description":"List of errors for the response","items":{"$ref":"#/components/schemas/Error"}},"warnings":{"type":"array","description":"List of warnings for the response","items":{"$ref":"#/components/schemas/Warning"}}}}},"schema_411":{"kind":"json-schema","data":{"type":"string"},"id":"schema_411"},"schema_412":{"kind":"json-schema","data":{"type":"string","default":"1.0"},"id":"schema_412"},"schema_413":{"kind":"json-schema","data":{"type":"object","properties":{"Retry-After":{"type":"integer","format":"int32","minimum":0,"description":"Number of seconds to wait before retrying."}}},"id":"schema_413"},"schema_414":{"kind":"json-schema","data":{"type":"array","items":{"type":"integer","format":"int64"}},"id":"schema_414"}},"exampleStore":{},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer","description":"Bearer token for authentication. Use your API credentials to obtain a token."}},"servers":[{"url":"/_mock/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification","isMockServer":true,"description":"Mock (schema only)"},{"url":"https://payments-api.booking.com/","description":"Test using live endpoint"}]},"options":{"feedback":{"hide":true,"settings":{"label":""}},"corsProxyUrl":"https://cors.redoc.ly","pagination":"section","hideSidebar":true,"mockServer":{"url":"/_mock/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification","position":"first","description":"Mock (schema only)","off":false},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification.json?download"},{"url":"/_bundle/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Reconciliation API","description":"Generate and download financial reconciliation reports for your properties. Use the Reconciliation API to request payout reports for a specified date range and set of properties, check the report generation status, and retrieve the available filter and configuration options."}},"baseSlug":"/connectivity/docs/openapispecs/reconciliation-api/reconciliation-api-specification","routesMapping":{}}