export interface paths { "/v1/settlements/{uid}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get settlement by uid * @description Intentions should be sorted in descended order by creation timestamp. */ get: operations["getSettlement"]; /** @description Update settlement */ put: operations["updateSettlement"]; post?: never; /** * Delete settlement * @description A settlement that has received bank intentions or mortgage documents cannot be deleted unless the query parameter 'forced' is set to true. */ delete: operations["deleteSettlement"]; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/documents/{uid}/resend": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * Resend document to broker * @description Resend a previously sent document */ put: operations["resendDocument"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/settlements": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Find settlements by buyer identification number and/or property key * @description * # Find settlement where you (as a bank) are registered as financial source * Query parameter 'isFinancialSource=true' is required * Query parameter 'from'=yyyy-MM-ddTHH:mm:ss.SSS us used to only get settlements created after the given data * * # Find settlement by buyer * Query parameter 'buyerIdentificationNumber' (one of the buyers' personal number) is required * Query parameter 'propertyKey' can (optionally) be used to filter on a specific property. * Property key example format: Cadastre: '4601-12-321-0-0' (knr-gnr-bnr-fnr-snr), Cooperative share/aksje/obligasjon: '952780905-125' * */ get: operations["findSettlements"]; put?: never; /** @description Create settlement */ post: operations["createSettlement"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/settlements/{uid}/signedbuyercontracts": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** @description Add a signed purchase contract to given settlement */ post: operations["addSignedPurchaseContract"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/purchasecontractrequests": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Request a purchase contract * @description * Relevent events for purchase contract requests: * 'PURCHASE_CONTRACT_REQUEST_SENT', * 'PURCHASE_CONTRACT_RESPONSE_RECEIVED', * 'PURCHASE_CONTRACT_CHANGED', * */ post: operations["createPurchaseContractRequest"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/purchasecontractrequests/{requestuid}/{settlementuid}/intention": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Set bank intention for the specified settlement. * @description Set bank intention for the specified settlement. */ post: operations["setBankIntention"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/documents": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Get all pantedokumenter with given statuses that logged in user has access to */ get: operations["getListOfDocuments"]; put?: never; /** * Save document * @description Save document using b64 encoding */ post: operations["saveDocument"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/documents/{uid}/details": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** @description Set information from tinglysing */ post: operations["saveTinglysingInformation"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/bankintentions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** @description As a bank, send your intended registration method or 'flow' to the broker. * At least one of the buyers and one of the real estates that you provide must match the ones in the given broker's * settlement data in their system. * * For Ambita broker's you will recive a response code of 201 if the provided data matches a settlement or a * response code of 400 otherwise. * * For non-Ambita broker's you will recive a response code of 202 and the broker's response will be available * when you receive the event 'INTENTION_RESPONSE_RECEIVED'. An event code of 'EPS_EV0001' signals a successful match * with the broker. * * For both successful cases you can now GET the settlement data using the 'settlementUniqueIdentifier' returned in * this POST response. * */ post: operations["createBankIntention"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/attachments": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Get list of attachments for a document with given document-uid */ get: operations["getAttachments"]; put?: never; /** @description Save an attachment, adding to a document */ post: operations["saveAttachment"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/admin/gdpr/remove/{uid}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** @description Removing of customer information. */ post: operations["removeSettlement"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v2/coderegister/brokerdeclarationtemplates": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Broker declarations (v2) * @description The current set af all active broker declarations. The set is subject to change. * Broker declarations are checklists presented to the broker when * deciding on wheather the registration (tinglysing) should be done on paper or digitally. * Version 2 of the declarations are used by broker applications that support registration of documents with attachments. */ get: operations["getDeclarationsV2"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/settlements/{uid}/documents": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Get all documents for a settlement */ get: operations["documentsForSettlement"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/settlements/{uid}/brokerdeclaration": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Get the broker declaration for the settlement */ get: operations["brokerdeclaration"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/purchasecontractrequests/{requestuid}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get purchase contract data by a request uid * @description Structured purchase contract data */ get: operations["getPurchaseContractByUid"]; put?: never; post?: never; /** * Cancel a request that matches the specified requestuid. * @description Cancel a purchase contract request if permissions checks are passed */ delete: operations["cancelPurchaseContractRequest"]; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/purchasecontractrequests/{requestuid}/{settlementuid}/signedcontract": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get signed purchase contract. * @description The signed purchase contract (PDF format). */ get: operations["getSignedPurchaseContractFromRequest"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/purchasecontractrequests/{requestuid}/{settlementuid}/pdf": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get purchase contract data rendered as PDF * @description Base 64 encoded PDF version of the structured purchase contract data. */ get: operations["getPurchaseContractAsPdf"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/ping": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Ping eps service */ get: operations["epsPing"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/flowvalidations/{propertykey}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Validate flow for property * @description * Determine flow for property according to the following rules: : ( _mix of English and Norwegian due to translation difficulties_ ) * * Property/Cooperative share that has seller that are registered as owner in the grunnbok with serial number, the flow will be paperbased. * * Property/Cooperative share that has right holder in urådighet (rettstype SP, CA, AH) with serial number, the flow will be paperbased. * * Property that does not have acreage (areal) in cadaster, the flow will be paperbased. Sections are exempt from the "konsesjonsloven" and shall not be included in the acreage check. Cooperative shares are exempt from the "konsesjonsloven" in respect of the property of the housing cooperative, and shall not be included in the area check. * * Property/Cooperative share that has seller that is under 18 years of age, the flow will be paperbased. * * Property/Cooperative shares that has has sovereignty limitation(råderettsbegrensende) remarks(påtegning) on a person the flow will be paperbased. Document types that will block for digital registration: * * Anmerkning på person ET, AI (konkurs, vergemål, akkord, offentlig administrasjon, * * Anmerkning på registerenhetsrettsandel EN, AB (Offentlig skifte,Tvangsauksjon og Fremtidsfullmakt) * * En borettsandel(Cooperative share) hvor det er tinglyst borett iht. brl §2-13, the flow will be paperbased. * */ get: operations["flowValidations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/events": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Find events * @description Receive a list of events sorted by id. Keep track of the highest value of id. Pass this highest value as query parameter 'fromeventid' in the next call to this operation to receive new events. */ get: operations["findEvents"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/events/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Get event by id */ get: operations["getEvent"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/documents/{uid}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Get document identified by the uniqueIdentifier provided by EPS during document creation */ get: operations["getDocument"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/documents/{uid}/info": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Get all document information (does not include the byte[]) by document unique id. */ get: operations["getDocumentInfo"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/documents/{uid}/attachments": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Get all attachments for document identified by the uniqueIdentifier provided by EPS during document creation, and by the attachment type (optional) */ get: operations["getAllAttachments"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/coderegister/eventcodes": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Event codes * @description Event codes are used in domain events to codify different result outcomes for the action that triggered the event. */ get: operations["getEventCodes"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/coderegister/eventcodes/{code}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * One event by code * @description Get one event code (template) by code. */ get: operations["getEventCode"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/coderegister/errorcodes": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Error codes * @description Error codes are used in error responses to codify different error cases. */ get: operations["getErrorCodes"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/coderegister/errorcodes/{code}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * One error by code * @description Get one error code (template) by code. */ get: operations["getErrorCode"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/coderegister/brokerdeclarationtemplates": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Broker declarations * @description The current set af all active broker declarations. Broker declarations are checklists presented to the broker when * deciding on wheather the registration (tinglysing) should be done on paper or digitally. */ get: operations["getDeclarations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/bankintentions/{uid}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Get bank intention. */ get: operations["getIntention"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/attachments/{uid}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Get attachment by uid */ get: operations["getAttachment"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/akeldo/{organizationNumber}/{messageType}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Query the Akeldo register if orgNumber can process messages of type messageType, get true / false in return */ get: operations["existsInAkeldo"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/akeldo/ambitabrokers": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description returns all the ambita brokers */ get: operations["ambitaBrokers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/v1/purchasecontractrequests/{requestuid}/{settlementuid}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** @description Stop receiving events on this purchase contract/settlement. */ delete: operations["stopEventsOnSettlement"]; options?: never; head?: never; patch?: never; trace?: never; }; } export type webhooks = Record; export interface components { schemas: { /** @description Beskrivelse av EPS code */ EpsCode: { /** * @description Unique code for event or error. Prefix EPS_EV for event codes and EPS_ERR for error codes. * @example EPS_EV0002 */ code: string; /** * @description Template for Norwegian message. '${description}' or '$description' used as placeholder for actual values. * Substitute placeholders with actual values from the received event to generate a complete Norwegian message for the end-user. * @example Intensjon feilet. Melding fra megler: $ekstern_beskrivelse. */ templateNo: string; /** * @description Template for Norwegian message. '${description}' or '$description' used as placeholder for actual values. * Substitute placeholders with actual values from the received event to generate a complete English message for the end-user. * @example Intension failed. Message from broker: $ekstern_beskrivelse. */ templateEn?: string; /** * @description A map of keys (placeholder name) and values (description) for this template. * @example { * "ekstern_beskrivelse": "Beskrivelse fra megler" * } */ templateValues: { [key: string]: string; }; }; ErrorResponse: { timestamp?: string; /** Format: int32 */ status?: number; error?: string; exception?: string; message?: string; technicalMessage?: string; path?: string; errorCode?: string; epsErrorCode?: components["schemas"]["EpsCode"]; }; /** @description Address of the real estate */ Address: { /** @description Name of the street */ streetName: string; /** @description Zip code */ zipCode: string; /** @description City */ city: string; }; Amount: { value: number; /** @description Currency according to ISO 4217 */ currency: components["schemas"]["Currency"]; }; /** @description General object describing a kind of area meassure */ Area: { /** * Format: int32 * @description The area in square meters */ squareMeter: number; /** * @description One of the specified area types * @enum {string} */ areaType: "PROM" | "BRA" | "TOMT" | "BTA"; }; BondRealEstateRequest: Omit, "ownershipType"> & { propertyKey: string; ownershipType?: components["schemas"]["OwnershipTypeDto"]; areas?: components["schemas"]["Area"][]; } & { /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ ownershipType: "BOND"; }; /** @description List of declaration from the real estate broker that is a part of the flow decision (paper or digital). If any of the declarations has active=true, the settlement will have paper flow */ BrokerDeclarationRequest: { declarations: components["schemas"]["Declaration"][]; }; CondominiumRealEstateRequest: Omit, "ownershipType"> & { propertyKey: string; ownershipType?: components["schemas"]["OwnershipTypeDto"]; areas?: components["schemas"]["Area"][]; } & { /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ ownershipType: "CONDOMINIUM"; }; /** @description Contact information for this settlement */ ContactInformation: { organizationName: string; organizationId?: string; contactPerson?: components["schemas"]["ContactPerson"]; }; /** @description Contact person for this settlement */ ContactPerson: { name: string; email?: string; phoneNumber?: string; phoneNumberDirect?: string; }; /** @description Details about the sale contract */ ContractDetails: { /** @description Payment details */ payment?: components["schemas"]["Payment"]; /** * Format: date * @description Handover date */ handoverDate?: string; /** * Format: date * @description * "Bid accepted date" * NEW. * */ bidAcceptedDate?: string; /** @description * Property's part of joint debt * * Andel fellesgjeld for borettsandeler. * * NEW. * */ partOfSharedDebt?: components["schemas"]["Amount"]; /** @description * Andel fellesformue for borettsandeler. * * NEW. */ partOfSharedWealth?: components["schemas"]["Amount"]; }; CooperativeRealEstateRequest: Omit, "ownershipType"> & { propertyKey: string; businessManager?: components["schemas"]["Organization"]; /** @description Floor number */ floorNumber?: string; ownershipType?: components["schemas"]["OwnershipTypeDto"]; } & { /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ ownershipType: "COOPRATIVE"; }; /** @enum {string} */ Currency: "ATS" | "AUD" | "BEC" | "BEF" | "BGL" | "BGN" | "BRC" | "CAD" | "CHF" | "CSK" | "CYP" | "CZK" | "DEM" | "DKK" | "ECU" | "EEK" | "ESC" | "ESP" | "EUR" | "FIM" | "FRF" | "GBP" | "GRD" | "HKD" | "HUF" | "IEP" | "ISK" | "ITL" | "JPY" | "KRW" | "LTL" | "LUF" | "LVL" | "MTL" | "NLG" | "NOK" | "NZD" | "PKR" | "PLN" | "PLZ" | "PTE" | "ROL" | "SDR" | "SEK" | "SGD" | "SIT" | "SKK" | "SUR" | "SYP" | "THB" | "TRL" | "TWD" | "USD" | "XEU" | "YUD" | "ZAR"; Declaration: { /** * @description List of available declarations(only served in Norwegian) * @enum {string} */ key: "NOT_ABLE_TO_SIGN_ELECTRONICALLY" | "CAN_NOT_PRODUCE_DIGITAL_PANTEDOKUMENT" | "TRANSFER_CONTAINS_OF_OTHER_DEALS_TO_TINGLYSE" | "TRANSFER_DEMANDS_ATTACHMENTS" | "TRANSFER_FROM_OTHER_THAN_HJEMMELSHAVER" | "TRANSFER_IS_INHERITANCE" | "TRANSFER_CONTAINS_DELETION_OF_FESTEKONTRAKT" | "TRANSFER_IS_BORETT_2_13" | "COOPERATIVE_IN_LIMITED_CONCESSION_AREA" | "NOT_ABLE_TO_SIGN_ELECTRONICALLY_V2" | "CAN_NOT_PRODUCE_DIGITAL_PANTEDOKUMENT_V2" | "TRANSFER_CONTAINS_OF_OTHER_DEALS_TO_TINGLYSE_V2" | "TRANSFER_DEMANDS_ATTACHMENTS_V2" | "TRANSFER_FROM_OTHER_THAN_HJEMMELSHAVER_V2" | "TRANSFER_IS_INHERITANCE_V2" | "TRANSFER_CONTAINS_DELETION_OF_FESTEKONTRAKT_V2" | "TRANSFER_IS_BORETT_2_13_V2" | "NOT_ABLE_TO_SIGN_ELECTRONICALLY_V4" | "CAN_NOT_PRODUCE_DIGITAL_PANTEDOKUMENT_V4" | "TRANSFER_CONTAINS_OF_OTHER_DEALS_TO_TINGLYSE_V4" | "TRANSFER_DEMANDS_ATTACHMENTS_V4" | "TRANSFER_FROM_OTHER_THAN_HJEMMELSHAVER_V4" | "TRANSFER_IS_INHERITANCE_V4" | "TRANSFER_CONTAINS_DELETION_OF_FESTEKONTRAKT_V4" | "TRANSFER_IS_BORETT_2_13_V4"; /** * @description A phrase describing a flow as an assumption. If the assumption is false, it means paper flow. (only served in Norwegian) * @example 'Minst en av partene må signere på papir.' (At least one actor cant't sign electronically) */ flowCriteria?: string; /** @description True set true if will set flow to paper */ paperFlow: boolean; /** * Format: int32 * @description Sorting order * @example 10 */ order?: number; /** @description A more detailed description of the assumption(flowCriteria). (only served in Norwegian) */ longDescription?: string; }; /** @description Fraction describes a part of a property/cooperative share */ Fraction: { /** * Format: int64 * @description Numerator (teller). Must be greater than zero */ numerator: number; /** * Format: int64 * @description Denominator (nevner). Must be greater than zero */ denominator: number; }; /** @description An organization */ JuridicalPerson: { /** * @description Organization number * @example 987654321 */ officialId: string; /** @description Organization name */ name: string; }; MatrikkelRealEstateRequest: Omit, "ownershipType"> & { propertyKey: string; ownershipType?: components["schemas"]["OwnershipTypeDto"]; } & { /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ ownershipType: "OWNED"; }; /** @description Organization with name and organization number. */ Organization: { /** @description The organization number according to 'Enhetsregisteret'. */ organizationNumber: string; /** @description The name of the organization. */ name?: string; }; /** @enum {string} */ OwnershipTypeDto: "STOCK" | "COOPRATIVE" | "CONDOMINIUM" | "OWNED" | "BOND"; /** @description Information about the price, fees, accounts, etc. */ Payment: { /** @description The purchase price w/o costs */ purchasePrice?: components["schemas"]["Amount"]; /** @description The cost/fee of the purchase(dokumentavgift and tinglysingsgebyr) */ additionalCost?: components["schemas"]["Amount"]; /** @description Account number */ accountNumber?: string; /** @description KID number for invoicing */ customerIdentificationNumber?: string; /** @description Other description if invoice KID number is unavailable */ paymentDescription?: string; }; /** @description A person or an organization. Either 'name' or both of 'firstName' and 'lastName' is required. */ Person: { /** * @description Organization number (9 digits) or personal number (11 digits) * @example 947382736 */ officialId: string; /** @description Required for organizations. For legacy reasons, name can also be used for persons, but it is recommended to use firstName+lastName instead. */ name?: string; /** @description First and middle name if it is a person. For organizations, use 'name' */ firstName?: string; /** @description Last (given) name if a person. For organizations, use 'name' */ lastName?: string; }; RealEstateBuyer: { buyer: components["schemas"]["Person"]; fraction?: components["schemas"]["Fraction"]; }; /** @description Owner of a real estate according to Land Registry */ RealEstateHjemmelshaver: { hjemmelshaver: components["schemas"]["Person"]; fraction?: components["schemas"]["Fraction"]; }; /** @description RealEstate is a uniqely identified object. Either cadastre(matrikkel), cooperative share(borettsandel) or less common types like obligasjonsleiliget or aksjeleilighet */ RealEstateRequest: { /** * @description The id of a real estate. * For Cadastre the format is: 'municipalityNumber'-cadastralUnitNumber-unitNumber-leaseholdUnitNumber-sectionNumber' * (Norwegian: 'kommunenr-gårdsnr-bruksnr-festenr-seksjonsnr'). * For Cooperative share the format is: 'organizationNumber-shareNumber'. * Examples: '0301-12-120-0-3', '952780905-125'. * * @example Cadastre: 4601-12-321-0-0, Cooperative share/aksje/obligasjon: 952780905-125 */ propertyKey: string; /** @description Type of ownership */ ownershipType?: components["schemas"]["OwnershipTypeDto"]; sellers: components["schemas"]["RealEstateSellerDto"][]; buyers: components["schemas"]["RealEstateBuyer"][]; hjemmelshavere?: components["schemas"]["RealEstateHjemmelshaver"][]; address?: components["schemas"]["Address"]; /** @description General object(s) describing one or more areas */ areas?: components["schemas"]["Area"][]; }; RealEstateSellerDto: { seller: components["schemas"]["Person"]; fraction?: components["schemas"]["Fraction"]; }; RealsameieRequest: { /** @description Propertykey, must be of type matrikkel */ propertyKey: string; }; /** @description Data for settlement creation */ SettlementRequest: { /** @description External reference, value set by client */ externalReference?: string; /** @description List of real estates that is a part of the settlement. At least one is required */ realEstates: (components["schemas"]["RealEstateRequest"] | components["schemas"]["BondRealEstateRequest"] | components["schemas"]["CondominiumRealEstateRequest"] | components["schemas"]["CooperativeRealEstateRequest"] | components["schemas"]["MatrikkelRealEstateRequest"] | components["schemas"]["StockRealEstateRequest"])[]; /** @description List of realsameie defined by their property key (example: 4601-10-1-10-14) */ realSameier?: components["schemas"]["RealsameieRequest"][]; brokerDeclaration: components["schemas"]["BrokerDeclarationRequest"]; /** @description Contract details */ contractDetails: components["schemas"]["ContractDetails"]; /** * Format: int64 * @description For internal Ambita use only */ ownerDepartmentId?: number; contactInformation?: components["schemas"]["ContactInformation"]; /** @description Source of financing */ financialSources?: components["schemas"]["JuridicalPerson"][]; /** @description Link to prospect. Should be URLencoded (UTF 8). */ encodedProspectURL?: string; /** * @description Free text that describes the object type beeing sold. * @example DSVE standard types: 'ENEBOLIG', 'DELT_BOLIG', 'REKKEHUS', 'LEILIGHET', 'FRITIDSEIENDOM', 'TOMT', 'NAERINGSBYGG', 'NYBYGG', 'LANDBRUK' */ objectType?: string; /** @description Field for an optional oppdragsnummer, max size 255 characters */ assignmentNumber?: string; /** @description The Vitec Next estate id corresponding to the settlement, if applicable. Will be persisted in the database if the request originates from Vitec Next. */ estateIdVitecNext?: string; }; StockInformation: { /** Format: int32 */ firstStockNumber?: number; /** Format: int32 */ lastStockNumber?: number; /** * Format: int64 * @description Pålydende verdi. Nominal share value. */ shareValue?: number; }; StockRealEstateRequest: Omit, "ownershipType"> & { propertyKey: string; areas?: components["schemas"]["Area"][]; stockInformation?: components["schemas"]["StockInformation"]; businessManager?: components["schemas"]["Organization"]; /** @description Floor number */ floorNumber?: string; ownershipType?: components["schemas"]["OwnershipTypeDto"]; } & { /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ ownershipType: "STOCK"; }; /** @description Information about the bank that has submitted the intention */ BankInformation: { department?: components["schemas"]["Department"]; }; /** @description Matrikkel */ Cadastre: { /** * Format: int32 * @description In Norwegian: Kommunenummer */ municipalityNumber: number; /** * Format: int32 * @description In Norwegian: Gardsnummer */ cadastralUnitNumber: number; /** * Format: int32 * @description In Norwegian: Bruksnummer */ unitNumber: number; /** * Format: int32 * @description In Norwegian: Festenummer */ leaseholdUnitNumber: number; /** * Format: int32 * @description In Norwegian: Seksjonsnummer */ sectionNumber: number; /** * @description In Norwegian: Eiendomsnivå * @enum {string} */ cadastreLevel: "B" | "E" | "F" | "F1" | "F2" | "F3"; }; /** @description Flow capability, PAPER og DIGITAL and if flow si PAPER it contains the reason */ Capability: { /** @description Type of flow, paper or digital */ flow: components["schemas"]["Flow"]; /** * @deprecated * @description If the flow is 'PAPER' this will contain the reason. If the flow is 'DIGITAL' this field is empty */ reason?: string; }; /** @description A capability of the collaboration to deliver data of the specified type */ CollaborationCapability: { capability: string; description: string; }; CooperativeRealEstateDto: Omit, "ownershipType"> & { propertyKey: string; cooperativeShare: components["schemas"]["CooperativeShare"]; areas?: components["schemas"]["Area"][]; businessManager?: components["schemas"]["Organization"]; /** @description Floor number */ floorNumber?: string; } & { /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ ownershipType: "COOPRATIVE"; }; /** @description Borettsandel */ CooperativeShare: { /** Format: int32 */ organizationNumber: number; /** Format: int32 */ shareNumber: number; }; Department: { name?: string; organization: components["schemas"]["OrganizationDto"]; }; /** @description A document :-) */ Document: { /** @description Unique identifier for the document */ uniqueIdentifier: string; /** @description Document description */ description?: string; customerReference?: string; /** * @description A label used to identify the data type the document is saved in * @example text/BIDXML, text/DummySDO, application/pdf, text/xml, text/plain */ mimeType: string; settlementUid: string; /** * @description Documenttype * @enum {string} */ documentType: "MORTGAGE" | "BANK_INTENTION" | "SIGNED_BUYER_CONTRACT"; /** @description Information about the document */ readonly meta?: components["schemas"]["DocumentMeta"]; /** Format: date-time */ created: string; /** @description Document status */ status: components["schemas"]["MessageStatus"]; owner: components["schemas"]["UserDto"]; /** @description Optional error details during error states */ errorCode?: components["schemas"]["DocumentResourceErrorCodeDto"]; links?: components["schemas"]["Link"][]; }; /** @description Extra information about the document */ DocumentMeta: { tinglysingsInformation?: components["schemas"]["Tinglysingsinformasjon"]; }; /** @description Error code and detailing message */ DocumentResourceErrorCodeDto: { /** @description Code register error code */ code?: string; /** @description Message detailing the cause of the error */ message: string; }; /** * @description * * PAPER, tinglysing må foregå på papir * * DIGITAL, tinglysing vil foregå digitalt * * @enum {string} */ Flow: "PAPER" | "DIGITAL"; /** @description The result of one flowvalidation. */ FlowValidation: { message: string; /** * @description Codes for reasons for PAPER flow * @enum {string} */ code: "NO_OFFICIAL_ID" | "BROKER_DECLARATION" | "RETTIGHETSHAVER_WITH_LOEPENUMMER" | "BORETTSANDEL_NULLKONSESJON" | "REMARKS_ON_PERSON" | "PAPERFLOW_DUE_TO_BORETT_2_13" | "CADASTRE_ACREAGE" | "BUYER_YOUNGER_THAN_18" | "SELLER_YOUNGER_THAN_18" | "BANK_INTENTION"; }; IntentionFromBank: { uniqueIdentifier: string; /** Format: date-time */ created: string; capability?: components["schemas"]["Capability"]; reference?: string; bankInformation?: components["schemas"]["BankInformation"]; intentionStatus: components["schemas"]["MessageStatus"]; }; Link: { rel?: string; href?: string; hreflang?: string; media?: string; title?: string; type?: string; deprecation?: string; profile?: string; name?: string; }; MatrikkelRealEstateDto: Omit, "ownershipType"> & { propertyKey: string; cadastre: components["schemas"]["Cadastre"]; areas?: components["schemas"]["Area"][]; realSameier: components["schemas"]["Realsameie"][]; } & { /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ ownershipType: "OWNED" | "CONDOMINIUM"; }; /** @enum {string} */ MessageStatus: "PENDING" | "ACCEPTED" | "ACCEPTED_PARTIAL" | "REJECTED" | "SENT"; OrganizationDto: { name: string; code?: string; orgNr?: string; }; RealEstate: { /** * @description The id of a real estate. * For Cadastre the format is: 'municipalityNumber'-cadastralUnitNumber-unitNumber-leaseholdUnitNumber-sectionNumber' * (Norwegian: 'kommunenr-gårdsnr-bruksnr-festenr-seksjonsnr'). * For Cooperative share the format is: 'organizationNumber-shareNumber'. * Examples: '0301-12-120-0-3', '952780905-125'. * * @example Cadastre: 4601-12-321-0-0, Cooperative share/aksje/obligasjon: 952780905-125 */ propertyKey: string; /** @description Type of ownership */ ownershipType: components["schemas"]["OwnershipTypeDto"]; sellers: components["schemas"]["RealEstateSellerDto"][]; buyers: components["schemas"]["RealEstateBuyer"][]; hjemmelshavere: components["schemas"]["RealEstateHjemmelshaver"][]; address?: components["schemas"]["Address"]; /** @description General object(s) describing one or more areas */ areas?: components["schemas"]["Area"][]; }; Realsameie: { /** @description Propertykey, must be of type matrikkel */ propertyKey: string; /** @description Owning fraction */ fraction: components["schemas"]["Fraction"]; }; /** @description Identifier of a right within a registered document */ Rettsstiftelsesinformasjon: { /** @description A right reference */ rettsstiftelsesreferanse: string; /** * Format: int32 * @description Right number */ rettsstiftelsesnummer: number; }; /** @enum {string} */ SettlementDataOrigin: "BROKER" | "BANK"; /** @description The complete settlement with broker declaration and related documents(documents without dokument payload). This resource contains a link to retrieve all document with rel - allDocuments */ SettlementResource: { /** @description Unique identifier for a settlement */ readonly uniqueIdentifier: string; /** @description Settlement status */ readonly status: string; contractDetails?: components["schemas"]["ContractDetails"]; owner?: components["schemas"]["UserDto"]; realEstates: (components["schemas"]["RealEstate"] | components["schemas"]["CooperativeRealEstateDto"] | components["schemas"]["MatrikkelRealEstateDto"] | components["schemas"]["StockRealEstateDto"])[]; documents: components["schemas"]["Document"][]; flowValidations: components["schemas"]["FlowValidation"][]; intentionsFromBank: components["schemas"]["IntentionFromBank"][]; /** @description External reference, value set by client */ externalReference?: string; /** * @description Free text that describes the object type beeing sold. * @example DSVE standard types: 'ENEBOLIG', 'DELT_BOLIG', 'REKKEHUS', 'LEILIGHET', 'FRITIDSEIENDOM', 'TOMT', 'NAERINGSBYGG', 'NYBYGG', 'LANDBRUK' */ objectType?: string; flow: components["schemas"]["Flow"]; contactInformation?: components["schemas"]["ContactInformation"]; /** @description Describes from which party the settlement data originated. */ dataOrigin: components["schemas"]["SettlementDataOrigin"]; collaborationCapabilities: components["schemas"]["CollaborationCapability"][]; /** @description Link to prospect. URLencoded (UTF 8) */ encodedProspectURL?: string; /** @description Field for an optional oppdragsnummer */ assignmentNumber?: string; links?: components["schemas"]["Link"][]; }; /** @description Aksjeleilighet */ Stock: { /** * Format: int32 * @description Organization number for the Stock appartment. Norsk: Organisasjonsnummeret til aksjeleiligheten */ organizationNumber: number; /** * Format: int32 * @description Identifies the appartment. Norsk: Aksjeleilighetsnummeret */ stockNumber: number; }; StockRealEstateDto: Omit, "ownershipType"> & { propertyKey: string; stock: components["schemas"]["Stock"]; areas?: components["schemas"]["Area"][]; stockInformation?: components["schemas"]["StockInformation"]; businessManager?: components["schemas"]["Organization"]; /** @description Floor number */ floorNumber?: string; } & { /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ ownershipType: "STOCK"; }; /** @description * Information about the dokument after it is registered at the Land Registry * (Tinglysingen, Statens Kartverk). If the outcome is 'TINGLYST', the elements of the document identifier has values. * For all other values for outcome, the dokument identifier element are empty(null) * */ Tinglysingsinformasjon: { /** @description Reference to the document */ documentReference?: string; /** * Format: date-time * @description The date and time of registration with the Land Registry */ registreringstidspunkt?: string; /** * @description The outcome of the registration * @enum {string} */ behandlingsutfall?: "TINGLYST" | "NEKTET" | "AVVIST" | "UAVKLART" | "IKKE_GODKJENT"; /** * Format: int32 * @description Part of the document identifier(dokumentnummer): Year of registration (requires behandlingsutfall = 'TINGLYST') */ dokumentaar?: number; /** * Format: int64 * @description Part of the document identifier: The serial number (requires behandlingsutfall = 'TINGLYST') */ dokumentnummer?: number; /** * Format: int32 * @description Part of the document identifier: The registration office (requires behandlingsutfall = 'TINGLYST') */ embetenummer?: number; /** @description List of rights within the registered document (requires behandlingsutfall = 'TINGLYST') */ rettsstiftelsesinformasjon: components["schemas"]["Rettsstiftelsesinformasjon"][]; }; UserDto: { organization?: components["schemas"]["OrganizationDto"]; name?: string; email?: string; }; /** @description Attachment for a document */ Attachment: { /** @description Unique identifier for a settlement */ readonly uniqueIdentifier?: string; description?: string; /** * @description A label used to identify a type of data in the attachment * @example text/BIDXML, text/DummySDO, application/pdf, text/xml, text/plain */ mimeType: string; /** @description Type of attachment. */ type?: components["schemas"]["AttachmentType"]; /** Format: date-time */ created?: string; propertyKey?: string; links?: components["schemas"]["Link"][]; }; /** @enum {string} */ AttachmentType: "PREREQUISITE" | "PREREQUISITE_XML" | "PREREQUISITE_XSLT" | "GRUNNBOKSUTSKRIFT" | "GRUNNBOKSUTSKRIFT_LINK"; /** @description The document resource, includes all document date with a list of attachments without attachment.data */ DocumentResource: { uniqueIdentifier: string; description?: string; customerReference?: string; mimeType?: string; settlementUid?: string; /** @enum {string} */ documentType: "MORTGAGE" | "BANK_INTENTION" | "SIGNED_BUYER_CONTRACT"; /** Format: date-time */ created?: string; status?: components["schemas"]["MessageStatus"]; owner: components["schemas"]["UserDto"]; /** * Format: byte * @description Base64 encoded data, in a format that is described by mimetype, that constitutes the document */ data: string; meta?: components["schemas"]["DocumentMeta"]; /** @description List of attachments */ attachments: components["schemas"]["Attachment"][]; errorCode?: components["schemas"]["DocumentResourceErrorCodeDto"]; links?: components["schemas"]["Link"][]; }; SignedPurchaseContractRequest: { mimeType: string; /** Format: byte */ data: string; customerReference?: string; }; /** @description The signed purchase contract with meta data */ SignedPurchaseContractResource: { /** @description The unique identifier of this signed purchase contract */ uniqueIdentifier: string; /** @description The mimetype of this signed purchase contract */ mimeType: string; /** * Format: date-time * @description The timestamp for when it was saved */ created: string; /** * Format: byte * @description Base64 encoded data, in a format that is described by mimetype, that constitutes the signed purchase contract */ data: string; }; /** @description Request body for requesting a purchase contract */ PurchaseContractRequest: { /** @description Organization number for the broker */ brokerOrganizationNumber: string; /** @description Official id (organization number or personal number) for at least one of the buyers. */ buyerOfficialIds: string[]; /** @description Bank's reference */ reference: string; }; /** @description A collection of resources to a purchase contract. */ ContractResource: { /** * @description Unique identifier of a settlement representing purchase contract dat * @example SET-1ec85753-1eec-465c-88f0-27cab92ee368 */ settlementUid: string; /** @description Broker's reference */ brokerReference: string; /** * Format: url * @description Link to settlement */ settlementLink: string; /** * Format: url * @description Link to settlement data rendered as PDF */ settlementAsPdfLink: string; /** * Format: url * @description Link to signed purchase contract as PDF */ signedPurchaseContractLink?: string; /** @description Address */ address?: components["schemas"]["Address"]; }; /** @description Response for purchase contract request. Contains list of contracts and status of the request. */ PurchaseContractResource: { /** * @description Uid identifying the request for purchase contract * @example KJO-2f634fbb-d9c3-46e3-a4ae-1c7577350cec */ requestUid: string; /** @description List of link to settlements representing purchase contracts. */ contracts: components["schemas"]["ContractResource"][]; /** @description * Status of the request. * ACCEPTED if matched with settlement. * INVALID_BUYER if didn't match any settlements, * PENDING if response not received from broker yet. * OUTDATED The bank har requested the purchase contract again later. * */ status: string; /** @description True if there are settlements that are not ready for generating purchase contract yet. */ existsSettlementsNotReady?: boolean; }; /** @description Request body for a bank intention request. */ BankIntentionFlowRequest: { /** @description The declared from from the bank */ flow: components["schemas"]["Flow"]; }; /** @description Document data field encoded with b64 and metadata */ DocumentRequest: { /** @enum {string} */ documentType: "MORTGAGE" | "BANK_INTENTION" | "SIGNED_BUYER_CONTRACT"; mimeType: string; description?: string; customerReference?: string; propertyKey?: string; /** Format: byte */ data: string; shipmentUid?: string; receiverOrganizationNumber?: string; /** @description Prerequisite letter */ prerequisite?: components["schemas"]["Prerequisite"]; rettighetshavere: components["schemas"]["RettighetshaverFraPant"][]; }; /** @description Prerequisite letter */ Prerequisite: { /** * @description A label used to identify a type of data in the attachment * @enum {string} */ mimeType: "application/pdf" | "text/xml"; /** * Format: byte * @description The prerequisite letter payload */ data: string; /** * Format: byte * @description Prerequisite letter transformation xslt. Must be text/xml mimetype. Required if prerequisite is text/xml */ xslt?: string; }; RettighetshaverFraPant: { name: string; officialId: string; }; /** @description Extra information about the document */ DocumentDetailRequest: { /** @description Deprecated */ shipmentReference?: string; /** * @description The result of the registration(tinglysingen) at the Land Registry * @enum {string} */ treatmentOutcome?: "TINGLYST" | "NEKTET" | "AVVIST" | "UAVKLART" | "IKKE_GODKJENT"; /** * @description The result of the registration process at the Land Registry * @enum {string} */ caseStatus?: "AVSLUTTET" | "MOTTATT" | "UNDER_BEHANDLING"; /** @description Information about the document after registration(tinglysing) */ tinglysingsInformation?: components["schemas"]["Tinglysingsinformasjon"]; }; /** @description Data for bank intention creation */ BankIntentionRequest: { /** @description Bank details */ sender: components["schemas"]["Sender"]; /** @description Broker recipient */ brokerRecipient: components["schemas"]["BrokerRecipient"]; /** @description Buyers - persons or/and organizations */ buyers: components["schemas"]["Subjects"]; /** @description Real estates */ realEstates: components["schemas"]["IntentionRealEstate"][]; /** * @description The signing method defined by the bank * @enum {unknown} */ flowCapability: components["schemas"]["Flow"]; }; /** @description The broker that shall receive the intention. */ BrokerRecipient: { /** @description The organization details for the broker */ organization: components["schemas"]["Organization"]; /** @description The broker's reference */ brokerReference?: string; }; /** @description IntentionRealEstate is a uniqely identified object. Either cadastre(matrikkel), cooperative share(borettsandel) or less common types like obligasjonsleiliget or aksjeleilighet */ IntentionRealEstate: { /** @description Property object type is ownership type and property key, */ propertyObject: components["schemas"]["PropertyObject"]; /** @description The address of the property */ address?: components["schemas"]["Address"]; }; /** @description A person in eps. */ PersonFirstLastName: { /** * @description National identification number for Norway * @example 26059765131 */ officialId: string; /** @description First name of the buyer. */ firstName: string; /** @description Last name of the buyer. */ lastName: string; /** @description Middle name of the buyer. */ middleName?: string; }; PropertyObject: { /** * @description The id of a real estate. * For Cadastre the format is: 'municipalityNumber'-cadastralUnitNumber-unitNumber-leaseholdUnitNumber-sectionNumber' * (Norwegian: 'kommunenr-gårdsnr-bruksnr-festenr-seksjonsnr'). * For Cooperative share the format is: 'organizationNumber-shareNumber'. * Examples: '0301-12-120-0-3', '952780905-125'. * Note: An optional ' [property level]' can be appended in outputs. * * @example Cadastre: 4601-12-321-0-0, Cooperative share/aksje/obligasjon: 952780905-125 */ propertyKey: string; /** @description Ownership type */ ownershipType?: components["schemas"]["OwnershipTypeDto"]; }; /** @description ReturnTo */ ReturnToDto: { /** @description Return the intention answer to this organization. */ organization: components["schemas"]["Organization"]; }; /** @description The party that sends the request. */ Sender: { /** @description Contact person */ contactPerson?: components["schemas"]["ContactPerson"]; /** @description Sender's reference. */ reference: string; /** @description Alternative return address information. The default is the logged in users organisation */ returnTo?: components["schemas"]["ReturnToDto"]; }; /** @description The parties in a property transaction. Can either be list of persons, a list of organizations or both */ Subjects: { /** @description List of persons */ persons?: components["schemas"]["PersonFirstLastName"][]; /** @description List of organizations */ organizations?: components["schemas"]["Organization"][]; }; /** @description The newly created bank intention */ BankIntentionResource: { /** @description Unique identifier for the intention */ uniqueIdentifier: string; sender: components["schemas"]["Sender"]; brokerRecipient: components["schemas"]["BrokerRecipient"]; buyers: components["schemas"]["Subjects"]; realEstates: components["schemas"]["IntentionRealEstate"][]; /** @description Bank's intended flow */ flowCapability: components["schemas"]["Flow"]; /** @description Settlement identifier */ settlementUniqueIdentifier: string; /** @description Intention status */ intentionStatus: components["schemas"]["MessageStatus"]; /** Format: date-time */ created: string; /** Format: date-time */ updated: string; links?: components["schemas"]["Link2"][]; }; Link2: { rel: string; /** Format: url */ href: string; }; /** @description Attachment request body */ AttachmentRequest: { /** @description Type of attachment */ type: components["schemas"]["AttachmentType"]; mimeType: string; description?: string; /** @description Required for attachments of type 'GRUNNBOKSUTSKRIFT' and 'GRUNNBOKSUTSKRIFT_LINK' */ propertyKey?: string; /** Format: byte */ data: string; }; AttachmentResource: { uniqueIdentifier: string; description?: string; /** * @description A label used to identify the data type the attachment is saved in * @example text/BIDXML, text/DummySDO, application/pdf, text/xml, text/plain */ mimeType: string; /** @description Attachment type */ type: components["schemas"]["AttachmentType"]; /** * Format: byte * @description Base64 encoded data, in a format that is described by mimetype, that constitutes the document */ data: string; /** Format: date-time */ created: string; propertyKey?: string; settlementUid: string; links?: components["schemas"]["Link2"][]; }; BrokerDeclarationTemplateV2Resource: { declarations: components["schemas"]["BrokerDeclarationV2Template"][]; }; /** @description A broker declaration. */ BrokerDeclarationV2Template: { /** @description The value identifying the declaration. */ key: string; /** * @description A phrase describing a flow as an assumption. If the assumption is false, it means paper flow. (only served in Norwegian) * @example 'Minst en av partene må signere på papir.' (At least one actor cant't sign electronically) */ flowCriteria: string; /** * Format: int32 * @description Sorting order * @example 10 */ order: number; /** @description Long description of criteria */ longDescription: string; /** * Format: date-time * @description Created timestamp */ created: string; /** * Format: date-time * @description Last changed timestamp. */ updated: string; }; Page: { /** Format: int32 */ size: number; /** Format: int32 */ totalElements: number; /** Format: int32 */ totalPages: number; /** Format: int32 */ number: number; }; SettlementPagedResource: { content: components["schemas"]["SettlementResource"][]; links: components["schemas"]["Link2"][]; page: components["schemas"]["Page"]; }; /** @description List of declaration from the real estate broker that is a part of the flow decision (paper or digital). If any of the declarations has active=true, the settlement will have paper flow */ BrokerDeclarationResource: { declarations: components["schemas"]["Declaration"][]; links: components["schemas"]["Link2"][]; }; /** @description Object wrapper for purchase contract as pdf. */ PurchaseContractPdfResource: { /** * @description Uid identifying the request for purchase contract * @example KJO-2f634fbb-d9c3-46e3-a4ae-1c7577350cec */ requestUid: string; /** * @description Uid identifying the settlement * @example SET-2f634fbb-d9c3-46e3-a4ae-1c7577350cec */ settlementUid: string; /** * Format: byte * @description Base64 encoded pdf file */ pdfBase64: string; /** * Format: date-time * @description Timestamp for last updated contract data. */ created: string; }; PingResponse: { online?: boolean; version?: string; env?: string; latency?: string; details?: components["schemas"]["SubsystemPingResponse"][]; /** Format: date-time */ status_time?: string; system?: string; /** Format: date-time */ release_time?: string; /** Format: date-time */ started_time?: string; }; SubsystemPingResponse: { required?: boolean; component?: string; available?: boolean; latency?: string; message?: string; /** Format: date-time */ uptodate_time?: string; }; /** @description The result of a flow validation. If the result is DIGITAL no reasons for paper flow will be give. */ FlowValidationResource: { propertyKey: string; flow: components["schemas"]["Flow"]; reasonsForPaperFlow: components["schemas"]["FlowValidation"][]; }; /** @description Events in september */ EventResource: { /** * Format: int64 * @description Unique id for the evnt. For two events, if event2.id > event1.id event1 is created before(or at the same time) event1 and event2.created >= event1.created */ readonly eventId: number; /** @description * Type of event. New events will be added as needed when new functionality is added. * * Settlement related events: * For broker: * - SETTLEMENT_CREATED * - SETTLEMENT_UPDATED * - SETTLEMENT_CANCELLED * - SETTLEMENT_SEARCHED * - RECEIPT_ADDED (deprecated) * * Intention related events: * For broker: * - INTENTION_RECEIVED, intention received from a bank * - INTENTION_CHANGED, intention changed by the bank * * For bank: * - INTENTION_SENT, intention sent to an extenal broker * - INTENTION_RESPONSE_RECEIVED, intention response received from the external broker * - INTENTION_CHANGED, intention changed by the broker * * Mortgage related events: * For broker: * - MORTGAGE_RECEIVED, mortgage document received from a bank * - PREREQUISITE_RECEIVED (deprecated) * * For bank: * - MORTGAGE_SENT_TO_BROKER, mortgage document sent to an external broker * - MORTGAGE_ACCEPTED, mortgage document accepted by the external broker * - MORTGAGE_REJECTED, mortgage document rejected by the external broker * - MORTGAGE_TINGLYST, mortgage document tinglyst by the broker (currently only Ambita brokers) * * Purchase contract relaetd events: * For broker: * - PURCHASE_CONTRACT_REQUESTED, A bank has requested purchase contract for a settlement * - PURCHASE_CONTRACT_CHANGE_SENT, changes in purchase contract sent to a bank that has requested it * * For bank: * - PURCHASE_CONTRACT_REQUEST_SENT, purchase contract sent to an external broker * - PURCHASE_CONTRACT_RESPONSE_RECEIVED, purchase contract response received from the external broker * - PURCHASE_CONTRACT_CHANGED, purchase contract changed by the broker. Property 'settlementChanges' will list changes. * * Maintenance events: * - SETTLEMENT_GDPR_RYDDET, (future event), data removed or archived * * */ readonly type: components["schemas"]["EventType"]; /** @description Description of event type. */ text?: string; /** @description Additional information regarding the event. */ description?: string; /** Format: date-time */ created: string; settlementUid?: string; externalReference?: string; resources?: components["schemas"]["ResourceDto"][]; eventCode?: components["schemas"]["EpsCode"]; /** @description Purchase contract request uid */ contractRequestUid?: string; /** @description For event `PURCHASE_CONTRACT_CHANGED` this will be a list of changes in the settlement/purchase contract, * Possible values are "HANDOVER_DATE, PAYMENT_INFO, BUYERS, PROPERTIES, SIGNED_PURCHASE_CONTRACT" * */ settlementChanges: string[]; links: components["schemas"]["Link2"][]; }; /** @enum {string} */ EventType: "SETTLEMENT_CREATED" | "SETTLEMENT_UPDATED" | "SETTLEMENT_CANCELLED" | "MORTGAGE_RECEIVED" | "RECEIPT_ADDED" | "MORTGAGE_SENT_TO_BROKER" | "MORTGAGE_ACCEPTED" | "MORTGAGE_REJECTED" | "MORTGAGE_TINGLYST" | "INTENTION_RECEIVED" | "INTENTION_RESPONSE_RECEIVED" | "INTENTION_SENT" | "INTENTION_CHANGED" | "PREREQUISITE_RECEIVED" | "SETTLEMENT_SEARCHED" | "PURCHASE_CONTRACT_REQUESTED" | "PURCHASE_CONTRACT_CHANGE_SENT" | "PURCHASE_CONTRACT_RESPONSE_RECEIVED" | "PURCHASE_CONTRACT_CHANGED" | "PURCHASE_CONTRACT_REQUEST_SENT" | "SETTLEMENT_GDPR_RYDDET" | "SETTLEMENT_ARCHIVED" | "SETTLEMENT_REOPENED"; ResourceDto: { resourceUniqueIdentifier: string; /** @enum {string} */ type: "SETTLEMENT" | "DOCUMENT" | "ATTACHMENT"; }; EventCodesResource: { eventCodes: components["schemas"]["EpsCode"][]; }; /** @description A broker declaration. */ BrokerDeclarationTemplate: { /** * @description An enum value identifying the declaration. The list is subject to change! * @enum {string} */ key: "NOT_ABLE_TO_SIGN_ELECTRONICALLY" | "CAN_NOT_PRODUCE_DIGITAL_PANTEDOKUMENT" | "TRANSFER_CONTAINS_OF_OTHER_DEALS_TO_TINGLYSE" | "TRANSFER_DEMANDS_ATTACHMENTS" | "TRANSFER_FROM_OTHER_THAN_HJEMMELSHAVER" | "TRANSFER_IS_INHERITANCE" | "TRANSFER_CONTAINS_DELETION_OF_FESTEKONTRAKT" | "TRANSFER_IS_BORETT_2_13" | "COOPERATIVE_IN_LIMITED_CONCESSION_AREA" | "NOT_ABLE_TO_SIGN_ELECTRONICALLY_V2" | "CAN_NOT_PRODUCE_DIGITAL_PANTEDOKUMENT_V2" | "TRANSFER_CONTAINS_OF_OTHER_DEALS_TO_TINGLYSE_V2" | "TRANSFER_DEMANDS_ATTACHMENTS_V2" | "TRANSFER_FROM_OTHER_THAN_HJEMMELSHAVER_V2" | "TRANSFER_IS_INHERITANCE_V2" | "TRANSFER_CONTAINS_DELETION_OF_FESTEKONTRAKT_V2" | "TRANSFER_IS_BORETT_2_13_V2" | "NOT_ABLE_TO_SIGN_ELECTRONICALLY_V4" | "CAN_NOT_PRODUCE_DIGITAL_PANTEDOKUMENT_V4" | "TRANSFER_CONTAINS_OF_OTHER_DEALS_TO_TINGLYSE_V4" | "TRANSFER_DEMANDS_ATTACHMENTS_V4" | "TRANSFER_FROM_OTHER_THAN_HJEMMELSHAVER_V4" | "TRANSFER_IS_INHERITANCE_V4" | "TRANSFER_CONTAINS_DELETION_OF_FESTEKONTRAKT_V4" | "TRANSFER_IS_BORETT_2_13_V4"; /** * @description A phrase describing a flow as an assumption. If the assumption is false, it means paper flow. (only served in Norwegian) * @example 'Minst en av partene må signere på papir.' (At least one actor cant't sign electronically) */ flowCriteria: string; /** * Format: int32 * @description Sorting order * @example 10 */ order: number; /** @description Long description of criteria */ longDescription: string; /** * Format: date-time * @description Created timestamp */ created: string; /** * Format: date-time * @description Last changed timestamp. */ updated: string; }; BrokerDeclarationTemplateResource: { declarations: components["schemas"]["BrokerDeclarationTemplate"][]; }; }; responses: never; parameters: never; requestBodies: never; headers: never; pathItems: never; } export type $defs = Record; export interface operations { getSettlement: { parameters: { query?: never; header?: never; path: { /** @description Settlement unique identifier */ uid: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Ok */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SettlementResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Settlement not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Settlement is removed. */ 410: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; updateSettlement: { parameters: { query?: never; header?: never; path: { /** @description Settlement unique identifier */ uid: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["SettlementRequest"]; }; }; responses: { /** @description Settlement updated */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SettlementResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Settlement not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; deleteSettlement: { parameters: { query?: { /** @description If set to true settlement will be deleted even if any bank intentions or mortgage documents exists */ forced?: boolean; }; header?: never; path: { /** @description Settlement unique identifier for settlement to delete. */ uid: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Settlement deleted */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; resendDocument: { parameters: { query?: never; header?: never; path: { /** @description Document unique id of previously sent mortgage document */ uid: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Document is resent */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DocumentResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Document not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; findSettlements: { parameters: { query?: { /** @description Buyer Personal Number */ buyerIdentificationNumber?: string[]; /** @description Property key */ propertyKey?: string; /** @description Find settlements where your organizations is a financial source */ isFinancialSource?: boolean; /** @description Find settlements created after date, only applied if 'isFinancialSource' is set. Format: yyyy-MM-ddTHH:mm:ss.SSS */ from?: string; /** @description Number of results per page/request */ size?: number; /** @description Page number (zero indexed) */ page?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Ok */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SettlementPagedResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; createSettlement: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["SettlementRequest"]; }; }; responses: { /** @description Settlement created */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SettlementResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; addSignedPurchaseContract: { parameters: { query?: never; header?: never; path: { uid: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["SignedPurchaseContractRequest"]; }; }; responses: { /** @description Signed purchase contract added */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SignedPurchaseContractResource"]; }; }; /** @description Bad request, settlement does not exist */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; createPurchaseContractRequest: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["PurchaseContractRequest"]; }; }; responses: { /** @description Request created */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PurchaseContractResource"]; }; }; /** @description Request processed and sent to broker. Check events for notification when reponse is received. */ 202: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PurchaseContractResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; setBankIntention: { parameters: { query?: never; header?: never; path: { /** * @description Purchase contract request uid. * @example KJO-2f634fbb-d9c3-46e3-a4ae-1c7577350cec */ requestuid: string; /** * @description Settlement UUID * @example SET-b5a424a9-a237-4afa-88b8-00fafb4c8ba8 */ settlementuid: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["BankIntentionFlowRequest"]; }; }; responses: { /** @description No content */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Purchase contract request not found or invalid status. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description You do not have access to this resource. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Given settlement is not related to the purchase contract request. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; getListOfDocuments: { parameters: { query: { /** @description Document status */ status: string[]; /** @description Include tinglyste documents */ includeTinglyste?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Ok */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DocumentResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; saveDocument: { parameters: { query?: { /** @description Settlement to add document to */ settlementuid?: string; }; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["DocumentRequest"]; }; }; responses: { /** @description Document created */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DocumentResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; saveTinglysingInformation: { parameters: { query?: never; header?: never; path: { /** @description Document unique id */ uid: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["DocumentDetailRequest"]; }; }; responses: { /** @description Details added to the document */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DocumentDetailRequest"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Document not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; createBankIntention: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["BankIntentionRequest"]; }; }; responses: { /** @description Successfully received by broker. Fetch the settlement with the 'settlementUniqueIdentifier' * to get the broker's data and registration method/flow. */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["BankIntentionResource"]; }; }; /** @description Sent to an external broker, awaiting response. When a response is available the event * 'INTENTION_RESPONSE_RECEIVED' is created. */ 202: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["BankIntentionResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; getAttachments: { parameters: { query: { /** @description Document unique id */ documentuid: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Ok */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AttachmentResource"][]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; saveAttachment: { parameters: { query: { /** @description Document unique id */ documentuid: string; }; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["AttachmentRequest"]; }; }; responses: { /** @description Attachment created */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AttachmentResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; removeSettlement: { parameters: { query?: never; header?: never; path: { uid: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Ok */ 200: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Settlement not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; getDeclarationsV2: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Ok */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["BrokerDeclarationTemplateV2Resource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; documentsForSettlement: { parameters: { query?: never; header?: never; path: { /** @description Settlement unique identifier */ uid: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Ok */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DocumentResource"][]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Settlement not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; brokerdeclaration: { parameters: { query?: never; header?: never; path: { /** @description Settlement unique identifier */ uid: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Ok */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["BrokerDeclarationResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Settlement not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; getPurchaseContractByUid: { parameters: { query?: never; header?: never; path: { /** * @description Purchase contract request unique identifier * @example KJO-2f634fbb-d9c3-46e3-a4ae-1c7577350cec */ requestuid: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Ok */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PurchaseContractResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Client is not authorized to access the given resource */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Purchase contract request not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Purchase contract request is replaced by a more recent request */ 410: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; cancelPurchaseContractRequest: { parameters: { query?: never; header?: never; path: { /** * @description Purchase contract request uid. * @example KJO-2f634fbb-d9c3-46e3-a4ae-1c7577350cec */ requestuid: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description All data regarding purchase contract request i removed */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description You do not have access to this resource. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; getSignedPurchaseContractFromRequest: { parameters: { query?: never; header?: never; path: { /** * @description Purchase contract request uid. * @example KJO-2f634fbb-d9c3-46e3-a4ae-1c7577350cec */ requestuid: string; /** * @description Settlement uid. * @example SET-1ec85753-1eec-465c-88f0-27cab92ee368 */ settlementuid: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Ok */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PurchaseContractPdfResource"]; }; }; /** @description Purchase contract request or settlement with given id not found */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description You do not have access to this resource. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Signed purchase contract as pdf is not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; getPurchaseContractAsPdf: { parameters: { query?: never; header?: never; path: { /** * @description Purchase contract request uid. * @example KJO-2f634fbb-d9c3-46e3-a4ae-1c7577350cec */ requestuid: string; /** * @description Settlement uid. * @example SET-1ec85753-1eec-465c-88f0-27cab92ee368 */ settlementuid: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Ok */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PurchaseContractPdfResource"]; }; }; /** @description Purchase contract request with given id not found */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description You do not have access to this resource. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Settlement with given id is not related to purchase contract request */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; epsPing: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Server error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Service Unavailable */ 503: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PingResponse"]; }; }; }; }; flowValidations: { parameters: { query?: never; header?: never; path: { /** * @description Propertykey * @example 4627-10-10 */ propertykey: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Ok */ 200: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["FlowValidationResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; findEvents: { parameters: { query?: { /** @description Settlement unique identifier */ settlementuid?: string; /** @description Event type */ eventtype?: string[]; /** * @description Starting from specific event id * @example 1000 */ fromeventid?: number; /** * @description Maximum number of events returned * @example 100 */ maximumNumberOfEvents?: number; /** @description Starting from creation date with format: yyyy-MM-ddTHH:mm:ss.SSS */ fromeventcreated?: string; /** @description Banks must use this query paramater to get events related to buyer contracts */ contractevents?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Ok */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EventResource"][]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; getEvent: { parameters: { query?: never; header?: never; path: { /** * @description Event incremental id * @example 1000 */ id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Ok */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EventResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Event not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; getDocument: { parameters: { query?: never; header?: never; path: { /** @description Document uniqueIdentifier */ uid: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Ok */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DocumentResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Document not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; getDocumentInfo: { parameters: { query?: never; header?: never; path: { /** @description Document unique id */ uid: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Ok */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Document"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Document not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; getAllAttachments: { parameters: { query?: { /** @description Attachment type */ attachmenttype?: components["schemas"]["AttachmentType"][]; }; header?: never; path: { /** @description Document uniqueIdentifier */ uid: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Ok */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AttachmentResource"][]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; getEventCodes: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Ok */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EventCodesResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; getEventCode: { parameters: { query?: never; header?: never; path: { /** @description Event code */ code: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Ok */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EpsCode"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Code not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; getErrorCodes: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Ok */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EventCodesResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; getErrorCode: { parameters: { query?: never; header?: never; path: { /** @description Error code */ code: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Ok */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EpsCode"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Code not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; getDeclarations: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Ok */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["BrokerDeclarationTemplateResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; getIntention: { parameters: { query?: never; header?: never; path: { /** @description Bank intention unique identifier */ uid: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Ok */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["BankIntentionResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Bank intention not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; getAttachment: { parameters: { query?: never; header?: never; path: { /** @description Attachment unique id */ uid: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Ok */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AttachmentResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Attachment not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; existsInAkeldo: { parameters: { query?: never; header?: never; path: { /** @description Organization number */ organizationNumber: string; /** @description Akeldo message Type */ messageType: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Found in akeldo */ 200: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Not found in akeldo */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; ambitaBrokers: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Liste over alle Ambita meglere */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OrganizationDto"][]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; stopEventsOnSettlement: { parameters: { query?: never; header?: never; path: { /** * @description Purchase contract request uid. * @example KJO-2f634fbb-d9c3-46e3-a4ae-1c7577350cec */ requestuid: string; /** * @description Settlement uid. * @example SET-1ec85753-1eec-465c-88f0-27cab92ee368 */ settlementuid: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Settlement removed from purchas contract request data */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Purchase contract request with given id not found */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description You do not have access to this resource. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "*/*": components["schemas"]["ErrorResponse"]; }; }; }; }; } type WithRequired = T & { [P in K]-?: T[P]; };