{"info":{"title":"AutoXChange API","description":"### Changelog\n#### 2026-04-27 10:50 UTC id:d0f42153 (0.85.641)\n\n#### 2026-04-24 07:29 UTC id:92d6a33a (0.85.640)\n\n#### 2026-04-22 11:59 UTC id:c75c7985 (0.85.639)\n\n#### 2026-04-21 16:58 UTC id:c365d3bd (0.85.638)\n\n#### 2026-04-20 10:18 UTC id:26914142 (0.85.637)\n\n\n### Credentials\n\nThe API consumer is authenticated as a company and a user using the Company UUID and the personal User API Key. OAuth2 client_credentials flow is used for authentication, more details about the authentication can be found from the OAuth2 endpoint.\n\n### Timestamps\n\nTimestamps returned by the API is be presented as UTC and in the ISO8601 format. Timestamps provided in the requests should also be presented in this way.\n \n```\n2016-09-23T09:09:06Z\n```\n\n### Experimental endpoints\n\nAPI endpoints tagged with `[EXPERIMENTAL]` should be considered as work in progress making them subject to change. \n\nOnce the tag is removed, the contracts for these endpoints should be considered stable.\n\n### Error handling\nErrors are presented using the HTTP status codes 400-599. The response include a more detailed explanation about the error in the body.\n\n```\n{\n  \"code\": \"internal_error_code\",\n  \"message\": \"Cleartext explanation of the error that occurred\",\n  \"details\": [\n    \"More details\",\n    \"about the error\"\n  ]\n}\n```\n\n### Generic API errors\nThese error responses can be returned by any of the described endpoints.\n\n| HTTP status  |  Description |\n|---|---|\n| 400| Bad input parameters or invalid request. More information can be found in the response body.\n| 401| The consumer does not have access to the requested resource or the provided token is not valid.\n| 404| The requested resource can not be found or the user does not have access to the resource.\n| 5XX| A server error has occurred while processing the request.\n\n","version":"0.85.642"},"swagger":"2.0","produces":["application/json"],"securityDefinitions":{"company_auth":{"type":"oauth2","tokenUrl":"/oauth2/token","flow":"application","scopes":{"eui":"Recommended to use when integrating to EUI. Alias for eui:open, company:read, company:write, lookup, receivables:assignments, document:send, document:receive, invoice:receive, invoice:send, analysis","global":"Alias for company:read, document:receive, document:send, lookup","company":"Alias for company:read, company:write","lookup":"grants access to the lookup operations","document:receive":"grants access to document receive operations","document:send":"grants access to document send operations","invoice:receive":"grants access to invoice receive operations","invoice:send":"grants access to invoice send operations","company:read":"grants read access to company settings, profiles and notifications","company:write":"grants write access to company settings, profiles and notifications","validate":"grants access to the AutoInvoice validator service","receivables:assignments":"grants access to assignments in the collection services","analysis":"grants access to analysis service","billing:reports":"grants access to billing reports","partner:invoice_delivery_actions":"grants access to partner invoice actions","partner:lookups":"grants access to partner lookup actions","partner:takeovers":"grants access to partner takeovers","partner:lyanthe_scan_service":"grants access to partner lyanthe scan service actions","fi_bank_message:send":"grants access to FI bank message send operations","fi_bank_message:receive":"grants access to FI bank message receive operations"}},"operator_auth":{"type":"oauth2","tokenUrl":"/oauth2/token","flow":"application","scopes":{"operator:documents:receive":"grants access to fetch received documents","operator:documents:send":"grants access to send documents","operator:lookup":"grants access to perform actions related to lookups","operator:participants":"grants access to perform actions on operator participants","operator:notifications":"grants access to perform actions on operator notifications","operator:validate":"grants access to the AutoInvoice validator service","operator:receivables:assignments":"grants access to assignments in the collection services","operator:receivables:assignments:create":"grants access to create assignments in the collection services","operator:receivables:webhooks":"grants access to send collection services webhooks","operator:receivables:account_statement":"grants access to account statements","operator:analysis":"grants access to analysis service","operator:companies":"grants access to fetch operator companies","operator:takeover":"grants access to execute a company takeover","operator:billing:actions":"grants access to operator billing actions","operator:sending_parties:write":"grants access to write sending parties","operator:supplier_bank_accounts:write":"grants access to write supplier bank accounts","operator:user:create":"grants access to create a user","operator:company:read":"grants access to read company profiles","operator:company:write":"grants access to write company profiles"}}},"host":"ax.maventa.com","tags":[{"name":"status","description":"Operations about statuses"},{"name":"oauth2","description":"Operations about oauth2s"},{"name":"odp","description":"Operations about odps"},{"name":"services","description":"Operations about services"},{"name":"invoices","description":"Operations about invoices"},{"name":"company","description":"Operations about companies"},{"name":"companies","description":"Operations about companies"},{"name":"operator","description":"Operations about operators"},{"name":"lookup","description":"Operations about lookups"},{"name":"jwk","description":"Operations about jwks"},{"name":"definitions","description":"Operations about definitions"},{"name":"users","description":"Operations about users"},{"name":"files","description":"Operations about files"},{"name":"documents","description":"Operations about documents"},{"name":"analysis","description":"Operations about analyses"},{"name":"partner","description":"Operations about partners"},{"name":"fi_bank_messages","description":"Operations about fi_bank_messages"}],"paths":{"/status/authenticated":{"get":{"summary":"Status requiring authentication","description":"Returns information of currently authenticated identity. Only for testing purposes.","produces":["application/json"],"security":[{"company_auth":["global"]}],"responses":{"200":{"description":"Status requiring authentication","schema":{"$ref":"#/definitions/API_Entities_Status"}}},"tags":["status"],"operationId":"getStatusAuthenticated"}},"/oauth2/token":{"post":{"summary":"OAuth2 token endpoint","description":"The endpoint enables a registered company to obtain a OAuth 2 Bearer Token, which can be used to access the companys data in all the future API calls.\n A token will be active for 60 minutes.\n #### Scopes\n Scopes let you specify what type of access you need and limit access for granted OAuth tokens.\n\n | Scope | Description |\n |-------|-------------|\n                            eui|  Recommended to use when integrating to EUI. Alias for eui:open, company:read, company:write, lookup, receivables:assignments, document:send, document:receive, invoice:receive, invoice:send, analysis|\n                        global|                                                                                                                                         Alias for company:read, document:receive, document:send, lookup|\n                       company|                                                                                                                                                                   Alias for company:read, company:write|\n                        lookup|                                                                                                                                                                  grants access to the lookup operations|\n              document:receive|                                                                                                                                                            grants access to document receive operations|\n                 document:send|                                                                                                                                                               grants access to document send operations|\n               invoice:receive|                                                                                                                                                             grants access to invoice receive operations|\n                  invoice:send|                                                                                                                                                                grants access to invoice send operations|\n                  company:read|                                                                                                                                      grants read access to company settings, profiles and notifications|\n                 company:write|                                                                                                                                     grants write access to company settings, profiles and notifications|\n                      validate|                                                                                                                                                      grants access to the AutoInvoice validator service|\n       receivables:assignments|                                                                                                                                                 grants access to assignments in the collection services|\n                      analysis|                                                                                                                                                                       grants access to analysis service|\n               billing:reports|                                                                                                                                                                        grants access to billing reports|\npartner:invoice_delivery_actions|                                                                                                                                                                grants access to partner invoice actions|\n               partner:lookups|                                                                                                                                                                 grants access to partner lookup actions|\n             partner:takeovers|                                                                                                                                                                      grants access to partner takeovers|\n  partner:lyanthe_scan_service|                                                                                                                                                   grants access to partner lyanthe scan service actions|\n          fi_bank_message:send|                                                                                                                                                        grants access to FI bank message send operations|\n       fi_bank_message:receive|                                                                                                                                                     grants access to FI bank message receive operations|\n    operator:documents:receive|                                                                                                                                                               grants access to fetch received documents|\n       operator:documents:send|                                                                                                                                                                         grants access to send documents|\n               operator:lookup|                                                                                                                                                     grants access to perform actions related to lookups|\n         operator:participants|                                                                                                                                               grants access to perform actions on operator participants|\n        operator:notifications|                                                                                                                                              grants access to perform actions on operator notifications|\n             operator:validate|                                                                                                                                                      grants access to the AutoInvoice validator service|\noperator:receivables:assignments|                                                                                                                                                 grants access to assignments in the collection services|\noperator:receivables:assignments:create|                                                                                                                                          grants access to create assignments in the collection services|\n operator:receivables:webhooks|                                                                                                                                                      grants access to send collection services webhooks|\noperator:receivables:account_statement|                                                                                                                                                                     grants access to account statements|\n             operator:analysis|                                                                                                                                                                       grants access to analysis service|\n            operator:companies|                                                                                                                                                               grants access to fetch operator companies|\n             operator:takeover|                                                                                                                                                             grants access to execute a company takeover|\n      operator:billing:actions|                                                                                                                                                               grants access to operator billing actions|\noperator:sending_parties:write|                                                                                                                                                                  grants access to write sending parties|\noperator:supplier_bank_accounts:write|                                                                                                                                                           grants access to write supplier bank accounts|\n          operator:user:create|                                                                                                                                                                          grants access to create a user|\n         operator:company:read|                                                                                                                                                                  grants access to read company profiles|\n        operator:company:write|                                                                                                                                                                 grants access to write company profiles\n\n If no scope is defined, the token request will default to use the scopes ```global``` and ```company```. The granted scopes will be returned in the response.\n #### Vendor API key and license data\n To identify the application a valid ```vendor_api_key``` should be provided in the token request. Additional license data can be provided as JSON in the ```license_data``` parameter:\n ```\n{\n  \"key\": \"C84411ED-5639-4B48-83D0-B718BB9DA0F7\", // License key of software making the call\n  \"meta\": {\n    \"licensing\":   \"VLS\",       // Information about the licensing system\n    \"erp_name\":    \"Visma ERP\", // Name of ERP\n    \"erp_version\": \"1.1\",       // Current version number of ERP\n    \"erp_user\":    \"rbaardse\"   // Local ERP user name\n  }\n}\n```\n","produces":["application/json"],"consumes":["application/x-www-form-urlencoded"],"parameters":[{"in":"formData","name":"grant_type","description":"The grant type","type":"string","enum":["client_credentials"],"required":true},{"in":"formData","name":"client_id","description":"The client id","type":"string","required":false},{"in":"formData","name":"client_secret","description":"The client secret","type":"string","required":false},{"in":"formData","name":"scope","description":"Scope of the requested token","type":"string","required":false},{"in":"formData","name":"vendor_api_key","description":"Software API key","type":"string","required":false},{"in":"formData","name":"license_data","description":"License data","type":"string","required":false}],"responses":{"200":{"description":"Granted access token","schema":{"$ref":"#/definitions/API_Entities_OAuthToken"}}},"tags":["oauth2"],"operationId":"postOauth2Token"}},"/oauth2/current":{"get":{"summary":"Fetch information about the authenticated user and company","description":"","produces":["application/json"],"security":[{"company_auth":["global"]}],"responses":{"200":{"description":"Fetch information about the authenticated user and company","schema":{"$ref":"#/definitions/API_Entities_OAuthCurrent"}}},"tags":["oauth2"],"operationId":"getOauth2Current"}},"/odp/companies/{id}":{"get":{"description":"Fetch ODP company by id","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of ODP company","type":"integer","format":"int32","required":true}],"security":[{"company_auth":["global"]}],"responses":{"200":{"description":"Fetch ODP company by id","schema":{"$ref":"#/definitions/OdpCompany"}}},"tags":["odp"],"operationId":"getOdpCompaniesId"},"patch":{"description":"Update existing ODP company or create a new one if missing","produces":["application/json"],"consumes":["multipart/form-data"],"parameters":[{"in":"path","name":"id","description":"ID of ODP company","type":"integer","format":"int32","required":true},{"in":"formData","name":"trusted","description":"Is company trusted","type":"boolean","required":true}],"security":[{"company_auth":["global"]}],"responses":{"204":{"description":"Company updated succesfully"}},"tags":["odp"],"operationId":"patchOdpCompaniesId"}},"/v2/services/amili/receivables":{"get":{"summary":"Current state of the Amili collection services","description":"","produces":["application/json"],"security":[{"company_auth":["company:read"]}],"responses":{"200":{"description":"Current state of the Amili collection services","schema":{"$ref":"#/definitions/ReceivablesService"}}},"tags":["services"],"operationId":"getV2ServicesAmiliReceivables"},"put":{"summary":"Start the Amili collection services onboarding","description":"","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"putV2ServicesAmiliReceivables","in":"body","required":true,"schema":{"$ref":"#/definitions/putV2ServicesAmiliReceivables"}}],"security":[{"company_auth":["company:write"]}],"responses":{"200":{"description":"Start the Amili collection services onboarding","schema":{"$ref":"#/definitions/ReceivablesService"}}},"tags":["services"],"operationId":"putV2ServicesAmiliReceivables"},"delete":{"summary":"Disable the Amili collection services","description":"","produces":["application/json"],"security":[{"company_auth":["company:write"]}],"responses":{"204":{"description":"Service disabled"}},"tags":["services"],"operationId":"deleteV2ServicesAmiliReceivables"},"patch":{"summary":"Update the Amili collection services","description":"","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"patchV2ServicesAmiliReceivables","in":"body","required":true,"schema":{"$ref":"#/definitions/patchV2ServicesAmiliReceivables"}}],"security":[{"company_auth":["company:write"]}],"responses":{"204":{"description":"Update successful"}},"tags":["services"],"operationId":"patchV2ServicesAmiliReceivables"}},"/v2/services/intrum/receivables":{"put":{"summary":"Start the Intrum collection services onboarding","description":"","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"putV2ServicesIntrumReceivables","in":"body","required":true,"schema":{"$ref":"#/definitions/putV2ServicesIntrumReceivables"}}],"security":[{"company_auth":["company:write"]}],"responses":{"201":{"description":"Start the Intrum collection services onboarding","schema":{"$ref":"#/definitions/API_Entities_CompanyServices_Intrum"}}},"tags":["services"],"operationId":"putV2ServicesIntrumReceivables"},"patch":{"summary":"Update the Intrum collection services","description":"","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"patchV2ServicesIntrumReceivables","in":"body","required":true,"schema":{"$ref":"#/definitions/patchV2ServicesIntrumReceivables"}}],"security":[{"company_auth":["company:write"]}],"responses":{"204":{"description":"Update successful"}},"tags":["services"],"operationId":"patchV2ServicesIntrumReceivables"},"get":{"summary":"Current state of the Intrum collection services","description":"","produces":["application/json"],"security":[{"company_auth":["company:read"]}],"responses":{"200":{"description":"Current state of the Intrum collection services","schema":{"$ref":"#/definitions/API_Entities_CompanyServices_Intrum"}}},"tags":["services"],"operationId":"getV2ServicesIntrumReceivables"},"delete":{"summary":"Disable the Intrum collection services","description":"","produces":["application/json"],"security":[{"company_auth":["company:write"]}],"responses":{"204":{"description":"Service disabled"}},"tags":["services"],"operationId":"deleteV2ServicesIntrumReceivables"}},"/v2/services/ropo/receivables":{"put":{"summary":"Start the Ropo collection services onboarding [EXPERIMENTAL]","description":"","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"putV2ServicesRopoReceivables","in":"body","required":true,"schema":{"$ref":"#/definitions/putV2ServicesRopoReceivables"}}],"security":[{"company_auth":["company:write"]}],"responses":{"201":{"description":"Start the Ropo collection services onboarding","schema":{"$ref":"#/definitions/API_Entities_CompanyServices_Ropo"}}},"tags":["services"],"operationId":"putV2ServicesRopoReceivables"}},"/v2/services/receivables":{"get":{"summary":"Current state of the collection services","description":"","produces":["application/json"],"security":[{"company_auth":["company:read"]}],"responses":{"200":{"description":"Current state of the collection services","schema":{"$ref":"#/definitions/API_Entities_CompanyServices_ReceivablesDetails"}}},"tags":["services"],"operationId":"getV2ServicesReceivables"}},"/v1/services/receivables":{"get":{"summary":"Current state of the collection services","description":"","produces":["application/json"],"security":[{"company_auth":["company:read"]}],"responses":{"200":{"description":"Current state of the collection services","schema":{"$ref":"#/definitions/ReceivablesService"}}},"tags":["services"],"operationId":"getV1ServicesReceivables"},"put":{"summary":"Start the collection services onboarding","description":"","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"putV1ServicesReceivables","in":"body","required":true,"schema":{"$ref":"#/definitions/putV1ServicesReceivables"}}],"security":[{"company_auth":["company:write"]}],"responses":{"200":{"description":"Start the collection services onboarding","schema":{"$ref":"#/definitions/ReceivablesService"}}},"tags":["services"],"operationId":"putV1ServicesReceivables"},"delete":{"summary":"Disable the collection services","description":"","produces":["application/json"],"security":[{"company_auth":["company:write"]}],"responses":{"204":{"description":"Service disabled"}},"tags":["services"],"operationId":"deleteV1ServicesReceivables"},"patch":{"summary":"Update the collection services","description":"","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"patchV1ServicesReceivables","in":"body","required":true,"schema":{"$ref":"#/definitions/patchV1ServicesReceivables"}}],"security":[{"company_auth":["company:write"]}],"responses":{"204":{"description":"Update successful"}},"tags":["services"],"operationId":"patchV1ServicesReceivables"}},"/v1/services/atg":{"get":{"summary":"List ATG agreements","description":"","produces":["application/json"],"security":[{"company_auth":["company:read"]}],"responses":{"200":{"description":"List ATG agreements","schema":{"type":"array","items":{"$ref":"#/definitions/API_Entities_CompanyAgreements_Atg"}}}},"tags":["services"],"operationId":"getV1ServicesAtg"},"post":{"summary":"Create a new ATG agreement","description":"","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postV1ServicesAtg","in":"body","required":true,"schema":{"$ref":"#/definitions/postV1ServicesAtg"}}],"security":[{"company_auth":["company:write"]}],"responses":{"201":{"description":"Create a new ATG agreement","schema":{"$ref":"#/definitions/API_Entities_CompanyAgreements_Atg"}}},"tags":["services"],"operationId":"postV1ServicesAtg"}},"/v1/services/atg/mandates":{"get":{"summary":"List B2C ATG mandates","description":"","produces":["application/json"],"parameters":[{"in":"query","name":"query","description":"Find by KID or reference","type":"string","required":false},{"in":"query","name":"timestamp","description":"Timestamp for latest update","type":"string","format":"date-time","required":false},{"in":"query","name":"status","description":"Status","type":"string","enum":["ACTIVE","INACTIVE"],"required":false},{"in":"query","name":"parse_values","description":"Parse reference and payment type from KID.Only works for <20 results","type":"string","enum":["TRUE","FALSE"],"required":false},{"in":"query","name":"page","description":"Page to fetch","type":"integer","format":"int32","default":1,"required":false},{"in":"query","name":"per_page","description":"Number of items per page, values up to 100 supported","type":"integer","format":"int32","default":20,"required":false}],"security":[{"company_auth":["company:read"]}],"responses":{"200":{"description":"List B2C ATG mandates","schema":{"type":"array","items":{"$ref":"#/definitions/API_Entities_CompanyConsumers_Mandate"}}}},"tags":["services"],"operationId":"getV1ServicesAtgMandates"}},"/v1/services/atg/{account_number}":{"get":{"summary":"Fetch ATG agreement","description":"","produces":["application/json"],"parameters":[{"in":"path","name":"account_number","description":"Account number","type":"string","required":true}],"security":[{"company_auth":["company:read"]}],"responses":{"200":{"description":"Fetch ATG agreement","schema":{"$ref":"#/definitions/API_Entities_CompanyAgreements_Atg"}}},"tags":["services"],"operationId":"getV1ServicesAtgAccountNumber"},"patch":{"summary":"Update existing ATG agreement","description":"","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"account_number","description":"Account number linked to agreement","type":"string","required":true},{"name":"patchV1ServicesAtgAccountNumber","in":"body","required":true,"schema":{"$ref":"#/definitions/patchV1ServicesAtgAccountNumber"}}],"security":[{"company_auth":["company:write"]}],"responses":{"204":{"description":"ATG agreement updated succesfully"}},"tags":["services"],"operationId":"patchV1ServicesAtgAccountNumber"}},"/v1/services/detect/checks":{"get":{"summary":"List enabled Detect checks","description":"","produces":["application/json"],"security":[{"company_auth":["company:read"]}],"responses":{"200":{"description":"List enabled Detect checks","schema":{"$ref":"#/definitions/Detect_Checks"}}},"tags":["services"],"operationId":"getV1ServicesDetectChecks"},"patch":{"summary":"Update Detect checks","description":"","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"on_invoice_receive","description":"List of checks to enable. Currently supported checks: SUPPLIER_ACTIVATION, BANK_ACCOUNT_CHANGED, SENDER_BID_STATUS, SENDER_WARNING_LIST, VAT","type":"array","items":{"type":"string","enum":["SUPPLIER_ACTIVATION","BANK_ACCOUNT_CHANGED","SENDER_BID_STATUS","SENDER_WARNING_LIST","VAT"]},"required":false}],"security":[{"company_auth":["company:write"]}],"responses":{"204":{"description":"Detect checks updated successfully"}},"tags":["services"],"operationId":"patchV1ServicesDetectChecks"}},"/v1/services/autoscan":{"get":{"summary":"Current AutoScan configuration","description":"","produces":["application/json"],"security":[{"company_auth":["company:read"]}],"responses":{"200":{"description":"Show AutoScan configuration","schema":{"$ref":"#/definitions/AutoScan_HttpApi_Entities_AutoScanConfiguration"}},"503":{"description":"Service unavailable. Try again later."}},"tags":["services"],"operationId":"getV1ServicesAutoscan"},"put":{"summary":"Activates AutoScan","description":"","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"putV1ServicesAutoscan","in":"body","required":true,"schema":{"$ref":"#/definitions/putV1ServicesAutoscan"}}],"security":[{"company_auth":["company:write"]}],"responses":{"200":{"description":"Show activated AutoScan configuration","schema":{"$ref":"#/definitions/AutoScan_HttpApi_Entities_AutoScanConfiguration"}},"503":{"description":"Service unavailable. Try again later."}},"tags":["services"],"operationId":"putV1ServicesAutoscan"},"delete":{"summary":"Deactivates AutoScan","description":"","produces":["application/json"],"security":[{"company_auth":["company:write"]}],"responses":{"204":{"description":"AutoScan deactivated"},"503":{"description":"Service unavailable. Try again later."}},"tags":["services"],"operationId":"deleteV1ServicesAutoscan"}},"/v1/services/scan":{"get":{"summary":"Current Scan configuration","description":"","produces":["application/json"],"security":[{"company_auth":["company:read"]}],"responses":{"200":{"description":"Show scan configuration","schema":{"$ref":"#/definitions/Scan_HttpApi_Entities_ScanConfiguration"}},"401":{"description":"Unauthorized"},"500":{"description":"Service unavailable. Try again later."}},"tags":["services"],"operationId":"getV1ServicesScan"},"post":{"summary":"Activate scan account","description":"","produces":["application/json"],"consumes":["multipart/form-data"],"parameters":[{"in":"formData","name":"return_address[email_address]","type":"string","required":false},{"in":"formData","name":"return_address[postal_address][street_name]","type":"string","required":false},{"in":"formData","name":"return_address[postal_address][extra_lines]","type":"array","items":{"type":"string"},"required":false},{"in":"formData","name":"return_address[postal_address][city]","type":"string","required":false},{"in":"formData","name":"return_address[postal_address][post_code]","type":"string","required":false},{"in":"formData","name":"return_address[postal_address][country_code]","type":"string","required":false}],"security":[{"company_auth":["company:write"]}],"responses":{"200":{"description":"Activate scan account"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"500":{"description":"Service unavailable. Try again later."}},"tags":["services"],"operationId":"postV1ServicesScan"},"put":{"summary":"Update scan account","description":"","produces":["application/json"],"consumes":["multipart/form-data"],"parameters":[{"in":"formData","name":"return_address[email_address]","type":"string","required":false},{"in":"formData","name":"return_address[postal_address][street_name]","type":"string","required":false},{"in":"formData","name":"return_address[postal_address][extra_lines]","type":"array","items":{"type":"string"},"required":false},{"in":"formData","name":"return_address[postal_address][city]","type":"string","required":false},{"in":"formData","name":"return_address[postal_address][post_code]","type":"string","required":false},{"in":"formData","name":"return_address[postal_address][country_code]","type":"string","required":false}],"security":[{"company_auth":["company:write"]}],"responses":{"200":{"description":"Update scan account"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"500":{"description":"Service unavailable. Try again later."}},"tags":["services"],"operationId":"putV1ServicesScan"},"delete":{"summary":"Deactivate scan account","description":"","produces":["application/json"],"security":[{"company_auth":["company:write"]}],"responses":{"204":{"description":"Scan account deleted"},"401":{"description":"Unauthorized"},"400":{"description":"Bad request"},"404":{"description":"Scan account not found"},"500":{"description":"Service unavailable. Try again later."}},"tags":["services"],"operationId":"deleteV1ServicesScan"}},"/v1/services/ksef/tokens":{"get":{"description":"Fetch KSeF tokens","produces":["application/json"],"security":[{"company_auth":["company:read"]}],"responses":{"200":{"description":"Fetch KSeF tokens"},"401":{"description":"Unauthorized"},"500":{"description":"Service unavailable. Try again later."}},"tags":["services"],"operationId":"getV1ServicesKsefTokens"},"post":{"description":"Create a KSeF token","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postV1ServicesKsefTokens","in":"body","required":true,"schema":{"$ref":"#/definitions/postV1ServicesKsefTokens"}}],"security":[{"company_auth":["company:write"]}],"responses":{"201":{"description":"Create a KSeF token"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"500":{"description":"Service unavailable. Try again later."}},"tags":["services"],"operationId":"postV1ServicesKsefTokens"}},"/v1/services/ksef/tokens/{id}":{"delete":{"description":"Delete a KSeF token","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"string","required":true}],"security":[{"company_auth":["company:write"]}],"responses":{"204":{"description":"Token deleted"},"401":{"description":"Unauthorized"},"404":{"description":"Token not found"},"500":{"description":"Service unavailable. Try again later."}},"tags":["services"],"operationId":"deleteV1ServicesKsefTokensId"}},"/v1/services/b2cno/consumers":{"get":{"summary":"List B2CNO Consumers - DEPRECATED 2025","description":"","produces":["application/json"],"parameters":[{"in":"query","name":"query","description":"List by phonenumber, name, customer_number and reference_number","type":"string","required":false},{"in":"query","name":"status","description":"List of statuses","type":"array","items":{"type":"string","enum":["NEW","REQUEST_SENT","ACCEPTED","ACTIVE","DELETED","REJECTED","ERROR"]},"required":false},{"in":"query","name":"page","description":"Page to fetch","type":"integer","format":"int32","default":1,"required":false},{"in":"query","name":"per_page","description":"Number of items per page, values up to 100 supported","type":"integer","format":"int32","default":20,"required":false}],"security":[{"company_auth":["company:read"]}],"responses":{"200":{"description":"List B2CNO Consumers - DEPRECATED 2025","schema":{"type":"array","items":{"$ref":"#/definitions/API_Entities_CompanyConsumers_Consumer"}}}},"tags":["services"],"operationId":"getV1ServicesB2cnoConsumers"}},"/v1/services/b2cno":{"get":{"summary":"Information about B2CNO agreement","description":"","produces":["application/json"],"security":[{"company_auth":["company:read"]}],"responses":{"200":{"description":"Information about B2CNO agreement","schema":{"$ref":"#/definitions/API_Entities_B2CNO_Status"}}},"tags":["services"],"operationId":"getV1ServicesB2cno"}},"/v1/services/b2cse/agreement":{"post":{"summary":"Create B2CSE network registration request","description":"[EXPERIMENTAL] Open B2CSE network agreement with the details gotten from the bank. If FUI and agreement ID are not given, a new bank agreement will be created for B2C traffic.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postV1ServicesB2cseAgreement","in":"body","required":true,"schema":{"$ref":"#/definitions/postV1ServicesB2cseAgreement"}}],"security":[{"company_auth":["company:write"]}],"responses":{"204":{"description":""},"400":{"description":"","schema":{"$ref":"#/definitions/API_Entities_Error"}},"422":{"description":"","schema":{"$ref":"#/definitions/API_Entities_Error"}},"500":{"description":"","schema":{"$ref":"#/definitions/API_Entities_Error"}}},"tags":["services"],"operationId":"postV1ServicesB2cseAgreement"},"get":{"summary":"Get status of B2CSE network reqistration request","description":"[EXPERIMENTAL] Get status of B2CSE network reqistration request","produces":["application/json"],"security":[{"company_auth":["company:read"]}],"responses":{"200":{"description":"","schema":{"$ref":"#/definitions/API_Entities_B2CSE_Agreement"}},"404":{"description":"","schema":{"$ref":"#/definitions/API_Entities_Error"}},"422":{"description":"","schema":{"$ref":"#/definitions/API_Entities_Error"}},"500":{"description":"","schema":{"$ref":"#/definitions/API_Entities_Error"}}},"tags":["services"],"operationId":"getV1ServicesB2cseAgreement"}},"/v2/invoices/{id}/assignment":{"get":{"description":"Get assignment for invoice","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Invoice ID","type":"string","required":true}],"security":[{"company_auth":["invoice:send"]}],"responses":{"200":{"description":"Return only the assignment status and error reason when in pending or error. Ok status returns the link to the assignment in the Receivables API when the assignment request has been completed.","schema":{"$ref":"#/definitions/Invoices_HttpApi_Entities_InvoiceAssignmentV2"}},"404":{"description":"- **not_found**: Requested resource not found or you don't have access to it","schema":{"$ref":"#/definitions/API_Entities_Error"}}},"tags":["invoices"],"operationId":"getV2InvoicesIdAssignment"}},"/v2/invoices/{id}/assignment/ropo":{"post":{"description":"Post assignment for invoice","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Invoice ID","type":"string","required":true},{"name":"postV2InvoicesIdAssignmentRopo","in":"body","required":true,"schema":{"$ref":"#/definitions/postV2InvoicesIdAssignmentRopo"}}],"security":[{"company_auth":["invoice:send"]}],"responses":{"202":{"description":"Assignment request has been accepted for processing"},"404":{"description":"- **not_found**: Requested resource not found or you don't have access to it","schema":{"$ref":"#/definitions/API_Entities_Error"}},"400":{"description":"- **invalid_parameters**: Request parameters are invalid","schema":{"$ref":"#/definitions/API_Entities_Error"}},"403":{"description":"- **forbidden**: Requested operation for resource is not allowed","schema":{"$ref":"#/definitions/API_Entities_Error"}}},"tags":["invoices"],"operationId":"postV2InvoicesIdAssignmentRopo"}},"/v2/invoices/{id}/assignment/intrum":{"post":{"description":"Post assignment for invoice","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Invoice ID","type":"string","required":true},{"name":"postV2InvoicesIdAssignmentIntrum","in":"body","required":true,"schema":{"$ref":"#/definitions/postV2InvoicesIdAssignmentIntrum"}}],"security":[{"company_auth":["invoice:send"]}],"responses":{"202":{"description":"Assignment request has been accepted for processing"},"404":{"description":"- **not_found**: Requested resource not found or you don't have access to it","schema":{"$ref":"#/definitions/API_Entities_Error"}},"400":{"description":"- **invalid_parameters**: Request parameters are invalid","schema":{"$ref":"#/definitions/API_Entities_Error"}},"403":{"description":"- **forbidden**: Requested operation for resource is not allowed","schema":{"$ref":"#/definitions/API_Entities_Error"}}},"tags":["invoices"],"operationId":"postV2InvoicesIdAssignmentIntrum"}},"/v2/invoices/{id}/assignment/amili":{"post":{"description":"Post assignment for invoice","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Invoice ID","type":"string","required":true},{"name":"postV2InvoicesIdAssignmentAmili","in":"body","required":true,"schema":{"$ref":"#/definitions/postV2InvoicesIdAssignmentAmili"}}],"security":[{"company_auth":["invoice:send"]}],"responses":{"202":{"description":"Assignment request has been accepted for processing"},"404":{"description":"- **not_found**: Requested resource not found or you don't have access to it","schema":{"$ref":"#/definitions/API_Entities_Error"}},"400":{"description":"- **invalid_parameters**: Request parameters are invalid","schema":{"$ref":"#/definitions/API_Entities_Error"}},"403":{"description":"- **forbidden**: Requested operation for resource is not allowed","schema":{"$ref":"#/definitions/API_Entities_Error"}}},"tags":["invoices"],"operationId":"postV2InvoicesIdAssignmentAmili"}},"/v1/invoices/{id}/assignment":{"get":{"description":"Get assignment for invoice","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Invoice ID","type":"string","required":true}],"security":[{"company_auth":["invoice:send"]}],"responses":{"200":{"description":"Return only the assignment status and error reason when in pending or error. Ok status returns the link to the assignment in the collection services API when the assignment request has been completed.","schema":{"$ref":"#/definitions/Invoices_HttpApi_Entities_InvoiceAssignment"}},"404":{"description":"- **not_found**: Requested resource not found or you don't have access to it","schema":{"$ref":"#/definitions/API_Entities_Error"}}},"tags":["invoices"],"operationId":"getV1InvoicesIdAssignment"},"post":{"description":"Post assignment for invoice","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Invoice ID","type":"string","required":true},{"name":"postV1InvoicesIdAssignment","in":"body","required":true,"schema":{"$ref":"#/definitions/postV1InvoicesIdAssignment"}}],"security":[{"company_auth":["invoice:send"]}],"responses":{"202":{"description":"Assignment request has been accepted for processing"},"404":{"description":"- **not_found**: Requested resource not found or you don't have access to it","schema":{"$ref":"#/definitions/API_Entities_Error"}},"400":{"description":"- **invalid_parameters**: Request parameters are invalid","schema":{"$ref":"#/definitions/API_Entities_Error"}},"403":{"description":"- **forbidden**: Requested operation for resource is not allowed","schema":{"$ref":"#/definitions/API_Entities_Error"}}},"tags":["invoices"],"operationId":"postV1InvoicesIdAssignment"}},"/v1/invoices/reports/definitions":{"get":{"description":"Get useful definitions for user reports","produces":["application/json"],"responses":{"200":{"description":"","schema":{"$ref":"#/definitions/ReportsDefinitions"}}},"tags":["invoices"],"operationId":"getV1InvoicesReportsDefinitions"}},"/v1/invoices":{"get":{"summary":"List invoices","description":"","produces":["application/json"],"parameters":[{"in":"query","name":"direction","description":"Received or sent invoices","type":"string","default":"RECEIVED","enum":["RECEIVED","SENT"],"required":false},{"in":"query","name":"status","description":"Invoice status","type":"array","items":{"type":"string","enum":["PENDING","DELIVERED","FAILED"]},"required":false},{"in":"query","name":"ids","description":"Batch of invoice IDs. Maximum of 100 per query","type":"array","items":{"type":"string"},"required":false},{"in":"query","name":"number","description":"Invoice number","type":"string","required":false},{"in":"query","name":"reference","description":"Invoice reference","type":"string","required":false},{"in":"query","name":"received_at_start","description":"Received at start timestamp","type":"string","format":"date-time","required":false},{"in":"query","name":"received_at_end","description":"Received at end timestamp","type":"string","format":"date-time","required":false},{"in":"query","name":"created_at_start","description":"Created at start timestamp","type":"string","format":"date-time","required":false},{"in":"query","name":"created_at_end","description":"Created at end timestamp","type":"string","format":"date-time","required":false},{"in":"query","name":"sort","description":"List of fields used for sorting.\n                              Ascending by default, include \"-\" before the field name to reverse the order (descending).\n                              Supported values: **received_at**\n                              E.g. -received_at","type":"array","items":{"type":"string"},"required":false},{"in":"query","name":"page","description":"Page to fetch","type":"integer","format":"int32","default":1,"required":false},{"in":"query","name":"per_page","description":"Number of items per page, values up to 100 supported","type":"integer","format":"int32","default":10,"required":false}],"security":[{"company_auth":["invoice:send","invoice:receive"]}],"responses":{"200":{"description":"List invoices","schema":{"type":"array","items":{"$ref":"#/definitions/Invoices_HttpApi_Entities_Invoice"}}}},"tags":["invoices"],"operationId":"getV1Invoices"},"post":{"summary":"Upload new invoice","description":"","produces":["application/json"],"consumes":["multipart/form-data"],"parameters":[{"in":"formData","name":"file","description":"File content. Please make sure to provide the \"filename\" Content-Disposition header field as well as specified in the rfc2183.","type":"file","required":true},{"in":"formData","name":"format","description":"File format","type":"string","enum":["VISMAXML53","VISMAXML60","SVEFAKTURA10","SEDI","E2B","EHF20","PEPPOLBIS20","PEPPOLBIS30","SIUBL11","SIUBL12","SIUBL20","OIOUBL","OIOUBL21","VISMAUBL10","VISMAUBL30","FINVOICE13","FINVOICE20","FINVOICE30","TEAPPS27","TEAPPS30","XRECHNUNG23UBL","XRECHNUNG23CII","XRECHNUNG23EXTUBL","XRECHNUNG23EXTCII","XRECHNUNG30UBL","XRECHNUNG30CII","XRECHNUNG30EXTUBL","XRECHNUNG30EXTCII","FATTURAPA12","FA3"],"required":false},{"in":"formData","name":"recipient_type","description":"Only in Norway, set to \"consumer\" to use route_order","type":"string","default":"b2b","enum":["b2b","consumer"],"required":false},{"in":"formData","name":"recipient_eia","description":"Recipient EIA","type":"string","required":false,"minLength":0,"maxLength":128},{"in":"formData","name":"recipient_email","description":"Recipient email address","type":"string","required":false,"minLength":0,"maxLength":255},{"in":"formData","name":"recipient_operator","description":"Recipient operator","type":"string","required":false,"minLength":0,"maxLength":128},{"in":"formData","name":"disabled_routes","description":"Routes to explicitly disable","type":"array","items":{"type":"string","enum":["print","email","einvoice"]},"required":false},{"in":"formData","name":"sender_comment","description":"Text that will be added in the email message if invoice is delivered by email","type":"string","required":false,"minLength":0,"maxLength":1024},{"in":"formData","name":"uuid","description":"Unique invoice uuid, generated automatically if not specified.","type":"string","required":false,"minLength":0,"maxLength":36},{"in":"formData","name":"lang","description":"Set language of PDF generated by us and email what recipient receives.","type":"string","enum":["FI","SE","NO","DK","NL","EN"],"required":false},{"in":"formData","name":"route_order","description":"Consumer routes to use. Leave empty to use default. Note! 'netbank_cvl' and 'netbank_cvl_hold' are deprecated since 05/2022.","type":"array","items":{"type":"string","enum":["netbank","netbank_cvl","netbank_cvl_hold","vipps","dpi","email","print","silent_failure"]},"required":false},{"in":"formData","name":"recipient_phone_number","description":"Recipient phone number in international format. Used in Yes2All lookups.","type":"string","required":false,"minLength":0,"maxLength":30},{"in":"formData","name":"recipient_date_of_birth","description":"Recipient date of birth in YYYY-MM-DD format. Used in Yes2All lookups.","type":"string","format":"date","required":false},{"in":"formData","name":"recipient_ssn","description":"Recipient social security number. Used in Yes2All lookups.","type":"string","required":false},{"in":"formData","name":"recipient_efaktura_id","description":"Recipient unique eFaktura ID","type":"string","required":false},{"in":"formData","name":"b2cno_document_type","description":"B2C document type for special documents","type":"string","enum":["INVOICE","CREDIT_NOTE","REMINDER","COLLECTION_NOTICE"],"required":false},{"in":"formData","name":"payment_instruction_identifier","description":"PaymentInstructionIdentifier, used in Finnish B2C invoicing only.","type":"string","required":false},{"in":"formData","name":"print_settings[color]","description":"Enable color printing","type":"boolean","required":false},{"in":"formData","name":"print_settings[letter_class]","description":"Letter class","type":"string","enum":["PRIORITY","ECONOMY"],"required":false},{"in":"formData","name":"print_settings[prevent_digital_post]","description":"Prevent invoice from being sent to OmaPosti (Finland only)","type":"boolean","required":false},{"in":"formData","name":"print_settings[print_own_image]","description":"Use own image when printing (overrides company settings)","type":"boolean","required":false},{"in":"formData","name":"print_settings[allow_kivra_fi]","description":"Try Kivra FI before printing even if \"einvoice\" route is disabled in disabled_routes parameter. Only applies for B2C invoices.","type":"boolean","required":false},{"in":"formData","name":"prevent_routing","description":"Prevent routing of the invoice. Invoice will be set to SENT state without actually sending it anywhere. Intended use is for creating assignments without sending an invoice for the collection services","type":"boolean","required":false},{"in":"formData","name":"email_settings[xml_format]","description":"Forces the invoice to be sent via email and includes the XML attachment in the specified format","type":"string","enum":["VISMAXML53","VISMAXML60","SVEFAKTURA10","SEDI","E2B","EHF20","PEPPOLBIS20","PEPPOLBIS30","SIUBL11","SIUBL12","SIUBL20","OIOUBL","OIOUBL21","VISMAUBL10","VISMAUBL30","FINVOICE13","FINVOICE20","FINVOICE30","TEAPPS27","TEAPPS30","XRECHNUNG23UBL","XRECHNUNG23CII","XRECHNUNG23EXTUBL","XRECHNUNG23EXTCII","XRECHNUNG30UBL","XRECHNUNG30CII","XRECHNUNG30EXTUBL","XRECHNUNG30EXTCII","FATTURAPA12","FA3"],"required":false}],"security":[{"company_auth":["invoice:send"]}],"responses":{"201":{"description":"Upload new invoice","schema":{"$ref":"#/definitions/Invoices_HttpApi_Entities_Invoice"}}},"tags":["invoices"],"operationId":"postV1Invoices"}},"/v1/invoices/{id}/detect_results":{"get":{"summary":"Fetch results provided by Detect service","description":"Returns the check results provided by the Detect service\n\nThe JSON (`application/json`) response contains the following fields.\n- **status** The overall status of the executed checks.\n  - On status **OK** all the checks have been executed without findings.\n  - On status **DISABLED** the Detect service has not been enabled by the customer and no checks have been executed.\n  - On status **WARN** at least one of the checks has been executed with findings.\n- **executed_checks** List of checks that were executed.\n- **findings** List of findings that were found when executing the checks.\n\nThe `lang` request parameter can be used to specify the language the checks and findings will be presented in. The default language is English.\n\nAn example response:\n```\n{\n  \"status\": \"WARN\",\n  \"executed_checks\": [\n    \"Check if the supplier sent the material in a non-optimal way\",\n    \"Check that the sender's business ID is active\",\n    \"Check that the sender of the invoice is registered to charge VAT\",\n    \"Check if the sender of the invoice has had suspicious activity in the past\"\n  ],\n  \"findings\": [\n    \"The sender '9944556677' was found in Brønnøysundregistrene, but has been closed.\",\n    \"The sender 'NO9944556677MVA' is not found in VAT registry.\",\n    \"Something went wrong when executing the check. Detect could not automatically check if sender is found in a warning list.\"\n  ]\n}\n```\n\n            ","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Invoice ID","type":"string","required":true},{"in":"query","name":"lang","description":"The language the checks and findings will be presented in","type":"string","default":"EN","enum":["FI","SE","NO","DK","NL","EN"],"required":false}],"security":[{"company_auth":["invoice:receive"]}],"responses":{"200":{"description":"The Detect service has analysed the invoice and result are available","schema":{"$ref":"#/definitions/Invoices_HttpApi_Entities_InvoiceDetectResults"}},"404":{"description":"The Detect service has not been enabled by the customer","schema":{"$ref":"#/definitions/Invoices_HttpApi_Entities_InvoiceDetectResults"}}},"tags":["invoices"],"operationId":"getV1InvoicesIdDetectResults"}},"/v1/invoices/{id}":{"get":{"summary":"Invoice details","description":"","produces":["application/json","application/xml"],"parameters":[{"in":"path","name":"id","description":"Invoice ID","type":"string","required":true},{"in":"query","name":"return_format","description":"Desired format","type":"string","enum":["VISMAXML60","PEPPOLBIS30","SIUBL20","OIOUBL21","VISMAUBL30","FINVOICE30","TEAPPS30","XRECHNUNG23UBL","XRECHNUNG23CII","XRECHNUNG23EXTUBL","XRECHNUNG23EXTCII","XRECHNUNG30UBL","XRECHNUNG30CII","XRECHNUNG30EXTUBL","XRECHNUNG30EXTCII","FATTURAPA12","FA3","ORIGINAL_IMAGE","GENERATED_IMAGE","ORIGINAL_OR_GENERATED_IMAGE","EXTENDED_DETAILS"],"required":false}],"security":[{"company_auth":["invoice:send","invoice:receive"]}],"responses":{"200":{"description":"Invoice details","schema":{"$ref":"#/definitions/Invoices_HttpApi_Entities_Invoice"}}},"tags":["invoices"],"operationId":"getV1InvoicesId"}},"/v1/invoices/{id}/actions":{"get":{"summary":"List invoice actions","description":"","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Invoice ID","type":"string","required":true},{"in":"query","name":"type","description":"Action type","type":"array","items":{"type":"string","enum":["RECEIVED","CREATED","SENT","DELIVERED","INFO","ERROR"],"default":["CREATED","SENT","DELIVERED","ERROR","RECEIVED"]},"required":false},{"in":"query","name":"channel_details_version","description":"Version for channel_details","type":"integer","format":"int32","enum":[1],"required":false}],"security":[{"company_auth":["invoice:send","invoice:receive"]}],"responses":{"200":{"description":"List invoice actions","schema":{"type":"array","items":{"$ref":"#/definitions/Invoices_HttpApi_Entities_InvoiceAction"}}}},"tags":["invoices"],"operationId":"getV1InvoicesIdActions"}},"/v1/invoices/{id}/invoice_events":{"patch":{"summary":"Change state for recevied events","description":"","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Invoice ID","type":"string","required":true},{"name":"patchV1InvoicesIdInvoiceEvents","in":"body","required":true,"schema":{"$ref":"#/definitions/patchV1InvoicesIdInvoiceEvents"}}],"security":[{"company_auth":["invoice:send","invoice:receive"]}],"responses":{"204":{"description":""}},"tags":["invoices"],"operationId":"patchV1InvoicesIdInvoiceEvents"}},"/v1/invoices/{id}/files/{file_id}":{"get":{"summary":"Fetch file content","description":"","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Invoice ID","type":"string","required":true},{"in":"path","name":"file_id","description":"Invoice file ID","type":"string","required":true}],"security":[{"company_auth":["invoice:send","invoice:receive"]}],"responses":{"200":{"description":"Fetch file content"}},"tags":["invoices"],"operationId":"getV1InvoicesIdFilesFileId"}},"/v1/invoices/{id}/reroute/einvoice":{"put":{"description":"Reroutes invoice via einvoice","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Invoice ID","type":"string","required":true},{"name":"putV1InvoicesIdRerouteEinvoice","in":"body","required":true,"schema":{"$ref":"#/definitions/putV1InvoicesIdRerouteEinvoice"}}],"security":[{"company_auth":["invoice:send"]}],"responses":{"200":{"description":"Reroutes invoice via einvoice"}},"tags":["invoices"],"operationId":"putV1InvoicesIdRerouteEinvoice"}},"/v1/invoices/{id}/reroute/email":{"put":{"description":"Reroutes invoice via email","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Invoice ID","type":"string","required":true},{"name":"putV1InvoicesIdRerouteEmail","in":"body","required":true,"schema":{"$ref":"#/definitions/putV1InvoicesIdRerouteEmail"}}],"security":[{"company_auth":["invoice:send"]}],"responses":{"200":{"description":"Reroutes invoice via email"}},"tags":["invoices"],"operationId":"putV1InvoicesIdRerouteEmail"}},"/v1/invoices/{id}/reroute/print":{"put":{"description":"Reroutes invoice via print","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Invoice ID","type":"string","required":true},{"name":"putV1InvoicesIdReroutePrint","in":"body","required":true,"schema":{"$ref":"#/definitions/putV1InvoicesIdReroutePrint"}}],"security":[{"company_auth":["invoice:send"]}],"responses":{"200":{"description":"Reroutes invoice via print"}},"tags":["invoices"],"operationId":"putV1InvoicesIdReroutePrint"}},"/v1/invoices/{id}/reports":{"post":{"description":"Report sender of fraud attempt","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Invoice ID","type":"string","required":true},{"name":"postV1InvoicesIdReports","in":"body","required":true,"schema":{"$ref":"#/definitions/postV1InvoicesIdReports"}}],"security":[{"company_auth":["invoice:receive"]}],"responses":{"204":{"description":"Company successfully reported"},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/API_Entities_Error"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/API_Entities_Error"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/API_Entities_Error"}},"409":{"description":"Conflict: company already reported","schema":{"$ref":"#/definitions/API_Entities_Error"}}},"tags":["invoices"],"operationId":"postV1InvoicesIdReports"},"get":{"description":"Fetch user reports for invoice","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Invoice ID","type":"string","required":true}],"security":[{"company_auth":["invoice:receive"]}],"responses":{"200":{"description":"Fetch successfully completed","schema":{"type":"array","items":{"$ref":"#/definitions/UserReport"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/API_Entities_Error"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/API_Entities_Error"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/API_Entities_Error"}},"404":{"description":"No user report found","schema":{"$ref":"#/definitions/API_Entities_Error"}}},"tags":["invoices"],"operationId":"getV1InvoicesIdReports"}},"/v1/invoices/{id}/reports/{report_id}":{"delete":{"description":"Delete user report for invoice","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Invoice ID","type":"string","required":true},{"in":"path","name":"report_id","description":"Report ID","type":"string","required":true}],"security":[{"company_auth":["invoice:receive"]}],"responses":{"204":{"description":"User report successfully deleted"},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/API_Entities_Error"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/API_Entities_Error"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/API_Entities_Error"}},"404":{"description":"No user report found","schema":{"$ref":"#/definitions/API_Entities_Error"}}},"tags":["invoices"],"operationId":"deleteV1InvoicesIdReportsReportId"}},"/v1/invoices/{id}/responses/nemhandel":{"post":{"description":"Sets the business response for an invoice in the Nemhandel network. When an invoice has a final response you cannot set another response. The responses have to be set in a predefined order, specified by the standards.Note: This API has a vendor lock. To enable access, please contact Maventa Support before using this endpoint.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Invoice ID","type":"string","required":true},{"name":"postV1InvoicesIdResponsesNemhandel","in":"body","required":true,"schema":{"$ref":"#/definitions/postV1InvoicesIdResponsesNemhandel"}}],"security":[{"company_auth":["invoice:receive"]}],"responses":{"200":{"description":"Return","schema":{"$ref":"#/definitions/Invoices_HttpApi_Entities_InvoiceResponseNemhandel"}},"400":{"description":"Bad request"},"404":{"description":"Invoice not found"},"503":{"description":"Service unavailable. Try again later."}},"tags":["invoices"],"operationId":"postV1InvoicesIdResponsesNemhandel"}},"/v1/company/profiles":{"get":{"summary":"List network registrations","description":"","produces":["application/json"],"parameters":[{"in":"query","name":"network","description":"Network filter","type":"array","items":{"type":"string","enum":["VISMA","PEPPOL","NEMHANDEL","AISPROOM","BANK","SCAN","INEXCHANGE","VISMASCANNER","RECEIVABLES"]},"required":false},{"in":"query","name":"status","description":"Status filter","type":"array","items":{"type":"string","enum":["active","pending","error"]},"required":false}],"security":[{"company_auth":["company:read"],"operator_auth":["operator:company:read"]}],"responses":{"200":{"description":"List network registrations","schema":{"type":"array","items":{"$ref":"#/definitions/API_Entities_CompanyProfile"}}}},"tags":["company"],"operationId":"getV1CompanyProfiles"},"post":{"summary":"Create network registration request","description":"","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postV1CompanyProfiles","in":"body","required":true,"schema":{"$ref":"#/definitions/postV1CompanyProfiles"}}],"security":[{"company_auth":["company:write"],"operator_auth":["operator:company:write"]}],"responses":{"201":{"description":"Create network registration request","schema":{"$ref":"#/definitions/API_Entities_CompanyProfile"}},"422":{"description":"- **profile_name_conflict**: Profile is already registered for given endpoint id\n- **profile_eia_conflict**: Endpoint id is already in use\n- **profile_eia_bid_conflict**: Endpoint id does not match the company business id\n- **profile_not_supported**: Profile is not supported","schema":{"$ref":"#/definitions/API_Entities_Error"}}},"tags":["company"],"operationId":"postV1CompanyProfiles"}},"/v1/company/profiles/{id}/extensions":{"put":{"description":"EXPERIMENTAL Create extensions for profiles","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Profile Subscription Id","type":"string","required":true},{"name":"putV1CompanyProfilesIdExtensions","in":"body","required":true,"schema":{"$ref":"#/definitions/putV1CompanyProfilesIdExtensions"}}],"security":[{"company_auth":["company:write"],"operator_auth":["operator:company:write"]}],"responses":{"200":{"description":"EXPERIMENTAL Create extensions for profiles"}},"tags":["company"],"operationId":"putV1CompanyProfilesIdExtensions"}},"/v1/company/profiles/{id}":{"get":{"summary":"Fetch a network registration ","description":"","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Profile id","type":"string","required":true}],"security":[{"company_auth":["company:read"],"operator_auth":["operator:company:read"]}],"responses":{"200":{"description":"Fetch a network registration ","schema":{"$ref":"#/definitions/API_Entities_CompanyProfile"}}},"tags":["company"],"operationId":"getV1CompanyProfilesId"},"delete":{"summary":"Delete a network registration","description":"","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Profile id","type":"string","required":true}],"security":[{"company_auth":["company:write"],"operator_auth":["operator:company:write"]}],"responses":{"204":{"description":"Registration deleted succesfully"},"409":{"description":"- **profile_deletion_not_allowed**: Deletion of profile is not allowed","schema":{"$ref":"#/definitions/API_Entities_Error"}}},"tags":["company"],"operationId":"deleteV1CompanyProfilesId"},"patch":{"summary":"Update a network registration","description":"","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Profile id","type":"string","required":true},{"name":"patchV1CompanyProfilesId","in":"body","required":true,"schema":{"$ref":"#/definitions/patchV1CompanyProfilesId"}}],"security":[{"company_auth":["company:write"],"operator_auth":["operator:company:write"]}],"responses":{"204":{"description":"Profile updated succesfully"}},"tags":["company"],"operationId":"patchV1CompanyProfilesId"}},"/v1/company/settings":{"get":{"summary":"Fetch company settings","description":"","produces":["application/json"],"parameters":[{"in":"query","name":"fields","description":"Filter the response to only include requested fields.\n                                    Possible values: invoice_notifications, send_invoice_email, address, details, send_invoice_print, send_invoice_general, logos, email_reports, billing_details","type":"array","items":{"type":"string"},"required":false}],"security":[{"company_auth":["company:read"]}],"responses":{"200":{"description":"Fetch company settings","schema":{"$ref":"#/definitions/API_Entities_CompanySettings_Settings"}}},"tags":["company"],"operationId":"getV1CompanySettings"},"patch":{"summary":"Modify company settings","description":"### Company billing details\n ```\n{\n  \"billing_details\": {\n    \"electronic_invoicing_details\": {\n      \"invoicing_eia\": \"Company electronic invoicing address (Billing information: The delivery method priority is following 1 = einvoice, 2 = email, 3 = print, if all below values are given. If company prefers Invoicing via normal post, invoicing_eia, invoicing_operator and invoicing_email should be left blank).\",\n      \"invoicing_operator\": \"Company electronic invoicing operator address\"\n    },\n    \"invoicing_email\": \"info@company.com\",\n    \"invoicing_street_address1\": \"My street 1\",\n    \"invoicing_street_address2\": \"My street 2\",\n    \"invoicing_post_code\": \"123456\",\n    \"invoicing_post_office\": \"Helsinki\",\n    \"billing_company_id\": \"123456\"\n  }\n}\n```\n\n\n\n\n### Company email reports\n\n```\n{\n  \"email_reports\": {\n    \"report_interval\": \"off | daily | weekly | monthly\",\n    \"email_reports\": [\n      \"info@company.com\",\n      \"reports@company.com\"\n    ]\n  }\n}\n```\n\n\n\n### Company logos\n\n```\n{\n  \"logos\": {\n    \"pdf\": {\n      \"content\": \"Base64 encoded string of PNG or JPEG image for use as logo on generated PDF invoices\"\n    },\n    \"email_header\": {\n      \"content\": \"Base64 encoded string of PNG only image for use as header image on sent email invoices\"\n    }\n  },\n}\n```\n\n\n### Company general settings\n\n```\n{\n  \"send_invoice_general\": {\n    \"hold_multiple_recipients\": false,\n    \"stop_duplicate_numbers\": false\n  }\n}\n```\n\n\n### Company invoice print settings\n\n```\n{\n  \"send_invoice_print\": {\n    \"enabled\": false,\n    \"letter_class\": \"ECONOMY\",\n    \"color_scheme\": \"BLACK_AND_WHITE\",\n    \"attachment_print\": false,\n    \"marketing_page\": false,\n    \"use_own_pdf\": false\n  }\n}\n```\n\n\n### Company details\n\n```\n{\n  \"details\": {\n    \"name\": \"My Company Ltd\",\n    \"email\": \"info@company.com\",\n    \"website\": \"https://my.company.com\"\n  }\n}\n```\n\n### Company address\n ```\n{\n  \"address\": {\n    \"street_address\": \"My street 1\",\n    \"post_code\": \"123456\",\n    \"post_office\": \"Oslo\",\n    \"city\": \"Oslo\",\n    \"country\": \"NO\"\n  }\n}\n```\n\n\n\n### Company send invoice email related settings\n\n```\n{\n  \"send_invoice_email\": {\n    \"enabled\": true,\n    \"how_to_send\": \"EMBEDDED | WITH_OBJECTIONS | WITH_LINK | EMBEDDED_MERGE (only if enabled is true)\",\n    \"reminder_frequency\": 4,\n    \"content_data\": {\n      \"note_to_receiver\": \"A message added to the receiver\",\n      \"contact\": {\n        \"email\": \"invoices@company.com (this is validated by sending a link email to the email)\",\n        \"name\": \"Info User\",\n        \"phone\": \"+555 55 555 5555\"\n      }\n    }\n  }\n}\n```\n\n\n### Company invoice notification settings\n\n```\n{\n  \"invoice_notifications\": {\n    \"on_receiving\": {\n      \"enabled\": true,\n      \"how_to_send\": \"OTHER_EMAIL\",\n      \"other_email\": \"info@company.com\"\n    },\n    \"on_send_errors\": {\n      \"to_user\": true,\n      \"to_emails\": [\n        \"info@company.com\"\n      ]\n    }\n  }\n}\n```\n","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"patchV1CompanySettings","in":"body","required":true,"schema":{"$ref":"#/definitions/patchV1CompanySettings"}}],"security":[{"company_auth":["company:write"]}],"responses":{"204":{"description":"Settings updated successfully"},"400":{"description":"- **invalid_parameters**: Request parameters are invalid","schema":{"$ref":"#/definitions/API_Entities_Error"}}},"tags":["company"],"operationId":"patchV1CompanySettings"}},"/v1/company/consumers":{"get":{"summary":"List B2CNO Consumers - DEPRECATED 2025","description":"","produces":["application/json"],"parameters":[{"in":"query","name":"query","description":"List by phonenumber, name, customer_number and reference_number","type":"string","required":false},{"in":"query","name":"status","description":"List of statuses","type":"array","items":{"type":"string","enum":["NEW","REQUEST_SENT","ACCEPTED","ACTIVE","DELETED","REJECTED","ERROR"]},"required":false},{"in":"query","name":"page","description":"Page to fetch","type":"integer","format":"int32","default":1,"required":false},{"in":"query","name":"per_page","description":"Number of items per page, values up to 100 supported","type":"integer","format":"int32","default":20,"required":false}],"security":[{"company_auth":["company:read"]}],"responses":{"200":{"description":"List B2CNO Consumers - DEPRECATED 2025","schema":{"type":"array","items":{"$ref":"#/definitions/API_Entities_CompanyConsumers_Consumer"}}}},"tags":["company"],"operationId":"getV1CompanyConsumers"}},"/v1/company/notifications":{"get":{"summary":"List notification subscriptions","description":"","produces":["application/json"],"security":[{"company_auth":["company:read"]}],"responses":{"200":{"description":"List notification subscriptions","schema":{"type":"array","items":{"$ref":"#/definitions/API_Entities_Notifications_Notification"}}}},"tags":["company"],"operationId":"getV1CompanyNotifications"},"post":{"summary":"Create new notification subscription","description":"","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postV1CompanyNotifications","in":"body","required":true,"schema":{"$ref":"#/definitions/postV1CompanyNotifications"}}],"security":[{"company_auth":["company:write"]}],"responses":{"201":{"description":"Create new notification subscription","schema":{"$ref":"#/definitions/API_Entities_Notifications_Notification"}}},"tags":["company"],"operationId":"postV1CompanyNotifications"}},"/v1/company/notifications/{id}":{"get":{"summary":"Fetch a specific notification subscription","description":"","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Notification id","type":"string","required":true}],"security":[{"company_auth":["company:read"]}],"responses":{"200":{"description":"Notification subscription","schema":{"$ref":"#/definitions/API_Entities_Notifications_Notification"}}},"tags":["company"],"operationId":"getV1CompanyNotificationsId"},"delete":{"summary":"Delete a specific notification subscription","description":"","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Notification id","type":"string","required":true}],"security":[{"company_auth":["company:write"]}],"responses":{"204":{"description":"Notification subscription was deleted"}},"tags":["company"],"operationId":"deleteV1CompanyNotificationsId"}},"/v1/company/notifications_resend_unacknowledged":{"post":{"summary":"[EXPERIMENTAL] Resend unacknowledged notifications","description":"","produces":["application/json"],"consumes":["application/json"],"security":[{"company_auth":["company:write"]}],"responses":{"200":{"description":"Request accepted. Unacknowledged webhooks for all subscriptions will get retriggered at a later point"}},"tags":["company"],"operationId":"postV1CompanyNotificationsResendUnacknowledged"}},"/v1/company/vendors":{"post":{"description":"Link vendor API key","produces":["application/json"],"consumes":["application/json"],"security":[{"company_auth":["company:write"]}],"responses":{"201":{"description":"Link vendor API key","schema":{"$ref":"#/definitions/API_Entities_LinkVendorAPIKey"}}},"tags":["company"],"operationId":"postV1CompanyVendors"},"delete":{"description":"Unlink vendor API key","produces":["application/json"],"security":[{"company_auth":["company:write"]}],"responses":{"204":{"description":"Vendor unlinked"}},"tags":["company"],"operationId":"deleteV1CompanyVendors"},"get":{"description":"Vendor API key link status","produces":["application/json"],"security":[{"company_auth":["company:write"]}],"responses":{"200":{"description":"Vendor API key link status","schema":{"$ref":"#/definitions/API_Entities_LinkVendorAPIKey"}}},"tags":["company"],"operationId":"getV1CompanyVendors"}},"/v1/company/authorization":{"get":{"summary":"Company authorization status. In order to use company account to send, receive and activate services status needs to be verified","description":"","produces":["application/json"],"security":[{"company_auth":["company:read"]}],"responses":{"200":{"description":"Company authorization status. In order to use company account to send, receive and activate services status needs to be verified","schema":{"$ref":"#/definitions/API_Entities_CompanyAuthorizationStatus"}}},"tags":["company"],"operationId":"getV1CompanyAuthorization"},"post":{"description":"Authorize your company. Required to complete KYC process and take company account into use","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postV1CompanyAuthorization","in":"body","required":true,"schema":{"$ref":"#/definitions/postV1CompanyAuthorization"}}],"security":[{"company_auth":["company:write"]}],"responses":{"200":{"description":"Sign request sent","schema":{"$ref":"#/definitions/API_Entities_CompanyAuthorization"}},"400":{"description":"Bad request","schema":{"$ref":"#/definitions/API_Entities_Error"}}},"tags":["company"],"operationId":"postV1CompanyAuthorization"}},"/v1/company/users":{"get":{"description":"List existing users","produces":["application/json"],"security":[{"company_auth":["company:read"]}],"responses":{"200":{"description":"List existing users","schema":{"type":"array","items":{"$ref":"#/definitions/API_Entities_CompanyUsers_User"}}}},"tags":["company"],"operationId":"getV1CompanyUsers"},"post":{"description":"Add a new or existing user to a company","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postV1CompanyUsers","in":"body","required":true,"schema":{"$ref":"#/definitions/postV1CompanyUsers"}}],"security":[{"company_auth":["company:write"]}],"responses":{"201":{"description":"User was successfully created","schema":{"$ref":"#/definitions/API_Entities_CompanyUsers_NewUser"}},"200":{"description":"User was added to company","schema":{"$ref":"#/definitions/API_Entities_CompanyUsers_User"}}},"tags":["company"],"operationId":"postV1CompanyUsers"}},"/v1/company/users/{user_id}":{"delete":{"description":"Remove a user from this company","produces":["application/json"],"parameters":[{"in":"path","name":"user_id","type":"string","required":true}],"security":[{"company_auth":["company:write"]}],"responses":{"204":{"description":""}},"tags":["company"],"operationId":"deleteV1CompanyUsersUserId"},"patch":{"description":"Update user info","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"user_id","type":"string","required":true},{"name":"patchV1CompanyUsersUserId","in":"body","required":true,"schema":{"$ref":"#/definitions/patchV1CompanyUsersUserId"}}],"security":[{"company_auth":["company:write"]}],"responses":{"204":{"description":""}},"tags":["company"],"operationId":"patchV1CompanyUsersUserId"},"get":{"description":"Fetch user info","produces":["application/json"],"parameters":[{"in":"path","name":"user_id","type":"string","required":true}],"security":[{"company_auth":["company:read"]}],"responses":{"200":{"description":"","schema":{"$ref":"#/definitions/API_Entities_CompanyUsers_User"}}},"tags":["company"],"operationId":"getV1CompanyUsersUserId"}},"/v1/company/users/{user_id}/roles":{"post":{"description":"Update user role","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"user_id","type":"string","required":true},{"name":"postV1CompanyUsersUserIdRoles","in":"body","required":true,"schema":{"$ref":"#/definitions/postV1CompanyUsersUserIdRoles"}}],"security":[{"company_auth":["company:write"]}],"responses":{"204":{"description":""}},"tags":["company"],"operationId":"postV1CompanyUsersUserIdRoles"}},"/v1/company/keep_active":{"post":{"description":"Mark company as active even if no transactions have occurred during the past year.","produces":["application/json"],"consumes":["application/json"],"security":[{"company_auth":["company:write"]}],"responses":{"201":{"description":"Mark company as active even if no transactions have occurred during the past year."}},"tags":["company"],"operationId":"postV1CompanyKeepActive"}},"/v1/company/departments":{"get":{"description":"List departments [EXPERIMENTAL]","produces":["application/json"],"security":[{"company_auth":["company:write"]}],"responses":{"200":{"description":"List departments [EXPERIMENTAL]","schema":{"type":"array","items":{"$ref":"#/definitions/API_Entities_Company"}}}},"tags":["company"],"operationId":"getV1CompanyDepartments"},"post":{"description":"Create a department [EXPERIMENTAL]","produces":["application/json"],"consumes":["multipart/form-data"],"parameters":[{"in":"formData","name":"name","description":"Company name. Name has to be at least 3 characters long","type":"string","required":true},{"in":"formData","name":"bid","description":"Company organization number/Business ID/VAT","type":"string","required":true},{"in":"formData","name":"id_type","description":"Electronic address identifier type","type":"string","enum":["GLN"],"required":true},{"in":"formData","name":"eaid","description":"Electronic address identifier","type":"string","required":true},{"in":"formData","name":"no_vat","description":"Deprecated, no need to give this param anymore","type":"boolean","required":false},{"in":"formData","name":"address1","description":"Street address","type":"string","required":true},{"in":"formData","name":"address2","description":"Additional address","type":"string","required":false},{"in":"formData","name":"post_code","description":"Postal number/code,","type":"string","required":true},{"in":"formData","name":"post_office","description":"Post office","type":"string","required":true},{"in":"formData","name":"city","description":"Registered city","type":"string","required":true},{"in":"formData","name":"state","description":"State of address","type":"string","required":false},{"in":"formData","name":"country","description":"Country code for company, mandatory. Allowed countries FI, SE, NO, DK, NL, BE","type":"string","enum":["FI","SE","NO","DK","NL","BE"],"required":true},{"in":"formData","name":"email","description":"Contact email address for company","type":"string","required":true}],"security":[{"company_auth":["company:write"]}],"responses":{"201":{"description":"Create a department [EXPERIMENTAL]","schema":{"$ref":"#/definitions/API_Entities_Company"}}},"tags":["company"],"operationId":"postV1CompanyDepartments"}},"/v1/company/suppliers/query":{"post":{"summary":"[EXPERIMENTAL] Query suppliers that could send e-invoices instead PDFs","description":"","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postV1CompanySuppliersQuery","in":"body","required":true,"schema":{"$ref":"#/definitions/postV1CompanySuppliersQuery"}}],"security":[{"company_auth":["company:read"]}],"responses":{"201":{"description":"Creating query was successful","schema":{"$ref":"#/definitions/Suppliers_HttpApi_Entities_SuppliersQueryResult"}},"400":{"description":"Bad request","schema":{"$ref":"#/definitions/API_Entities_Error"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/API_Entities_Error"}},"404":{"description":"Resource not found or you don't have access to it","schema":{"$ref":"#/definitions/API_Entities_Error"}}},"tags":["company"],"operationId":"postV1CompanySuppliersQuery"}},"/v1/company/suppliers/notifications":{"post":{"summary":"[EXPERIMENTAL] Create and send notifications to suppliers","description":"Sends notification emails to listed suppliers ","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postV1CompanySuppliersNotifications","in":"body","required":true,"schema":{"$ref":"#/definitions/postV1CompanySuppliersNotifications"}}],"security":[{"company_auth":["company:read"]}],"responses":{"201":{"description":"Request successful, possible failures listed on the response","schema":{"$ref":"#/definitions/Suppliers_HttpApi_Entities_SuppliersNotificationResult"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"409":{"description":"Expected company data missing"}},"tags":["company"],"operationId":"postV1CompanySuppliersNotifications"}},"/v1/companies":{"post":{"description":"Create a Company","produces":["application/json"],"consumes":["multipart/form-data"],"parameters":[{"in":"formData","name":"vendor_api_key","description":"Identifies partner/ERP","type":"string","required":true},{"in":"formData","name":"user_api_key","description":"The user API key","type":"string","required":true},{"in":"formData","name":"name","description":"Company name. Name has to be at least 3 characters long","type":"string","required":true},{"in":"formData","name":"bid","description":"Company organization number/Business ID/VAT","type":"string","required":true},{"in":"formData","name":"no_vat","description":"Deprecated, no need to give this param anymore","type":"boolean","required":false},{"in":"formData","name":"address1","description":"Street address","type":"string","required":true},{"in":"formData","name":"address2","description":"Additional address","type":"string","required":false},{"in":"formData","name":"post_code","description":"Postal number/code,","type":"string","required":true},{"in":"formData","name":"post_office","description":"Post office","type":"string","required":true},{"in":"formData","name":"city","description":"Registered city","type":"string","required":true},{"in":"formData","name":"state","description":"State of address","type":"string","required":false},{"in":"formData","name":"country","description":"Country code for company, mandatory. Allowed countries FI, SE, NO, DK, NL, EE, BE, DE, LV. IT and PL are in experimental mode.","type":"string","enum":["FI","SE","NO","DK","NL","EE","BE","IT","DE","LV","PL"],"required":true},{"in":"formData","name":"email","description":"Contact email address for company","type":"string","required":true}],"responses":{"201":{"description":"Create a Company","schema":{"$ref":"#/definitions/API_Entities_Company"}}},"tags":["companies"],"operationId":"postV1Companies"},"get":{"summary":"List active companies the user has access to","description":"List all companies without giving params, or check if user belongs to a given company.","produces":["application/json"],"parameters":[{"in":"query","name":"bid","description":"Business id.","type":"string","required":false},{"in":"query","name":"country","description":"Country in ISO 3166-1 alpha-2 format (2 letters)","type":"string","required":false}],"security":[{"company_auth":["company:read"]}],"responses":{"200":{"description":"List active companies the user has access to","schema":{"type":"array","items":{"$ref":"#/definitions/API_Entities_UserCompany"}}}},"tags":["companies"],"operationId":"getV1Companies"}},"/v1/companies/authorizations":{"post":{"description":"Authorize one or multiple companies. Required to complete KYC process and take company account into use","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postV1CompaniesAuthorizations","in":"body","required":true,"schema":{"$ref":"#/definitions/postV1CompaniesAuthorizations"}}],"security":[{"company_auth":["company:write"]}],"responses":{"200":{"description":"","schema":{"$ref":"#/definitions/API_Entities_CompanyAuthorization"}},"202":{"description":"","schema":{"$ref":"#/definitions/API_Entities_CompanyAuthorization"}},"400":{"description":"Bad request","schema":{"$ref":"#/definitions/API_Entities_Error"}}},"tags":["companies"],"operationId":"postV1CompaniesAuthorizations"}},"/v1/companies/{id}/status":{"get":{"description":"Company authorization status. In order to use company account to send, receive and activate services status needs to be verified","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Company ID","type":"string","required":true}],"security":[{"company_auth":["company:read"]}],"responses":{"200":{"description":"Company authorization status. In order to use company account to send, receive and activate services status needs to be verified","schema":{"$ref":"#/definitions/API_Entities_CompanyAuthorizationStatus"}}},"tags":["companies"],"operationId":"getV1CompaniesIdStatus"}},"/v1/operator/participants":{"get":{"description":"List participants registered by operator","produces":["application/json"],"parameters":[{"in":"query","name":"external_ids","description":"Participants external ids","type":"array","items":{"type":"string"},"required":false},{"in":"query","name":"updated_at_start","description":"Last update time starting from","type":"string","format":"date-time","required":false},{"in":"query","name":"profiles","description":"Profiles","type":"array","items":{"type":"string"},"required":false},{"in":"query","name":"updated_at_end","description":"Last update time ending at","type":"string","format":"date-time","required":false},{"in":"query","name":"page","description":"Page to fetch","type":"integer","format":"int32","default":1,"required":false},{"in":"query","name":"per_page","description":"Number of items per page, values up to 100 supported","type":"integer","format":"int32","default":10,"required":false}],"security":[{"operator_auth":["operator:participants"]}],"responses":{"200":{"description":"List participants registered by operator","schema":{"type":"array","items":{"$ref":"#/definitions/API_Entities_OperatorParticipant"}}}},"tags":["operator"],"operationId":"getV1OperatorParticipants"},"post":{"description":"Register a participant","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postV1OperatorParticipants","in":"body","required":true,"schema":{"$ref":"#/definitions/postV1OperatorParticipants"}}],"security":[{"operator_auth":["operator:participants"]}],"responses":{"201":{"description":"Register a participant","schema":{"$ref":"#/definitions/API_Entities_OperatorParticipant"}},"422":{"description":"- **profile_name_conflict**: Profile is already registered for given endpoint id\n- **profile_eia_conflict**: Endpoint id is already in use\n- **profile_eia_bid_conflict**: Endpoint id does not match the company business id\n- **profile_not_supported**: Profile is not supported\n- **profile_registry_not_supported**: Provided registry not supported","schema":{"$ref":"#/definitions/API_Entities_Error"}}},"tags":["operator"],"operationId":"postV1OperatorParticipants"}},"/v1/operator/participants/{id}":{"get":{"description":"Fetch participant by id","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Participant UUID","type":"string","required":true}],"security":[{"operator_auth":["operator:participants"]}],"responses":{"200":{"description":"Requested profile","schema":{"$ref":"#/definitions/API_Entities_OperatorParticipant"}}},"tags":["operator"],"operationId":"getV1OperatorParticipantsId"},"delete":{"description":"Delete participant","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Participant UUID","type":"string","required":true}],"security":[{"operator_auth":["operator:participants"]}],"responses":{"204":{"description":"Participant deleted succesfully"}},"tags":["operator"],"operationId":"deleteV1OperatorParticipantsId"},"patch":{"description":"Update participant information","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Participant UUID","type":"string","required":true}],"security":[{"operator_auth":["operator:participants"]}],"responses":{"204":{"description":"Participant updated succesfully"}},"tags":["operator"],"operationId":"patchV1OperatorParticipantsId"}},"/v1/operator/notifications":{"get":{"description":"List notification subscriptions","produces":["application/json"],"security":[{"operator_auth":["operator:notifications"]}],"responses":{"200":{"description":"List notification subscriptions","schema":{"type":"array","items":{"$ref":"#/definitions/API_Entities_Notifications_Notification"}}}},"tags":["operator"],"operationId":"getV1OperatorNotifications"},"post":{"description":"Create new notification subscription","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postV1OperatorNotifications","in":"body","required":true,"schema":{"$ref":"#/definitions/postV1OperatorNotifications"}}],"security":[{"operator_auth":["operator:notifications"]}],"responses":{"201":{"description":"Create new notification subscription","schema":{"$ref":"#/definitions/API_Entities_Notifications_Notification"}}},"tags":["operator"],"operationId":"postV1OperatorNotifications"}},"/v1/operator/notifications/{id}":{"get":{"description":"Fetch a specific notification subscription","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Notification id","type":"string","required":true}],"security":[{"operator_auth":["operator:notifications"]}],"responses":{"200":{"description":"Notification subscription","schema":{"$ref":"#/definitions/API_Entities_Notifications_Notification"}}},"tags":["operator"],"operationId":"getV1OperatorNotificationsId"},"delete":{"description":"Delete notification subscription","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Notification id","type":"string","required":true}],"security":[{"operator_auth":["operator:notifications"]}],"responses":{"204":{"description":"Notification subscription was deleted"}},"tags":["operator"],"operationId":"deleteV1OperatorNotificationsId"}},"/v1/operator/companies":{"get":{"description":"Get company data","produces":["application/json"],"parameters":[{"in":"query","name":"bid","description":"Company business identifier","type":"string","required":true},{"in":"query","name":"country","description":"Country in ISO 3166-1 alpha-2 format (2 letters)","type":"string","required":true}],"security":[{"operator_auth":["operator:companies"]}],"responses":{"200":{"description":"Get company data","schema":{"type":"array","items":{"$ref":"#/definitions/API_Entities_OperatorCompany"}}}},"tags":["operator"],"operationId":"getV1OperatorCompanies"}},"/v1/operator/receivables/invoice_image/{id}":{"get":{"summary":"Fetch invoice image for assignment","description":"Returns the invoice image PDF file for the assignment","produces":["application/pdf"],"parameters":[{"in":"path","name":"id","description":"Invoice UUID","type":"string","required":true}],"security":[{"operator_auth":["operator:receivables:assignments"]}],"responses":{"200":{"description":"Fetch invoice image for assignment"},"404":{"description":"- **not_found**: Requested resource not found or you don't have access to it","schema":{"$ref":"#/definitions/API_Entities_Error"}}},"tags":["operator"],"operationId":"getV1OperatorReceivablesInvoiceImageId"}},"/v1/lookup/endpoints":{"get":{"description":"Fetch sending options for company bid","produces":["application/json"],"parameters":[{"in":"query","name":"business_ids","description":"Business ids. Maximum number of bids: 10","type":"array","items":{"type":"string"},"required":true},{"in":"query","name":"sending","description":"Types of documents sent. Possible values: invoice","type":"array","items":{"type":"string","default":["invoice"]},"required":false},{"in":"query","name":"country","description":"Country in ISO 3166-1 alpha-2 format (2 letters)","type":"string","required":false}],"security":[{"company_auth":["lookup"],"operator_auth":["operator:lookup"]}],"responses":{"200":{"description":"Fetch sending options for company bid","schema":{"type":"array","items":{"$ref":"#/definitions/API_Entities_Endpoint"}}}},"tags":["lookup"],"operationId":"getV1LookupEndpoints"}},"/v1/lookup/consumers":{"get":{"summary":"Lookup for consumer recipients","description":"","produces":["application/json"],"parameters":[{"in":"query","name":"ssn","description":"Social security number","type":"string","required":false},{"in":"query","name":"date_of_birth","description":"Date of birth of recipient for Yes2All queries. Format YYYY-MM-DD","type":"string","required":false},{"in":"query","name":"phone_number","description":"Phone number for Yes2All queries. International format (e.g. +4791234123)","type":"string","required":false},{"in":"query","name":"email","description":"Email address of recipient for Yes2All queries","type":"string","required":false},{"in":"query","name":"first_name","description":"First name of recipient for Yes2All queries","type":"string","required":false},{"in":"query","name":"last_name","description":"Last name of recipient for Yes2All queries","type":"string","required":false},{"in":"query","name":"postal_code","description":"Postal code of recipient for Yes2All queries","type":"string","required":false},{"in":"query","name":"city","description":"City/post office of recipient for Yes2All queries","type":"string","required":false},{"in":"query","name":"reference_number","description":"Reference number for Yes2All queries","type":"string","required":false},{"in":"query","name":"efaktura_identifier","description":"eFaktura ID for Yes2All queries","type":"string","required":false},{"in":"query","name":"routes","description":"What registries to check from. Possible values:\n                                                dpi,yes2all","type":"array","items":{"type":"string"},"required":false}],"security":[{"company_auth":["lookup"],"operator_auth":["operator:lookup"]}],"responses":{"200":{"description":"Lookup for consumer recipients","schema":{"$ref":"#/definitions/API_Entities_Consumer"}}},"tags":["lookup"],"operationId":"getV1LookupConsumers"}},"/v1/lookup/receivers":{"get":{"description":"Lookup for B2B document receivers","produces":["application/json"],"parameters":[{"in":"query","name":"network","description":"Networks to search from eg. PEPPOL, INTERNAL, EXTERNAL","type":"array","items":{"type":"string"},"required":true},{"in":"query","name":"eia","description":"Full Electronic Address eg: 0192:123456789","type":"string","required":false},{"in":"query","name":"bid","description":"Business identifier","type":"string","required":false},{"in":"query","name":"name","description":"Company name","type":"string","required":false},{"in":"query","name":"country","description":"Company country in ISO 3166-1 alpha-2 format (2 letters)","type":"array","items":{"type":"string"},"required":false},{"in":"query","name":"document_type","description":"Document types","type":"array","items":{"type":"string"},"required":false},{"in":"query","name":"allow_eia_variants","description":"Allow lookup to use generated eia variations, when no hits are found using the given eia","type":"boolean","required":false},{"in":"query","name":"page","description":"Page to fetch","type":"integer","format":"int32","default":1,"required":false},{"in":"query","name":"per_page","description":"Number of items per page, values up to 100 supported","type":"integer","format":"int32","default":100,"required":false}],"security":[{"company_auth":["lookup"],"operator_auth":["operator:lookup"]}],"responses":{"200":{"description":"Lookup for B2B document receivers","schema":{"type":"array","items":{"$ref":"#/definitions/API_Entities_LookupEntryReceiver"}}},"500":{"description":"","schema":{"$ref":"#/definitions/API_Entities_Error"}},"503":{"description":"","schema":{"$ref":"#/definitions/API_Entities_Error"}}},"tags":["lookup"],"operationId":"getV1LookupReceivers"}},"/v1/jwk":{"get":{"description":"List the public keys of this API","produces":["application/json"],"responses":{"200":{"description":"List the public keys of this API","schema":{"type":"array","items":{"$ref":"#/definitions/API_Entities_JWKEntries"}}}},"tags":["jwk"],"operationId":"getV1Jwk"}},"/v1/definitions/operators":{"get":{"description":"List operators","produces":["application/json"],"security":[{"company_auth":["lookup"]}],"responses":{"200":{"description":"List operators","schema":{"type":"array","items":{"$ref":"#/definitions/API_Entities_Operator"}}}},"tags":["definitions"],"operationId":"getV1DefinitionsOperators"}},"/v1/definitions/detect/checks":{"get":{"summary":"Get definition of all supported detect checks","description":"","produces":["application/json"],"parameters":[{"in":"query","name":"checks","description":"Filter definitions by checks. Possible values:  SUPPLIER_ACTIVATION, BANK_ACCOUNT_CHANGED, SENDER_BID_STATUS, SENDER_WARNING_LIST, VAT","type":"array","items":{"type":"string","enum":["SUPPLIER_ACTIVATION","BANK_ACCOUNT_CHANGED","SENDER_BID_STATUS","SENDER_WARNING_LIST","VAT"]},"required":false},{"in":"query","name":"check_attributes","description":"Filter only definitions of interest. Possible values:  name, friendly_name, friendly_names, title, titles, description, descriptions, doc_description, resource_type, scope, scopes, sources, metadata, possible_results","type":"array","items":{"type":"string","enum":["name","friendly_name","friendly_names","title","titles","description","descriptions","doc_description","resource_type","scope","scopes","sources","metadata","possible_results"]},"required":false}],"responses":{"200":{"description":"","schema":{"$ref":"#/definitions/CheckDefinitions"}}},"tags":["definitions"],"operationId":"getV1DefinitionsDetectChecks"}},"/v1/users":{"post":{"description":"Create a User","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postV1Users","in":"body","required":true,"schema":{"$ref":"#/definitions/postV1Users"}}],"responses":{"201":{"description":"Create a User","schema":{"$ref":"#/definitions/API_Entities_ApiUser"}}},"tags":["users"],"operationId":"postV1Users"}},"/v1/files":{"get":{"description":"List document files","produces":["application/json"],"parameters":[{"in":"query","name":"document_id","description":"ID of Document","type":"string","required":true}],"security":[{"company_auth":["document:send","document:receive"],"operator_auth":["operator:documents:send","operator:documents:receive"]}],"responses":{"200":{"description":"List document files","schema":{"$ref":"#/definitions/API_Entities_DocumentFileInDocument"}}},"tags":["files"],"operationId":"getV1Files"}},"/v1/files/{id}":{"get":{"description":"Get file content","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of DocumentFile","type":"string","required":true}],"security":[{"company_auth":["document:send","document:receive"],"operator_auth":["operator:documents:send","operator:documents:receive"]}],"responses":{"200":{"description":"Get file content"}},"tags":["files"],"operationId":"getV1FilesId"}},"/v1/documents":{"get":{"summary":"Query documents","description":"#### Pagination and sorting\nThe items per page parameter **per_page** will default to 10 if not provided, also the **page** parameter will default to 1 if not provided.\nThe maximum value of the **per_page** parameter is 100.\nDefault order of the items is descending by the created_at attribute.\nAdditional information about returned page can be extracted from the returned header parameters:\n - **X-Total**: Total number of items\n- **X-Total-Pages**: Total number of pages\n- **X-Page**: Index of the current page\n- **X-Next-Page**: Index of the next page\n- **X-Prev-Page**: Index of the previous page\n- **X-Per-Page**: Items per page\n- **Link**: Links to the first, previous, next, and last pages can be found from this header\nThe page indexing starts from 1.\n\n","produces":["application/json"],"parameters":[{"in":"query","name":"ids","description":"Batch of document IDs. Maximum of 100 per query","type":"array","items":{"type":"string"},"required":false},{"in":"query","name":"direction","description":"Received or sent documents","type":"string","enum":["INCOMING","OUTGOING","RECEIVED","SENT"],"required":false},{"in":"query","name":"type","description":"List of document types.\n                                                    Possible values: UNKNOWN, INVOICE, CREDIT_NOTE, ORDER, ORDER_RESPONSE, CATALOGUE, CATALOGUE_RESPONSE, SELF_BILLING_INVOICE, DESPATCH_ADVICE, RECEIPT, VOUCHER, BANK_FILE, REMINDER, SCAN, INVOICE_RESPONSE, MESSAGE_LEVEL_RESPONSE, EXPRESSION_OF_INTEREST_REQUEST, EXPRESSION_OF_INTEREST_RESPONSE, TENDER_STATUS_REQUEST, CALL_FOR_TENDERS, TENDER, TENDER_RECEIPT, ORDER_CHANGE, ORDER_CANCELLATION, SELF_BILLING_CREDIT_NOTE","type":"array","items":{"type":"string"},"required":false},{"in":"query","name":"status","description":"List of document states.\n                                                    Possible values: PROCESSING, DELIVERED, CONFIRMED_DELIVERY, FAILED","type":"array","items":{"type":"string"},"required":false},{"in":"query","name":"created_at_start","description":"Creation time","type":"string","format":"date-time","required":false},{"in":"query","name":"created_at_end","description":"Creation time","type":"string","format":"date-time","required":false},{"in":"query","name":"number","description":"Document number","type":"string","required":false},{"in":"query","name":"reference","description":"Document reference","type":"string","required":false},{"in":"query","name":"query","description":"Query Documents on multiple fields. (Exact matches on id, reference and number)","type":"string","required":false},{"in":"query","name":"sort","description":"List of fields used for sorting.\n  Ascending by default, include \"-\" before the field name to reverse the order (descending).\n  Supported values: **id, type, status, number, reference, created_at, received_at**\n  E.g. [-created_at, number]","type":"array","items":{"type":"string","default":["created_at"]},"required":false},{"in":"query","name":"page","description":"Page to fetch","type":"integer","format":"int32","default":1,"required":false},{"in":"query","name":"per_page","description":"Number of items per page, values up to 100 supported","type":"integer","format":"int32","default":10,"required":false},{"in":"query","name":"fields","description":"Fields to return in response","type":"array","items":{"type":"string"},"required":false}],"security":[{"company_auth":["document:send","document:receive"],"operator_auth":["operator:documents:send","operator:documents:receive"]}],"responses":{"200":{"description":"Query documents","schema":{"type":"array","items":{"$ref":"#/definitions/API_Entities_Document"}}}},"tags":["documents"],"operationId":"getV1Documents"},"post":{"description":"Create document","produces":["application/json"],"consumes":["multipart/form-data"],"parameters":[{"in":"formData","name":"file","description":"File content as a single file","type":"file","required":false},{"in":"formData","name":"files[n][file]","description":"File content as one of multiple","type":"file","required":false},{"in":"formData","name":"files[n][file_type]","description":"File type","type":"string","enum":["PRIMARY_FILE","ATTACHMENT","OTHER"],"required":false},{"in":"formData","name":"references[n][reference_id]","description":"Reference to use for the document","type":"string","required":false},{"in":"formData","name":"references[n][reference_id_type]","description":"Type of reference id","type":"string","enum":["document_id","external_storage_key"],"required":false},{"in":"formData","name":"references[n][checksum]","description":"Checksum of the referenced content","type":"string","required":false},{"in":"formData","name":"references[n][file_type]","description":"File type","type":"string","enum":["PRIMARY_FILE","ATTACHMENT","OTHER"],"required":false},{"in":"formData","name":"type","description":"Type of Document","type":"string","enum":["UNKNOWN","INVOICE","CREDIT_NOTE","ORDER","ORDER_RESPONSE","CATALOGUE","CATALOGUE_RESPONSE","SELF_BILLING_INVOICE","DESPATCH_ADVICE","RECEIPT","VOUCHER","BANK_FILE","REMINDER","SCAN","INVOICE_RESPONSE","MESSAGE_LEVEL_RESPONSE","EXPRESSION_OF_INTEREST_REQUEST","EXPRESSION_OF_INTEREST_RESPONSE","TENDER_STATUS_REQUEST","CALL_FOR_TENDERS","TENDER","TENDER_RECEIPT","ORDER_CHANGE","ORDER_CANCELLATION","SELF_BILLING_CREDIT_NOTE"],"required":false},{"in":"formData","name":"transmission_id","description":"Unique transmission ID","type":"string","required":false},{"in":"formData","name":"transmission_at","description":"Official transmission timestamp","type":"string","format":"date-time","required":false},{"in":"formData","name":"external_id","description":"External identifier linked to the document","type":"string","required":false},{"in":"formData","name":"recipient_name","description":"Name of Recipient","type":"string","required":false},{"in":"formData","name":"recipient_country","description":"Recipient country in ISO 3166-1 alpha-2 format (2 letters)","type":"string","required":false},{"in":"formData","name":"recipient_eia","description":"Electronic Invoicing Address of the recipient","type":"string","required":false},{"in":"formData","name":"recipient_operator","description":"Operator of Recipient","type":"string","required":false},{"in":"formData","name":"sender_name","description":"Name of Sender","type":"string","required":false},{"in":"formData","name":"sender_country","description":"Sender country in ISO 3166-1 alpha-2 format (2 letters)","type":"string","required":false},{"in":"formData","name":"sender_eia","description":"Electronic Invoicing Address of the sender","type":"string","required":false},{"in":"query","name":"fields","description":"Fields to return in response","type":"array","items":{"type":"string"},"required":false}],"security":[{"company_auth":["document:send"],"operator_auth":["operator:documents:send"]}],"responses":{"201":{"description":"Create document","schema":{"$ref":"#/definitions/API_Entities_Document"}},"422":{"description":"- **document_duplicate_transmission_id**: The provided transmission_id is already in use","schema":{"$ref":"#/definitions/API_Entities_Error"}}},"tags":["documents"],"operationId":"postV1Documents"}},"/v1/documents/{id}":{"get":{"description":"Document details","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of Document","type":"string","required":true},{"in":"query","name":"return_format","description":"Content type for the details. Will return the stored metadata as default.","type":"array","items":{"type":"string"},"required":false},{"in":"query","name":"fields","description":"Fields to return in response","type":"array","items":{"type":"string"},"required":false}],"security":[{"company_auth":["document:send","document:receive"],"operator_auth":["operator:documents:send","operator:documents:receive"]}],"responses":{"200":{"description":"Document details","schema":{"$ref":"#/definitions/API_Entities_Document"}}},"tags":["documents"],"operationId":"getV1DocumentsId"},"patch":{"description":"Update existing document","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of Document","type":"string","required":true},{"in":"query","name":"fields","description":"Fields to return in response","type":"array","items":{"type":"string"},"required":false},{"name":"patchV1DocumentsId","in":"body","required":true,"schema":{"$ref":"#/definitions/patchV1DocumentsId"}}],"security":[{"company_auth":["document:send","document:receive"],"operator_auth":["operator:documents:send","operator:documents:receive"]}],"responses":{"204":{"description":"Document updated sucessfully"},"409":{"description":"- **document_in_invalid_state**: Document must be in the delivered state","schema":{"$ref":"#/definitions/API_Entities_Error"}}},"tags":["documents"],"operationId":"patchV1DocumentsId"}},"/v1/documents/{id}/events":{"get":{"description":"Document's events","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of Document","type":"string","required":true},{"in":"query","name":"fields","description":"Fields to return in response","type":"array","items":{"type":"string"},"required":false}],"security":[{"company_auth":["document:send","document:receive"],"operator_auth":["operator:documents:send","operator:documents:receive"]}],"responses":{"200":{"description":"Document's events","schema":{"$ref":"#/definitions/API_Entities_DocumentEvent"}}},"tags":["documents"],"operationId":"getV1DocumentsIdEvents"}},"/v1/analysis/definitions":{"get":{"description":"Get definition of all supported analysis checks","produces":["application/json"],"parameters":[{"in":"query","name":"checks","description":"Filter definitions by checks. Possible values:  SUPPLIER_ACTIVATION, BANK_ACCOUNT_CHANGED, SENDER_BID_STATUS, SENDER_WARNING_LIST, VAT","type":"array","items":{"type":"string","enum":["SUPPLIER_ACTIVATION","BANK_ACCOUNT_CHANGED","SENDER_BID_STATUS","SENDER_WARNING_LIST","VAT"]},"required":false},{"in":"query","name":"check_attributes","description":"Filter only definitions of interest. Possible values:  name, friendly_name, friendly_names, title, titles, description, descriptions, doc_description, resource_type, scope, scopes, sources, metadata, possible_results","type":"array","items":{"type":"string","enum":["name","friendly_name","friendly_names","title","titles","description","descriptions","doc_description","resource_type","scope","scopes","sources","metadata","possible_results"]},"required":false}],"responses":{"200":{"description":"","schema":{"$ref":"#/definitions/CheckDefinitions"}}},"tags":["analysis"],"operationId":"getV1AnalysisDefinitions"}},"/v1/analysis":{"post":{"summary":"Trigger analysis for resource","description":"Following checks can be triggered:\n\n**SUPPLIER_ACTIVATION**\nCheck performed on: INVOICE\nFor invoices received through scan service, checks if the sender has sent electronic invoices in the past and could be contacted to change to electronic sending.\n\n\n**BANK_ACCOUNT_CHANGED**\nCheck performed on: INVOICE\n\n\n\n**SENDER_BID_STATUS**\nCheck performed on: INVOICE\nChecks the invoice sender against national company register to see that the company business ID is registered and active.\nThe check also returns information if the company is going through insolvency or bankruptcy proceedings.\nFor Finland additional checking that the company is found in the Prepayment register.\nThe registries used to get this information, depend on the country of the sender and are as follows:\n1. Finland - YTJ [ http://www.ytj.fi ]\n2. Norway - Brønnøysundregistrene [ https://brreg.no ]\n3. Other countries -> not supported\n\n\n\n**SENDER_WARNING_LIST**\nCheck performed on: INVOICE\nChecks the invoice sender against a list of suspicious/fraud companies.\n\n\n**VAT**\nCheck performed on: INVOICE\nFor invoices containing value added tax, checks that the sender of the invoice is found in VAT register.\nNote that if the total amount of value added tax on the invoice is under 1 EUR/NOK/SEK etc., the invoice sender is not checked against the VAT register.\nThe registries used to get this information, depend on the country of the sender and are as follows:\n1. Norway - Brønnøysundregistrene [ https://brreg.no ]\n2. EU countries - Vies [ https://ec.europa.eu/taxation_customs/vies/ ]\n3. Other countries - not supported\n\n\n","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"query","name":"resource_id","description":"The ID of the resource","type":"string","required":true},{"in":"query","name":"resource_type","description":"The type of the resource to run checks for","type":"string","enum":["INVOICE"],"required":true},{"in":"query","name":"checks_to_run","description":"Which checks to run: e.g. SUPPLIER_ACTIVATION, BANK_ACCOUNT_CHANGED, SENDER_BID_STATUS, SENDER_WARNING_LIST, VAT","type":"array","items":{"type":"string","enum":["SUPPLIER_ACTIVATION","BANK_ACCOUNT_CHANGED","SENDER_BID_STATUS","SENDER_WARNING_LIST","VAT"]},"required":true}],"security":[{"company_auth":["analysis"],"operator_auth":["operator:analysis"]}],"responses":{"201":{"description":"Analysis was triggered and the status is pending","schema":{"type":"array","items":{"$ref":"#/definitions/Analysis"}}},"400":{"description":"Bad request","schema":{"$ref":"#/definitions/API_Entities_Error"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/API_Entities_Error"}},"404":{"description":"Resource not found or you don't have access to it","schema":{"$ref":"#/definitions/API_Entities_Error"}}},"tags":["analysis"],"operationId":"postV1Analysis"}},"/v1/analysis/{id}":{"get":{"description":"Resource analysis result","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The ID of the invoice","type":"string","required":true}],"security":[{"company_auth":["analysis"],"operator_auth":["operator:analysis"]}],"responses":{"200":{"description":"Possible results:\n\n**SUPPLIER_ACTIVATION**\n| <div style=\"width:150px\">Status</div> | <div style=\"width:150px\">Result</div> | <div style=\"width:390px\">Reason</div> | <div style=\"width:200px\">Reason code</div> |\n|------------------|------------------|------------------|-----------------------|\n`                NOT_APPLICABLE`|`NOT_APPLICABLE`|`This is not an invoice. Supplier activation check was not performed.`|`SUPPLIER_ACTIVATION_NOT_AN_INVOICE`|\n`                    RUN_FAILED`|`FAILED`|`Something went wrong when executing the check. Detect could not automatically check if supplier can send electronic invoices.`|`SUPPLIER_ACTIVATION_FAILED`|\n`                       PENDING`||`Check is waiting to be executed.`|`SUPPLIER_ACTIVATION_PENDING`|\n`                NOT_APPLICABLE`|`NOT_APPLICABLE`|`Invoice is not from scan. Supplier activation check was not performed.`|`SUPPLIER_ACTIVATION_INVOICE_NOT_FROM_SCAN`|\n`                RUN_SUCCESSFUL`|`WARNING`|`Sender information is missing from the invoice. Detect could not check if the company can send electronic invoices.`|`SUPPLIER_ACTIVATION_INVALID_INPUT`|\n`                RUN_SUCCESSFUL`|`WARNING`|`According to our data it looks that the company '%{bid}' could also send electronic invoices.`|`SUPPLIER_ACTIVATION_COMPANY_CAN_SEND_ELECTRONIC`|\n`                RUN_SUCCESSFUL`|`OK`|`According to our data, the company '%{bid}' has no record of sending electronic invoices.`|`SUPPLIER_ACTIVATION_COMPANY_CAN_ONLY_SEND_SCAN`\n\n\n**BANK_ACCOUNT_CHANGED**\n| <div style=\"width:150px\">Status</div> | <div style=\"width:150px\">Result</div> | <div style=\"width:390px\">Reason</div> | <div style=\"width:200px\">Reason code</div> |\n|------------------|------------------|------------------|-----------------------|\n`                NOT_APPLICABLE`|`NOT_APPLICABLE`|`This is not an invoice. Bank account changed check was not performed.`|`BANK_ACCOUNT_CHANGED_NOT_AN_INVOICE`|\n`                    RUN_FAILED`|`FAILED`|`Something went wrong when executing the check. Detect could not automatically check if supplier's bank account has changed.`|`BANK_ACCOUNT_CHANGED_FAILED`|\n`                       PENDING`||`Check is waiting to be executed.`|`BANK_ACCOUNT_CHANGED_PENDING`|\n`                RUN_SUCCESSFUL`|`WARNING`|`No valid bank accounts were found on the invoice. Detect could not check the sender bank account.`|`BANK_ACCOUNT_CHANGED_INVALID_INPUT`|\n`                NOT_APPLICABLE`|`NOT_APPLICABLE`|`No bank account information to check was found on the invoice.`|`BANK_ACCOUNT_CHANGED_NO_BANK_ACCOUNTS`|\n`                RUN_SUCCESSFUL`|`WARNING`|`There are no previously known bank accounts for the sender or use of the data is restricted. Detect could not check if the sender bank account has changed.`|`BANK_ACCOUNT_CHANGED_UNKNOWN`|\n`                RUN_SUCCESSFUL`|`WARNING`|`The bank account %{bank_account} on the invoice is different from what the sender %{bid} has used before.`|`BANK_ACCOUNT_CHANGED_CHANGED`|\n`                RUN_SUCCESSFUL`|`OK`|`The bank account %{bank_account} on the invoice is known to be used by the sender %{bid} before.`|`BANK_ACCOUNT_CHANGED_NOT_CHANGED`\n\n\n**SENDER_BID_STATUS**\n| <div style=\"width:150px\">Status</div> | <div style=\"width:150px\">Result</div> | <div style=\"width:390px\">Reason</div> | <div style=\"width:200px\">Reason code</div> |\n|------------------|------------------|------------------|-----------------------|\n`                NOT_APPLICABLE`|`NOT_APPLICABLE`|`This is not an invoice. Sender BID check was not performed.`|`SENDER_BID_STATUS_NOT_AN_INVOICE`|\n`                    RUN_FAILED`|`FAILED`|`Something went wrong when executing the check.`|`SENDER_BID_STATUS_FAILED`|\n`                NOT_APPLICABLE`|`NOT_APPLICABLE`|`The sender BID status check is not supported for senders from '%{country}'.`|`SENDER_BID_STATUS_COUNTRY_NOT_SUPPORTED`|\n`                RUN_SUCCESSFUL`|`WARNING`|`The sender '%{bid}' was not found in %{registry_name}.`|`SENDER_BID_STATUS_NOT_FOUND`|\n`                RUN_SUCCESSFUL`|`WARNING`|`Invalid sender bid '%{bid}' for registry '%{registry_name}'.`|`SENDER_BID_STATUS_INVALID_BID`|\n`                RUN_SUCCESSFUL`|`WARNING`|`Sender BID is missing from the invoice. Detect could not check sender BusinessID status.`|`SENDER_BID_STATUS_NOT_FOUND_NO_BID`|\n`                RUN_SUCCESSFUL`|`WARNING`|`The sender '%{bid}' was found in %{registry_name}, but has been closed.`|`SENDER_BID_STATUS_INACTIVE`|\n`                RUN_SUCCESSFUL`|`WARNING`|`The sender '%{bid}' was found in %{registry_name}, but is under liquidation (%{liquidation_state}).`|`SENDER_BID_STATUS_UNDER_LIQUIDATION`|\n`                RUN_SUCCESSFUL`|`WARNING`|`The sender '%{bid}' was found in %{registry_name}, but is under reorganization (%{reorganization_state}).`|`SENDER_BID_STATUS_UNDER_REORGANIZATION`|\n`                RUN_SUCCESSFUL`|`WARNING`|`The sender '%{bid}' was found in %{registry_name}, but is bankrupt (%{bankruptcy_state}).`|`SENDER_BID_STATUS_BANKRUPT`|\n`                RUN_SUCCESSFUL`|`WARNING`|`The sender '%{bid}' was found in %{registry_name}, but is on hold (%{on_hold_state}).`|`SENDER_BID_STATUS_ON_HOLD`|\n`                RUN_SUCCESSFUL`|`WARNING`|`The sender '%{bid}' was found in %{registry_name} but is not in the Prepayment register.`|`SENDER_BID_STATUS_PREPAYMENT_REGISTER_NOT_FOUND`|\n`                RUN_SUCCESSFUL`|`OK`|`The sender '%{bid}' was found in %{registry_name} and is in the Prepayment register.`|`SENDER_BID_STATUS_PREPAYMENT_REGISTER_FOUND`|\n`                RUN_SUCCESSFUL`|`OK`|`The sender '%{bid}' was found in %{registry_name}.`|`SENDER_BID_STATUS_FOUND`|\n`                       PENDING`||`Check is waiting to be executed.`|`SENDER_BID_STATUS_PENDING`\n\n\n**SENDER_WARNING_LIST**\n| <div style=\"width:150px\">Status</div> | <div style=\"width:150px\">Result</div> | <div style=\"width:390px\">Reason</div> | <div style=\"width:200px\">Reason code</div> |\n|------------------|------------------|------------------|-----------------------|\n`                NOT_APPLICABLE`|`NOT_APPLICABLE`|`This is not an invoice. Sender warning list check was not performed.`|`SENDER_WARNING_LIST_NOT_AN_INVOICE`|\n`                    RUN_FAILED`|`FAILED`|`Something went wrong when executing the check. Detect could not automatically check if sender is found in a warning list.`|`SENDER_WARNING_LIST_FAILED`|\n`                       PENDING`||`Check is waiting to be executed.`|`SENDER_WARNING_LIST_PENDING`|\n`                RUN_SUCCESSFUL`|`WARNING`|`Sender information is missing from the invoice. Detect could not check if the invoice sender is found on the warning list or has been reported suspicious.`|`SENDER_WARNING_LIST_INVALID_INPUT`|\n`                RUN_SUCCESSFUL`|`OK`|`The sender '%{bid} - %{name}' was not found in a warning list.`|`SENDER_WARNING_LIST_NOT_FOUND`|\n`                RUN_SUCCESSFUL`|`WARNING`|`The sender '%{found_search_term}' was found from warning list (sources: %{sources}%{links_to_source_warnings}).`|`SENDER_WARNING_LIST_FOUND`|\n`                RUN_SUCCESSFUL`|`WARNING`|`The sender '%{found_search_term}' was found in warning list (sources: %{sources}%{links_to_source_warnings}), this company has been reported by %{reporter_count} Visma customers.`|`SENDER_WARNING_LIST_USER_REPORTED_FOUND`\n\n\n**VAT**\n| <div style=\"width:150px\">Status</div> | <div style=\"width:150px\">Result</div> | <div style=\"width:390px\">Reason</div> | <div style=\"width:200px\">Reason code</div> |\n|------------------|------------------|------------------|-----------------------|\n`                NOT_APPLICABLE`|`NOT_APPLICABLE`|`This is not an invoice. Sender VAT check was not performed.`|`VAT_NOT_AN_INVOICE`|\n`                    RUN_FAILED`|`FAILED`|`Something went wrong when executing the check. Detect could not automatically check if sender is found in the VAT register.`|`VAT_FAILED`|\n`                       PENDING`||`Check is waiting to be executed.`|`VAT_PENDING`|\n`                RUN_SUCCESSFUL`|`WARNING`|`Invoice is missing information of sender or VAT amount. Detect could not perform sender VAT check.`|`VAT_INVALID_INPUT`|\n`                RUN_SUCCESSFUL`|`WARNING`|`The sender '%{bid}' is not found in VAT registry.`|`VAT_COMPANY_NOT_REGISTERED`|\n`                NOT_APPLICABLE`|`NOT_APPLICABLE`|`No VAT charged in the invoice.`|`VAT_NO_VAT_CHARGED`|\n`                RUN_SUCCESSFUL`|`OK`|`The sender '%{bid}' is found in VAT registry.`|`VAT_COMPANY_REGISTERED`\n\n","schema":{"type":"array","items":{"$ref":"#/definitions/Analysis"}}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/API_Entities_Error"}},"404":{"description":"Invoice not found or you don't have access to it","schema":{"$ref":"#/definitions/API_Entities_Error"}}},"tags":["analysis"],"operationId":"getV1AnalysisId"}},"/v1/partner/invoice_delivery_actions/inbound":{"get":{"summary":"List inbound invoice delivery actions","description":"","produces":["application/json"],"parameters":[{"in":"query","name":"state","type":"string","default":"CREATED","required":false},{"in":"query","name":"page","description":"Page to fetch","type":"integer","format":"int32","default":1,"required":false},{"in":"query","name":"per_page","description":"Number of items per page, values up to 100 supported","type":"integer","format":"int32","default":100,"required":false}],"security":[{"company_auth":["partner:invoice_delivery_actions"]}],"responses":{"200":{"description":"List inbound invoice delivery actions","schema":{"type":"array","items":{"$ref":"#/definitions/Partner_HttpApi_Entities_InvoiceEventsReceived"}}}},"tags":["partner"],"operationId":"getV1PartnerInvoiceDeliveryActionsInbound"}},"/v1/partner/invoice_delivery_actions/outbound_errors":{"get":{"summary":"List outbound invoice errors","description":"","produces":["application/json"],"parameters":[{"in":"query","name":"happened_after","description":"Happened after","type":"string","format":"date-time","required":true},{"in":"query","name":"happened_before","description":"Happened before. Will default to current time.","type":"string","format":"date-time","required":false},{"in":"query","name":"page","description":"Page to fetch","type":"integer","format":"int32","default":1,"required":false},{"in":"query","name":"per_page","description":"Number of items per page, values up to 100 supported","type":"integer","format":"int32","default":100,"required":false}],"security":[{"company_auth":["partner:invoice_delivery_actions"]}],"responses":{"200":{"description":"List outbound invoice errors","schema":{"type":"array","items":{"$ref":"#/definitions/Partner_HttpApi_Entities_InvoiceEventsSentError"}}}},"tags":["partner"],"operationId":"getV1PartnerInvoiceDeliveryActionsOutboundErrors"}},"/v1/partner/invoice_events/received":{"get":{"summary":"List inbound invoice delivery actions","description":"","produces":["application/json"],"parameters":[{"in":"query","name":"state","type":"string","default":"CREATED","required":false},{"in":"query","name":"page","description":"Page to fetch","type":"integer","format":"int32","default":1,"required":false},{"in":"query","name":"per_page","description":"Number of items per page, values up to 100 supported","type":"integer","format":"int32","default":100,"required":false}],"security":[{"company_auth":["partner:invoice_delivery_actions"]}],"responses":{"200":{"description":"List inbound invoice delivery actions","schema":{"type":"array","items":{"$ref":"#/definitions/Partner_HttpApi_Entities_InvoiceEventsReceived"}}}},"tags":["partner"],"operationId":"getV1PartnerInvoiceEventsReceived"}},"/v1/partner/invoice_events/sent_errors":{"get":{"summary":"List outbound invoice errors","description":"","produces":["application/json"],"parameters":[{"in":"query","name":"happened_after","description":"Happened after","type":"string","format":"date-time","required":true},{"in":"query","name":"happened_before","description":"Happened before. Will default to current time.","type":"string","format":"date-time","required":false},{"in":"query","name":"page","description":"Page to fetch","type":"integer","format":"int32","default":1,"required":false},{"in":"query","name":"per_page","description":"Number of items per page, values up to 100 supported","type":"integer","format":"int32","default":100,"required":false}],"security":[{"company_auth":["partner:invoice_delivery_actions"]}],"responses":{"200":{"description":"List outbound invoice errors","schema":{"type":"array","items":{"$ref":"#/definitions/Partner_HttpApi_Entities_InvoiceEventsSentError"}}}},"tags":["partner"],"operationId":"getV1PartnerInvoiceEventsSentErrors"}},"/v1/partner/lookups/companies":{"get":{"summary":"List companies availability","description":"","produces":["application/json"],"parameters":[{"in":"query","name":"bids","description":"Business ids. Maximum number of bids: 10","type":"array","items":{"type":"string"},"required":true},{"in":"query","name":"country","description":"Country in ISO 3166-1 alpha-2 format (2 letters)","type":"string","required":true}],"security":[{"company_auth":["partner:lookups"]}],"responses":{"200":{"description":"List companies availability","schema":{"type":"array","items":{"$ref":"#/definitions/Partner_HttpApi_Entities_CompanyLookups"}}}},"tags":["partner"],"operationId":"getV1PartnerLookupsCompanies"}},"/v1/partner/scan_service/lyanthe":{"post":{"summary":"[EXPERIMENTAL] Mark Lyanthe scan service as active.","description":"","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postV1PartnerScanServiceLyanthe","in":"body","required":true,"schema":{"$ref":"#/definitions/postV1PartnerScanServiceLyanthe"}}],"security":[{"company_auth":["partner:lyanthe_scan_service"]}],"responses":{"204":{"description":""}},"tags":["partner"],"operationId":"postV1PartnerScanServiceLyanthe"},"delete":{"summary":"[EXPERIMENTAL] Mark Lyanthe scan service as inactive","description":"","produces":["application/json"],"parameters":[{"in":"query","name":"company_id","description":"Company id","type":"string","required":true}],"security":[{"company_auth":["partner:lyanthe_scan_service"]}],"responses":{"204":{"description":""}},"tags":["partner"],"operationId":"deleteV1PartnerScanServiceLyanthe"},"get":{"summary":"[EXPERIMENTAL] Fetch Lyanthe scan service information","description":"","produces":["application/json"],"parameters":[{"in":"query","name":"company_id","description":"Company id","type":"string","required":true}],"security":[{"company_auth":["partner:lyanthe_scan_service"]}],"responses":{"200":{"description":"[EXPERIMENTAL] Fetch Lyanthe scan service information","schema":{"$ref":"#/definitions/API_Entities_ScanService"}}},"tags":["partner"],"operationId":"getV1PartnerScanServiceLyanthe"}},"/v1/partner/takeovers/companies":{"get":{"summary":"[EXPERIMENTAL] List available company IDs","description":"","produces":["application/json"],"parameters":[{"in":"query","name":"query","description":"Organization number","type":"string","required":true}],"security":[{"company_auth":["partner:takeovers"]}],"responses":{"200":{"description":""}},"tags":["partner"],"operationId":"getV1PartnerTakeoversCompanies"}},"/v1/partner/takeovers":{"post":{"summary":"[EXPERIMENTAL] Start takeover process","description":"","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postV1PartnerTakeovers","in":"body","required":true,"schema":{"$ref":"#/definitions/postV1PartnerTakeovers"}}],"security":[{"company_auth":["partner:takeovers"]}],"responses":{"201":{"description":""}},"tags":["partner"],"operationId":"postV1PartnerTakeovers"}},"/v1/partner/takeovers/{takeover_id}/complete":{"post":{"summary":"[EXPERIMENTAL] Complete takeover process","description":"","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"takeover_id","type":"string","required":true}],"security":[{"company_auth":["partner:takeovers"]}],"responses":{"200":{"description":""}},"tags":["partner"],"operationId":"postV1PartnerTakeoversTakeoverIdComplete"}},"/v1/partner/takeovers/{takeover_id}":{"delete":{"summary":"[EXPERIMENTAL] Revert takeover process","description":"","produces":["application/json"],"parameters":[{"in":"path","name":"takeover_id","type":"string","required":true}],"security":[{"company_auth":["partner:takeovers"]}],"responses":{"204":{"description":""}},"tags":["partner"],"operationId":"deleteV1PartnerTakeoversTakeoverId"}},"/v1/fi_bank_messages/ri_messages":{"get":{"summary":"List IDs of incoming RI messages within given timeframe","description":"","produces":["application/json"],"parameters":[{"in":"query","name":"timestamp_start","description":"Start timestamp","type":"string","format":"date-time","required":true},{"in":"query","name":"timestamp_end","description":"End timestamp","type":"string","format":"date-time","required":true}],"security":[{"company_auth":["fi_bank_message:receive"]}],"responses":{"200":{"description":"Array of ids, e.g. [\"id1\", \"id2\"]"}},"tags":["fi_bank_messages"],"operationId":"getV1FiBankMessagesRiMessages"}},"/v1/fi_bank_messages/ri_messages/{id}":{"get":{"summary":"Get content of single RI message","description":"","produces":["application/xml"],"parameters":[{"in":"path","name":"id","description":"Message ID","type":"string","required":true}],"security":[{"company_auth":["fi_bank_message:receive"]}],"responses":{"200":{"description":"Get content of single RI message"}},"tags":["fi_bank_messages"],"operationId":"getV1FiBankMessagesRiMessagesId"},"delete":{"summary":"Delete a single RI message","description":"","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Message ID","type":"string","required":true}],"security":[{"company_auth":["fi_bank_message:receive"]}],"responses":{"204":{"description":"Message deleted successfully"}},"tags":["fi_bank_messages"],"operationId":"deleteV1FiBankMessagesRiMessagesId"}},"/v1/fi_bank_messages/sent_messages":{"get":{"summary":"List IDs of sent messages within given timeframe","description":"","produces":["application/json"],"parameters":[{"in":"query","name":"message_type","description":"Message Type","type":"string","enum":["SENDERINFO","RECEIVERPROPOSAL"],"required":true},{"in":"query","name":"timestamp_start","description":"Start timestamp","type":"string","format":"date-time","required":true},{"in":"query","name":"timestamp_end","description":"End timestamp","type":"string","format":"date-time","required":true}],"security":[{"company_auth":["fi_bank_message:send"]}],"responses":{"200":{"description":"Array of ids, e.g. [\"id1\", \"id2\"]"}},"tags":["fi_bank_messages"],"operationId":"getV1FiBankMessagesSentMessages"}},"/v1/fi_bank_messages/sent_messages/{id}":{"get":{"summary":"Get content of single message","description":"","produces":["application/xml"],"parameters":[{"in":"path","name":"id","description":"Message ID","type":"string","required":true}],"security":[{"company_auth":["fi_bank_message:send"]}],"responses":{"200":{"description":"Get content of single message"}},"tags":["fi_bank_messages"],"operationId":"getV1FiBankMessagesSentMessagesId"}},"/v1/fi_bank_messages/error_messages":{"get":{"summary":"List IDs of incoming error messages within given timeframe","description":"","produces":["application/json"],"parameters":[{"in":"query","name":"timestamp_start","description":"Start timestamp","type":"string","format":"date-time","required":true},{"in":"query","name":"timestamp_end","description":"End timestamp","type":"string","format":"date-time","required":true}],"security":[{"company_auth":["fi_bank_message:receive"]}],"responses":{"200":{"description":"Array of ids, e.g. [\"id1\", \"id2\"]"}},"tags":["fi_bank_messages"],"operationId":"getV1FiBankMessagesErrorMessages"}},"/v1/fi_bank_messages/error_messages/{id}":{"get":{"summary":"Get content of single error message","description":"","produces":["application/xml"],"parameters":[{"in":"path","name":"id","description":"Message ID","type":"string","required":true}],"security":[{"company_auth":["fi_bank_message:receive"]}],"responses":{"200":{"description":"Get content of single error message"}},"tags":["fi_bank_messages"],"operationId":"getV1FiBankMessagesErrorMessagesId"}},"/v1/fi_bank_messages":{"post":{"summary":"Upload new message","description":"","produces":["application/json"],"consumes":["multipart/form-data"],"parameters":[{"in":"formData","name":"file","description":"File content","type":"file","required":true}],"security":[{"company_auth":["fi_bank_message:send"]}],"responses":{"204":{"description":"Message uploaded successfully","headers":{"Location":{"description":"url for fetching the bank message","type":"string"}}}},"tags":["fi_bank_messages"],"operationId":"postV1FiBankMessages"}},"/v1/fi_bank_messages/{id}":{"get":{"summary":"Get status of sent message","description":"","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Message ID","type":"string","required":true}],"security":[{"company_auth":["fi_bank_message:send"]}],"responses":{"200":{"description":"Get status of sent message","schema":{"$ref":"#/definitions/FiBankMessages_HttpApi_Entities_FiBankMessageStatus"}}},"tags":["fi_bank_messages"],"operationId":"getV1FiBankMessagesId"}}},"definitions":{"API_Entities_Status":{"type":"object","properties":{"client_id":{"type":"string","description":"Authenticated client_id. Will be company_id for Companies"},"expires_at":{"type":"string","format":"date-time","description":"Tells when the current authentication token will expire"}},"required":["client_id"],"description":"API_Entities_Status model"},"API_Entities_OAuthToken":{"type":"object","properties":{"access_token":{"type":"string","description":"The access token issued"},"token_type":{"type":"string","description":"The type of the token issued"},"expires_in":{"type":"integer","format":"int32","description":"The lifetime in seconds of the access token"},"refresh_token":{"type":"string","description":"The refresh token, which can be used to obtain new access token"},"scope":{"type":"string","description":"List of scopes granted for token"}},"required":["access_token","token_type","expires_in"],"description":"API_Entities_OAuthToken model"},"API_Entities_OAuthCurrent":{"type":"object","properties":{"user":{"$ref":"#/definitions/API_Entities_User","description":"Current user"},"company":{"$ref":"#/definitions/API_Entities_CompanyParty","description":"Current user company"},"scopes":{"type":"array","items":{"type":"string"},"description":"List of granted scopes"}},"required":["user","company"],"description":"API_Entities_OAuthCurrent model"},"API_Entities_User":{"type":"object","properties":{"id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string"}},"required":["id"]},"API_Entities_CompanyParty":{"type":"object","properties":{"bid":{"type":"string","description":"Business ID / Organisation number"},"name":{"type":"string","description":"Name of party"},"country":{"type":"string","description":"Two letter country code of the party"},"vat":{"type":"string","description":"VAT number"},"id":{"type":"string","description":"Company Id (GUID)"},"wizard_done":{"type":"boolean","description":"Company has completed the first time wizard"},"disabled":{"type":"boolean","description":"Company is disabled"}},"required":["id"]},"OdpCompany":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"ID of ODP company"},"name":{"type":"string","description":"Name of ODP company"},"bid":{"type":"string","description":"Organisation number of ODP company"},"state":{"type":"string","enum":["CREATED","TRUSTED","DISABLED"],"description":"ODP Company state"},"services":{"type":"array","items":{"$ref":"#/definitions/OdpService"},"description":"ODP services associated to this ODP company"}},"required":["id"],"description":"OdpCompany model"},"OdpService":{"type":"object","properties":{"name":{"type":"string","description":"Name of ODP Service"}}},"ReceivablesService":{"type":"object","properties":{"iban":{"type":"string","description":"IBAN"},"bic":{"type":"string","description":"Bank identifier code"},"bank":{"type":"string","description":"Bank"},"contact_person":{"type":"string","description":"Contact person"},"contact_email":{"type":"string","description":"Contact email"},"customer_service_email":{"type":"string","description":"Customer service email"},"customer_service_phone_number":{"type":"string","description":"Customer service phone number"},"contact_phone_number":{"type":"string","description":"Contact Phone Number"},"authorization_email":{"type":"string","description":"Authorization email"},"accountable_party":{"type":"string","description":"Party who is responsible for monitoring the payments and adding them to assignments. The value \"vfs\" means using VFS account number, reference number and PDF image. The value \"company\" means using senders own account number, reference number and PDF image."},"billing_address":{"$ref":"#/definitions/API_Entities_VFSFI_BillingAddress","description":"Billing address"},"vfsfi":{"$ref":"#/definitions/API_Entities_VFSFI_Data","description":"VFSFI data"},"status":{"type":"string","enum":["DISABLED","ACTIVE","PENDING"],"description":"Service status"},"activation_url":{"type":"string","description":"Activation URL"},"service_type":{"type":"string","enum":["full","express"],"description":"Service type"}},"description":"ReceivablesService model"},"API_Entities_VFSFI_BillingAddress":{"type":"object","properties":{"country":{"type":"string","description":"Country"},"streets":{"type":"array","items":{"type":"string"},"description":"Streets"},"city":{"type":"string","description":"City"},"zip_code":{"type":"string","description":"Zip code"}}},"API_Entities_VFSFI_Data":{"type":"object","properties":{"iban":{"type":"string","description":"IBAN"},"bic":{"type":"string","description":"BIC"},"account_number":{"type":"string","description":"Account number"},"notes":{"type":"array","items":{"$ref":"#/definitions/API_Entities_VFSFI_Note"},"description":"Notes"}}},"API_Entities_VFSFI_Note":{"type":"object","properties":{"phrase":{"type":"string","description":"Phrase"},"code":{"type":"string","description":"Code"}}},"putV2ServicesAmiliReceivables":{"type":"object","properties":{"iban":{"type":"string","description":"IBAN"},"bic":{"type":"string","description":"Bank identifier code"},"bank":{"type":"string","description":"Bank"},"contact_person":{"type":"string","description":"Contact person"},"contact_email":{"type":"string","description":"Contact email"},"customer_service_email":{"type":"string","description":"Customer service email"},"customer_service_phone_number":{"type":"string","description":"Customer service phone number"},"contact_phone_number":{"type":"string","description":"Contact Phone Number"},"authorization_email":{"type":"string","description":"Authorization email, if this is not provided you will not get an email and the authorization process will proceed by accessing the activation_url from the GET method."},"accountable_party":{"type":"string","description":"Party who is responsible for monitoring the payments and adding them to assignments. The value \"vfs\" means using VFS account number, reference number and PDF image. The value \"company\" means using senders own account number, reference number and PDF image.","enum":["vfsfi","company"]},"service_type":{"type":"string","description":"Choose full collection services (Amili Kassavirta, default) or Amili Perintä","enum":["full","express"],"default":"full"},"billing_address":{"type":"object","properties":{"country":{"type":"string","description":"Country"},"streets":{"type":"array","description":"Streets","items":{"type":"string"}},"city":{"type":"string","description":"City"},"zip_code":{"type":"string","description":"Zip code"}},"required":["country","streets","city","zip_code"]},"postal_address":{"type":"object","description":"Postal address if different than the company address","properties":{"country":{"type":"string","description":"Country"},"streets":{"type":"array","description":"Streets","items":{"type":"string"}},"city":{"type":"string","description":"City"},"zip_code":{"type":"string","description":"Zip code"}}}},"required":["iban","bic","bank","contact_person","contact_email","customer_service_email","contact_phone_number","billing_address"],"description":"Start the Amili collection services onboarding"},"patchV2ServicesAmiliReceivables":{"type":"object","properties":{"accountable_party":{"type":"string","description":"Party who is responsible for monitoring the payments and adding them to assignments. The value \"vfs\" means using VFS account number, reference number and PDF image. The value \"company\" means using senders own account number, reference number and PDF image.","enum":["vfsfi","company"]},"service_type":{"type":"string","description":"Choose full collection services (Amili Kassavirta, default) or Amili Perintä","enum":["full","express"]}},"description":"Update the Amili collection services"},"putV2ServicesIntrumReceivables":{"type":"object","properties":{"agreement_contact_phone":{"type":"string","description":"Contact phone number for agreement purposes"},"agreement_contact_name":{"type":"string","description":"Contact name for agreement purposes"},"agreement_contact_email":{"type":"string","description":"Contact email for agreement purposes"},"details":{"type":"object","properties":{"real_estate_management_company":{"type":"string","description":"The name of the Real Estate Management Company"}}},"existing_agreement":{"type":"boolean","description":"Company already has an agreement with Intrum, skipping the activation process.Default is false."}},"required":["agreement_contact_phone","agreement_contact_name","agreement_contact_email"],"description":"Start the Intrum collection services onboarding"},"API_Entities_CompanyServices_Intrum":{"type":"object","properties":{"status":{"type":"string","enum":["PENDING","DISABLED","ACTIVE"],"description":"Service status"},"agreement_contact_phone":{"type":"string","description":"Contact phone number for agreement purposes"},"agreement_contact_email":{"type":"string","description":"Contact email for agreement purposes"},"agreement_contact_name":{"type":"string","description":"Contact name for agreement purposes"},"details":{"$ref":"#/definitions/API_Entities_CompanyServices_Intrum_Details","description":"Details"}},"description":"API_Entities_CompanyServices_Intrum model"},"API_Entities_CompanyServices_Intrum_Details":{"type":"object","properties":{"real_estate_management_company":{"type":"string","description":"The name of the Real Estate Management Company"}}},"patchV2ServicesIntrumReceivables":{"type":"object","properties":{"client_code":{"type":"string","description":"Client code. This is used to activate a pending service after contract has been signed and the agency has given a client_code to the customer."}},"description":"Update the Intrum collection services"},"putV2ServicesRopoReceivables":{"type":"object","properties":{"agreement_contact_email":{"type":"string","description":"Contact email for agreement purposes"}},"required":["agreement_contact_email"],"description":"Start the Ropo collection services onboarding [EXPERIMENTAL]"},"API_Entities_CompanyServices_Ropo":{"type":"object","properties":{"status":{"type":"string","enum":["PENDING","DISABLED","ACTIVE"],"description":"Service status"},"agreement_contact_email":{"type":"string","description":"Contact email for agreement purposes"}},"description":"API_Entities_CompanyServices_Ropo model"},"API_Entities_CompanyServices_ReceivablesDetails":{"type":"object","properties":{"agency":{"type":"string","enum":["AMILI","INTRUM","NONE"],"description":"Your current active agency"}},"description":"API_Entities_CompanyServices_ReceivablesDetails model"},"putV1ServicesReceivables":{"type":"object","properties":{"iban":{"type":"string","description":"IBAN"},"bic":{"type":"string","description":"Bank identifier code"},"bank":{"type":"string","description":"Bank"},"contact_person":{"type":"string","description":"Contact person"},"contact_email":{"type":"string","description":"Contact email"},"customer_service_email":{"type":"string","description":"Customer service email"},"customer_service_phone_number":{"type":"string","description":"Customer service phone number"},"contact_phone_number":{"type":"string","description":"Contact Phone Number"},"authorization_email":{"type":"string","description":"Authorization email, if this is not provided you will not get an email and the authorization process will proceed by accessing the activation_url from the GET method."},"accountable_party":{"type":"string","description":"Party who is responsible for monitoring the payments and adding them to assignments. The value \"vfs\" means using VFS account number, reference number and PDF image. The value \"company\" means using senders own account number, reference number and PDF image.","enum":["vfsfi","company"]},"service_type":{"type":"string","description":"Choose full collection services (Amili Kassavirta, default) or Amili Perintä","enum":["full","express"],"default":"full"},"billing_address":{"type":"object","properties":{"country":{"type":"string","description":"Country"},"streets":{"type":"array","description":"Streets","items":{"type":"string"}},"city":{"type":"string","description":"City"},"zip_code":{"type":"string","description":"Zip code"}},"required":["country","streets","city","zip_code"]},"postal_address":{"type":"object","description":"Postal address if different than the company address","properties":{"country":{"type":"string","description":"Country"},"streets":{"type":"array","description":"Streets","items":{"type":"string"}},"city":{"type":"string","description":"City"},"zip_code":{"type":"string","description":"Zip code"}}}},"required":["iban","bic","bank","contact_person","contact_email","customer_service_email","contact_phone_number","billing_address"],"description":"Start the collection services onboarding"},"patchV1ServicesReceivables":{"type":"object","properties":{"accountable_party":{"type":"string","description":"Party who is responsible for monitoring the payments and adding them to assignments. The value \"vfs\" means using VFS account number, reference number and PDF image. The value \"company\" means using senders own account number, reference number and PDF image.","enum":["vfsfi","company"]},"service_type":{"type":"string","description":"Choose full collection services (Amili Kassavirta, default) or Amili Perintä","enum":["full","express"]}},"description":"Update the collection services"},"API_Entities_CompanyAgreements_Atg":{"type":"object","properties":{"account_number":{"type":"string","description":"Account number"},"kid_length":{"type":"string","description":"Length of the KID"},"reference_position":{"type":"string","description":"Reference position in KID"},"payment_type_position":{"type":"string","description":"Payment type position in KID"},"notification_by_print":{"type":"boolean","description":"Notifications should be sent as print"},"notification_by_email":{"type":"boolean","description":"Notifications should be sent as email"},"status":{"type":"string","enum":["INACTIVE","ACTIVE","PENDING","DISABLED"],"description":"Agreement status"},"created_at":{"type":"string","format":"date-time","description":"Agreement creation timestamp"}},"description":"API_Entities_CompanyAgreements_Atg model"},"postV1ServicesAtg":{"type":"object","properties":{"account_number":{"type":"string","description":"Account number linked to agreement"},"kid_length":{"type":"integer","format":"int32","description":"Length of KID"},"reference_position":{"type":"string","description":"The reference position in the KID"},"payment_type_position":{"type":"string","description":"The payment type position in the KID"},"signer_email":{"type":"string","description":"Email for possible agreement signature request if required"},"notification_by_print":{"type":"boolean","description":"Send notification about ATG invoice by print"},"notification_by_email":{"type":"boolean","description":"Send notification about ATG invoice by email"}},"required":["account_number","kid_length","reference_position","signer_email"],"description":"Create a new ATG agreement"},"API_Entities_CompanyConsumers_Mandate":{"type":"object","properties":{"kid":{"type":"string","description":"KID"},"account_number":{"type":"string","description":"Account number"},"notification":{"type":"string","description":"Notifications enabled"},"status":{"type":"string","description":"Status"},"reference_nr":{"type":"string","description":"Reference nr from KID"},"payment_type":{"type":"string","description":"Payment type from KID"},"updated_at":{"type":"string","format":"date-time","description":"Entry updated timestamp"}},"description":"API_Entities_CompanyConsumers_Mandate model"},"patchV1ServicesAtgAccountNumber":{"type":"object","properties":{"kid_length":{"type":"integer","format":"int32","description":"Length of KID"},"reference_position":{"type":"string","description":"The reference position in the KID"},"payment_type_position":{"type":"string","description":"The payment type position in the KID"},"signer_email":{"type":"string","description":"Email for possible agreement signature request if required"},"notification_by_print":{"type":"boolean","description":"Send notification about ATG invoice by print"},"notification_by_email":{"type":"boolean","description":"Send notification about ATG invoice by email"}},"required":["kid_length","reference_position","signer_email"],"description":"Update existing ATG agreement"},"Detect_Checks":{"type":"object","properties":{"on_invoice_receive":{"type":"string","description":"Check name"}},"description":"Detect_Checks model"},"AutoScan_HttpApi_Entities_AutoScanConfiguration":{"type":"object","properties":{"status":{"type":"string","enum":["active","inactive"],"description":"AutoScan status"},"scan_email_address":{"type":"string","description":"AutoScan email address"},"return_email_address":{"type":"string","description":"Return email address for unscannable documents"},"features":{"type":"object","description":"AutoScan features"}},"description":"AutoScan_HttpApi_Entities_AutoScanConfiguration model"},"putV1ServicesAutoscan":{"type":"object","properties":{"return_email_address":{"type":"string","description":"Return email address for unscannable documents"},"features":{"type":"object","properties":{"invoice_line_scanning":{"type":"boolean","description":"Enable or disable invoice line scanning"}}}},"description":"Activates AutoScan"},"Scan_HttpApi_Entities_ScanConfiguration":{"type":"object","properties":{"status":{"type":"string","enum":["active","disabled","pending","error"],"description":"Scan status"},"error_message":{"type":"string","description":"Error message if status is pending else nil"},"scan_address":{"$ref":"#/definitions/Scan_HttpApi_Entities_ScanAddress","description":"Contains email and postal address, if supported, of scan address"},"return_address":{"$ref":"#/definitions/Scan_HttpApi_Entities_ReturnAddress","description":"Contains email and postal address, if supported, of return address"},"features":{"$ref":"#/definitions/Scan_HttpApi_Entities_ScanFeatures"}},"description":"Scan_HttpApi_Entities_ScanConfiguration model"},"Scan_HttpApi_Entities_ScanAddress":{"type":"object","properties":{"email_address":{"type":"string","description":"Email address where supplier should send pdf invoices"},"postal_address":{"$ref":"#/definitions/Scan_HttpApi_Entities_PostalAddress"}}},"Scan_HttpApi_Entities_PostalAddress":{"type":"object","properties":{"name":{"type":"string","description":"Name of the company"},"address1":{"type":"string"},"address2":{"type":"string"},"country_code":{"type":"string"},"post_code":{"type":"string"},"city":{"type":"string"}}},"Scan_HttpApi_Entities_ReturnAddress":{"type":"object","properties":{"email_address":{"type":"string","description":"Email address where all other material than invoices are delivered by the scanning service"},"postal_address":{"$ref":"#/definitions/Scan_HttpApi_Entities_PostalAddress"}}},"Scan_HttpApi_Entities_ScanFeatures":{"type":"object","properties":{"other_docs":{"type":"boolean","description":"Other documents"},"scan_reminders":{"type":"boolean","description":"Scan reminders"},"cash_discount_field_scanning":{"type":"boolean","description":"Cash discount field scanning"},"line_scanning":{"type":"boolean","description":"Line scanning"},"vat_liable":{"type":"boolean","description":"VAT liable"}}},"postV1ServicesKsefTokens":{"type":"object","properties":{"token":{"type":"string"}},"required":["token"],"description":"Create a KSeF token"},"API_Entities_CompanyConsumers_Consumer":{"type":"object","properties":{"name":{"type":"string","description":"Full name"},"customer_number":{"type":"string","description":"Customer number"},"reference_number":{"type":"string","description":"Reference number"},"email":{"type":"string","description":"Email address"},"phone":{"type":"string","description":"Phone number"},"status":{"type":"string","enum":["NEW","REQUEST_SENT","ACCEPTED","ACTIVE","DELETED","REJECTED","ERROR"],"description":"Status"},"updated_at":{"type":"string","format":"date-time","description":"Last update time"}},"required":["status"],"description":"API_Entities_CompanyConsumers_Consumer model"},"API_Entities_B2CNO_Status":{"type":"object","properties":{"status":{"type":"string","enum":["ACTIVE","FREE","RESERVED","FAULT","ERROR"],"description":"B2CNO Agreement status for company"}},"required":["status"],"description":"API_Entities_B2CNO_Status model"},"postV1ServicesB2cseAgreement":{"type":"object","properties":{"fui":{"type":"string","description":"FUI = Faktura Utställar Identitet. Only if company already has an existing agreement with their bank and knows their FUI. If given, also agreement_id is required."},"agreement_id":{"type":"string","description":"Agreement ID. Only if company already has an existing agreement with their bank and knows their agreement ID. If given, also fui is required."},"account_number":{"type":"string","description":"Account Number without dashes (123456)"},"account_type":{"type":"string","description":"Account type (PlusGiro or BankGiro)","enum":["PlusGiro","BankGiro"]},"website":{"type":"string","description":"Website URL"}},"required":["account_number","account_type"],"description":"Create B2CSE network registration request"},"API_Entities_Error":{"type":"object","properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"General error message"},"details":{"type":"array","items":{"type":"string"},"description":"Details about the error"}},"description":"API_Entities_Error model"},"API_Entities_B2CSE_Agreement":{"type":"object","properties":{"status":{"type":"string","description":"Status of the agreement"},"fui":{"type":"string","description":"FUI = Faktura Utställar Identitet"},"agreement_id":{"type":"string","description":"Agreement ID"},"account_number":{"type":"string","description":"Account Number without dashes (123456)"},"account_type":{"type":"string","enum":["PlusGiro","BankGiro"],"description":"Account type (PlusGiro or BankGiro)"},"website":{"type":"string","description":"Website URL"}},"description":"API_Entities_B2CSE_Agreement model"},"Invoices_HttpApi_Entities_InvoiceAssignmentV2":{"type":"object","properties":{"status":{"type":"string","enum":["pending","sent","error"]},"assignment_id":{"type":"string","description":"Assignment ID in the Receivables API"},"url":{"type":"string","description":"URL for fetching the assignment details"},"error_reason":{"type":"string","description":"Error reason when the status is pending or error"}},"required":["status"],"description":"Invoices_HttpApi_Entities_InvoiceAssignmentV2 model"},"postV2InvoicesIdAssignmentRopo":{"type":"object","properties":{"collection_type":{"type":"string","description":"Collection type","enum":["reminder_and_collection","collection"]},"receivables_type":{"type":"string","description":"Collection services type","enum":["b2b","b2c","b2b_rental","b2c_rental"]},"amounts":{"type":"object","description":"Detailed breakdown of amounts. Cannot be used in combination with collectable_amount.","properties":{"capital_amount":{"type":"number","format":"double","description":"Amount of capital invoiced. Needs to be a positive number (for example 100.50)."},"reminder_amount":{"type":"number","format":"double","description":"Amount of reminder fees invoiced. Needs to be a positive number (for example 5.00)."},"interest_amount":{"type":"number","format":"double","description":"Amount of previous interest invoiced. Needs to be a positive number (for example 10.50)."},"interest_calculation_date":{"type":"string","format":"date","description":"YYYY-MM-DD format. Date from which to start interest calculation.For cases where interest has been collected before assignment creation."}},"required":["capital_amount","reminder_amount","interest_amount"]},"payers":{"type":"array","description":"List of payers for the invoice","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of the payer","enum":["main_debtor","co_debtor"]},"ssn":{"type":"string","description":"Payer customer social security number, used for the legal collection process. Required for b2c_rental receivablestype."},"bid":{"type":"string","description":"Payer business ID, used for the legal collection process. Required for b2b and b2b_rental receivables type."},"name":{"type":"string","description":"Payer name (person full name or company name)"},"address":{"type":"object","description":"Payer address","properties":{"line1":{"type":"string","description":"Street address"},"line2":{"type":"string","description":"Additional address"},"post_code":{"type":"string","description":"Post code"},"city":{"type":"string","description":"City"},"country":{"type":"string","description":"Country name (eg. Finland)"}},"required":["line1","post_code","city","country"]}},"required":["type","name","address"]}},"assignment_summary":{"type":"string","description":"Free text summary of the assignment, sent to the collection agency."},"reminder_date":{"type":"string","format":"date","description":"Date of the original reminder sent to the customer. Format: YYYY-MM-DD. Required when sending to collection directly (collection_type=collection)."}},"required":["collection_type","receivables_type","payers"],"description":"Post assignment for invoice"},"postV2InvoicesIdAssignmentIntrum":{"type":"object","properties":{"collection_type":{"type":"string","description":"Collection type","enum":["reminder_and_collection","collection"]},"receivables_type":{"type":"string","description":"Collection services type","enum":["b2b","b2c","b2b_rental","b2c_rental"]},"amounts":{"type":"object","description":"Detailed breakdown of amounts. Cannot be used in combination with collectable_amount.","properties":{"capital_amount":{"type":"number","format":"double","description":"Amount of capital invoiced. Needs to be a positive number (for example 100.50)."},"reminder_amount":{"type":"number","format":"double","description":"Amount of reminder fees invoiced. Needs to be a positive number (for example 5.00)."},"interest_amount":{"type":"number","format":"double","description":"Amount of previous interest invoiced. Needs to be a positive number (for example 10.50)."},"interest_calculation_date":{"type":"string","format":"date","description":"YYYY-MM-DD format. Date from which to start interest calculation.For cases where interest has been collected before assignment creation."}},"required":["capital_amount","reminder_amount","interest_amount"]},"payers":{"type":"array","description":"List of payers for the invoice","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of the payer, main debtor or co_debtor","enum":["main_debtor","co_debtor"]},"identifier":{"type":"string","description":"Payer customer ID used for joining assignments when the payers are the same"},"ssn":{"type":"string","description":"Payer customer social security number, used for the legal collection process. Required for b2c_rental receivablestype."},"name":{"type":"string","description":"Payer name"}},"required":["type"]}},"rental":{"type":"object","description":"Only for collectibles regarding rental business. Cannot be used in combination with housing_charge. Currently only supported with the Intrum collection agency.","properties":{"address":{"type":"string","description":"Address of the rental target or the housing company"},"current_target_amount":{"type":"number","format":"double","description":"Total invoice sum assumed if target is not given."},"contract_expiry_date":{"type":"string","format":"date","description":"YYYY-MM-DD format. Applicable for temporary contracts."},"contract_type":{"type":"string","description":"continuous assumed if contract_expiry_date is not given","enum":["continuous","temporary"]}},"required":["address"]},"housing_charge":{"type":"object","description":"Only for collectibles regarding housing charges. Cannot be used in combination with rental. Currently only supported with the Intrum collection agency.","properties":{"address":{"type":"string","description":"Address of the target for which housing charge is collected"}},"required":["address"]}},"required":["collection_type","receivables_type","payers"],"description":"Post assignment for invoice"},"postV2InvoicesIdAssignmentAmili":{"type":"object","properties":{"collection_type":{"type":"string","description":"Collection type","enum":["reminder_and_collection","collection"]},"receivables_type":{"type":"string","description":"Collection services type","enum":["b2b","b2c","b2b_rental","b2c_rental"]}},"required":["collection_type","receivables_type"],"description":"Post assignment for invoice"},"Invoices_HttpApi_Entities_InvoiceAssignment":{"type":"object","properties":{"status":{"type":"string","enum":["pending","sent","error"]},"url":{"type":"string","description":"URL for fetching the assignment details"},"collectable_amount":{"type":"number","format":"double","description":"Collectable amount"},"error_reason":{"type":"string","description":"Error reason when the status is pending or error"}},"required":["status"],"description":"Invoices_HttpApi_Entities_InvoiceAssignment model"},"postV1InvoicesIdAssignment":{"type":"object","properties":{"collection_type":{"type":"string","description":"Collection type","enum":["reminder_and_collection","collection"]},"collectable_amount":{"type":"number","format":"double","description":"Total collectable amount, needs to be a positive number (for example 100.50). Cannot be used in combination with amounts."},"amounts":{"type":"object","description":"Detailed breakdown of amounts. Cannot be used in combination with collectable_amount.","properties":{"capital_amount":{"type":"number","format":"double","description":"Amount of capital invoiced. Needs to be a positive number (for example 100.50)."},"reminder_amount":{"type":"number","format":"double","description":"Amount of reminder fees invoiced. Needs to be a positive number (for example 5.00)."},"interest_amount":{"type":"number","format":"double","description":"Amount of previous interest invoiced. Needs to be a positive number (for example 10.50)."},"interest_calculation_date":{"type":"string","format":"date","description":"YYYY-MM-DD format. Date from which to start interest calculation.For cases where interest has been collected before assignment creation."}},"required":["capital_amount","reminder_amount","interest_amount"]},"payer_identifiers":{"type":"array","description":"List of payer customer IDs, used for joining assignments when the payers are the same","items":{"type":"string"}},"payer_ssns":{"type":"array","description":"List of payer customer social security numbers, used for the legal collection process","items":{"type":"string"}},"industry_specific_options":{"type":"object","description":"Industry specific optional parameters","properties":{"rental":{"type":"object","description":"Only for collectibles regarding rental business. Cannot be used in combination with housing_charge. Currently only supported with the Intrum collection agency.","properties":{"address":{"type":"string","description":"Address of the rental target or the housing company"},"current_target_amount":{"type":"number","format":"double","description":"Total invoice sum assumed if target is not given."},"contract_expiry_date":{"type":"string","format":"date","description":"YYYY-MM-DD format. Applicable for temporary contracts."},"contract_type":{"type":"string","description":"continuous assumed if contract_expiry_date is not given","enum":["continuous","temporary"]}},"required":["address"]},"housing_charge":{"type":"object","description":"Only for collectibles regarding housing charges. Cannot be used in combination with rental. Currently only supported with the Intrum collection agency.","properties":{"address":{"type":"string","description":"Address of the target for which housing charge is collected"}},"required":["address"]}}},"assignment_summary":{"type":"string","description":"Summary of the assignment, will be included in the reminder and collection letters. Length 2-64 characters."}},"required":["collection_type"],"description":"Post assignment for invoice"},"ReportsDefinitions":{"type":"object","properties":{"criteria":{"type":"array","items":{"$ref":"#/definitions/Criteria"},"description":"User reporting criteria"},"disclaimer_text":{"type":"string","description":"Purpose of user reporting disclaimer text"},"disclaimer_texts":{"type":"array","items":{"$ref":"#/definitions/Translation"},"description":"Purpose of user reporting disclaimer text, translated in all supported languages"}},"description":"ReportsDefinitions model"},"Criteria":{"type":"object","properties":{"name":{"type":"string","description":"Criteria name"},"friendly_name":{"type":"string","description":"Criteria friendly name"},"friendly_names":{"type":"array","items":{"$ref":"#/definitions/Translation"},"description":"Criteria friendly name, translated in all supported languages"},"text":{"type":"string","description":"Criteria text"},"texts":{"type":"array","items":{"$ref":"#/definitions/Translation"},"description":"Criteria text, translated in all supported languages"}}},"Translation":{"type":"object","properties":{"lang":{"type":"string","description":"Language ISO code the text is translated to"},"value":{"type":"string","description":"Translated text"}}},"Invoices_HttpApi_Entities_Invoice":{"type":"object","properties":{"id":{"type":"string","description":"Invoice ID"},"status":{"type":"string","enum":["PENDING","DELIVERED","FAILED"],"description":"Current status of document"},"reference":{"type":"string","description":"Reference number"},"number":{"type":"string","description":"Invoice number"},"sender":{"$ref":"#/definitions/Invoices_HttpApi_Entities_InvoiceSenderParty","description":"Sending party"},"recipient":{"$ref":"#/definitions/Invoices_HttpApi_Entities_InvoiceRecipientParty","description":"Recipient party"},"received_at":{"type":"string","format":"date-time","description":"The timestamp when invoice was received"},"created_at":{"type":"string","format":"date-time","description":"The timestamp when invoice was created"},"date":{"type":"string","format":"date","description":"Invoice date"},"date_due":{"type":"string","format":"date","description":"Invoice due date"},"source_format":{"type":"string","description":"Format the invoice was created from"},"sum":{"type":"number","format":"float","description":"Invoice sum"},"sum_tax":{"type":"number","format":"float","description":"Invoice sum with tax"},"currency":{"type":"string","description":"Invoice currency"},"origin":{"type":"string","enum":["INTERNAL","EXTERNAL","SCAN"],"description":"Invoice origin"},"origin_type":{"type":"string","enum":["SCAN_PDF","SCAN_PAPER","AUTOSCAN","SCAN","null"],"description":"Invoice origin type. Not null only if origin is SCAN.\n                          SCAN_PDF - Scanned from a PDF file\n                          SCAN_PAPER - Scanned from a paper invoice\n                          AUTOSCAN - Automatically scanned from a PDF file\n                          SCAN - Scanned from non-invoice material\n                          null - Non scan origin"},"destination":{"type":"string","description":"Invoice destination"},"comment":{"type":"string","description":"Custom comment"},"files":{"type":"array","items":{"$ref":"#/definitions/Invoices_HttpApi_Entities_InvoiceFile"},"description":"Files attached to the invoice"},"actions":{"type":"array","items":{"$ref":"#/definitions/Invoices_HttpApi_Entities_InvoiceAction"},"description":"Invoice actions"},"revision":{"type":"object","description":"Data set after resending the invoice"}},"required":["source_format","sum","sum_tax","currency"],"description":"Invoices_HttpApi_Entities_Invoice model"},"Invoices_HttpApi_Entities_InvoiceSenderParty":{"type":"object","properties":{"eia":{"type":"string","description":"Electronic Identifier Address"},"bid":{"type":"string","description":"Business ID / Organisation number"},"name":{"type":"string","description":"Name of party"},"country":{"type":"string","description":"Two letter country code of the party"}}},"Invoices_HttpApi_Entities_InvoiceRecipientParty":{"type":"object","properties":{"eia":{"type":"string","description":"Electronic Identifier Address"},"bid":{"type":"string","description":"Business ID / Organisation number"},"name":{"type":"string","description":"Name of party"},"country":{"type":"string","description":"Two letter country code of the party"},"operator":{"type":"string","description":"Recipients operator"}}},"Invoices_HttpApi_Entities_InvoiceFile":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the file"},"filename":{"type":"string","description":"File name"},"type":{"type":"string","description":"File type. Can be ATTACHMENT, UPO, CLEARED_DOCUMENT.\n\n- **ATTACHMENT**: Generic attachment file\n- **UPO**: UPO (Urzędowe Poświadczenie Odbioru) file from KSeF network.\nThe Official Acknowledgment of Receipt of the invoice sent to KSeF.\nOnly available for invoices sent in KSeF network.\n\n- **CLEARED_DOCUMENT**: The official document as submitted to or processed by a government\ne-invoicing network (e.g. the FA3 file registered with KSeF in Poland).\nAvailable for invoices exchanged through a clearing network.\n\n"},"mimetype":{"type":"string","description":"Mime type passed when created or inferred from file extension"},"href":{"type":"string","description":"Direct link for accesing the file content"}},"required":["id"]},"Invoices_HttpApi_Entities_InvoiceAction":{"type":"object","properties":{"type":{"type":"string","enum":["RECEIVED","CREATED","SENT","DELIVERED","INFO","ERROR"],"description":"The type of event that happened"},"channel":{"type":"string","enum":["EINVOICE","PRINT","SCAN","EMAIL"],"description":"Channel the event is related to. For example from where the invoice is coming from or where it was sent."},"channel_details":{"$ref":"#/definitions/Invoices_HttpApi_Entities_InvoiceActionChannelDetails","description":"Additional information about the channel."},"message":{"type":"string","description":"Additional message related to the event"},"key":{"type":"string","enum":[null,"action_created","action_sent_print","action_sent_email","action_error","action_route_failed","action_incoming_receive","action_incoming_bank","action_internal_sent","action_sent_email_failed","action_seen","action_send_fail","action_accepted","action_paper_ordered","action_sent_paper","action_expired","action_confirmed","action_declined","action_disputed","action_archived","action_paid","action_reminder","action_delivered","action_delivery_failed","action_signed","action_trx_ok","action_trx_fail","action_trx_delay","action_canceled","action_collection","action_external_delivery","action_notice","action_reminder_and_collection","action_send_without_attachments"],"description":"The unique action key"},"happened_at":{"type":"string","format":"date-time","description":"When the event happened"}},"required":["type","happened_at"],"description":"Invoices_HttpApi_Entities_InvoiceAction model"},"Invoices_HttpApi_Entities_InvoiceActionChannelDetails":{"type":"object","properties":{"network":{"type":"string"},"operator":{"type":"string"},"address":{"type":"string"},"print_type":{"type":"string"},"type":{"type":"string"},"eia":{"type":"string"},"info_type":{"type":"string"},"notification_type":{"type":"string"},"external_number":{"type":"string","description":"When an invoice is sent or received via a centralized e-invoicing system that assignes its own unique identifier to each invoice, this field contains that identifier.\nFor example, in Poland, the ksefNumber is used in the KSeF system to uniquely identify invoices within that system.\n\nThis field is only visible when the InvoiceAction has key: action_external_delivery.\n"}}},"Invoices_HttpApi_Entities_InvoiceDetectResults":{"type":"object","properties":{"status":{"type":"array","items":{"type":"string","enum":["OK","WARN","DISABLED"]},"description":"Overall status of the checks"},"executed_checks":{"type":"array","items":{"type":"string"},"description":"Checks executed by Detect service"},"findings":{"type":"array","items":{"type":"string"},"description":"Findings found by Detect service"}},"description":"Invoices_HttpApi_Entities_InvoiceDetectResults model"},"patchV1InvoicesIdInvoiceEvents":{"type":"object","properties":{"state":{"type":"string","description":"State to change to","enum":["CREATED","HANDLED"]}},"required":["state"],"description":"Change state for recevied events"},"putV1InvoicesIdRerouteEinvoice":{"type":"object","properties":{"recipient_eia":{"type":"string","description":"Recipient electronic invoice address"},"recipient_operator":{"type":"string","description":"Recipient operator"}},"required":["recipient_eia","recipient_operator"],"description":"Reroutes invoice via einvoice"},"putV1InvoicesIdRerouteEmail":{"type":"object","properties":{"recipient_email":{"type":"string","description":"Recipient email address"}},"required":["recipient_email"],"description":"Reroutes invoice via email"},"putV1InvoicesIdReroutePrint":{"type":"object","properties":{"recipient_name":{"type":"string","description":"Recipient name"},"recipient_address1":{"type":"string","description":"Recipient address line 1"},"recipient_address2":{"type":"string","description":"Recipient address line 2"},"recipient_post_code":{"type":"string","description":"Recipient post code"},"recipient_post_office":{"type":"string","description":"Recipient post office"},"recipient_state":{"type":"string","description":"Recipient state"},"recipient_country":{"type":"string","description":"Recipient country in ISO 3166-1 alpha-2 format (2 letters)","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","CV","KH","CM","CA","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","SZ","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MK","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","XK"]}},"required":["recipient_name","recipient_address1","recipient_post_code","recipient_post_office","recipient_country"],"description":"Reroutes invoice via print"},"postV1InvoicesIdReports":{"type":"object","properties":{"reason":{"type":"array","description":"Reporting reason. Can be multiple.","items":{"type":"string","enum":["NONEXISTENT_PRODUCT","OFFERS_AS_INVOICES","UNKNOWN_COMPANY","INVOICE_NOT_FOLLOWING_LAW","MISLEADING_NAME","IMPOSSIBLE_TO_CONTACT","MISLEADING_MARKETING","COMPANY_NOT_FOLLOWING_LAW","KNOWN_FOR_FRAUD_ATTEMPTS","KNOWN_FOR_SUSPICIOUS_ACTIVITIES"]}},"contact_email":{"type":"string","description":"Contact email for reporter in case of follow up questions"},"description":{"type":"string","description":"Description for reporting with certain reasons"}},"required":["reason","contact_email"],"description":"Report sender of fraud attempt"},"UserReport":{"type":"object","properties":{"id":{"type":"string","description":"User report id"},"company_bid":{"type":"string","description":"Bid of reported company"},"company_name":{"type":"string","description":"Name of reported company"},"company_country_code":{"type":"string","description":"Country code of reported company"},"company_bank_account":{"type":"string","description":"Bank account of reported company"},"reporter_user_id":{"type":"string","description":"Id of reporter user"},"reporter_contact_email":{"type":"string","description":"Contact email of reporter"},"invoice_id":{"type":"string","description":"Reported invoice id"},"reasons":{"type":"array","items":{"$ref":"#/definitions/Criteria"},"description":"Selected reasons at report time"},"additional_explanation":{"type":"string","description":"Additional explanation given by the user at report time"},"report_date":{"type":"string","format":"date-time","description":"Timestamp when report was done"}},"description":"UserReport model"},"postV1InvoicesIdResponsesNemhandel":{"type":"object","properties":{"response":{"type":"string","description":"Invoice response type","enum":["MessageAcknowledgement","InProcess","UnderQuery","ConditionallyAccepted","Rejected","Accepted","PartiallyPaid","FullyPaid"]},"reason":{"type":"string","description":"Reason for response, required for some responses"}},"required":["response"],"description":"Sets the business response for an invoice in the Nemhandel network. When an invoice has a final response you cannot set another response. The responses have to be set in a predefined order, specified by the standards.Note: This API has a vendor lock. To enable access, please contact Maventa Support before using this endpoint."},"Invoices_HttpApi_Entities_InvoiceResponseNemhandel":{"type":"object","properties":{"is_requested":{"type":"boolean","description":"Specifies if the response is requested by the original sender of the invoice"}},"description":"Invoices_HttpApi_Entities_InvoiceResponseNemhandel model"},"API_Entities_CompanyProfile":{"type":"object","properties":{"id":{"type":"string","description":"Profile unique id"},"status":{"type":"string","enum":["active","pending","error"],"description":"Status of profile registration"},"last_event":{"$ref":"#/definitions/API_Entities_CompanyProfileEvent","description":"Latest error related event for the registration"},"profile":{"type":"string","description":"Profile name (DEPRECATED)"},"profiles":{"type":"array","items":{"type":"string"},"description":"List of profile names"},"profile_version":{"type":"string","description":"Profile version, eg. EHF30, PEPPOLBIS30"},"endpoint_id":{"type":"string","description":"Endpoint identifier"},"scheme":{"type":"string","description":"ISO6523 code of the endpoint_id scheme. eg. 0192 for NO:ORG"},"network":{"type":"string","description":"Target network, defaults to PEPPOL"},"profiles_with_extensions":{"type":"array","items":{"$ref":"#/definitions/API_Entities_CompanyProfileProfilesWithExtensions"},"description":"List of profile names with extensions"},"network_settings":{"type":"object","description":"Additional network settings"}},"description":"API_Entities_CompanyProfile model"},"API_Entities_CompanyProfileEvent":{"type":"object","properties":{"message":{"type":"string","description":"Information about the event"},"created_at":{"type":"string","format":"date-time","description":"Created timestamp"}},"required":["created_at"]},"API_Entities_CompanyProfileProfilesWithExtensions":{"type":"object","properties":{"profile_name":{"type":"string","description":"Profile name"},"extensions":{"type":"string","description":"Active extensions"}}},"postV1CompanyProfiles":{"type":"object","properties":{"profiles":{"type":"array","description":"List of profile names","items":{"type":"string"}},"profile_version":{"type":"string","description":"Profile version, eg. EHF30, PEPPOLBIS30"},"endpoint_id":{"type":"string","description":"Endpoint identifier"},"scheme":{"type":"string","description":"ISO6523 code of the endpoint_id scheme. eg. 0192 for NO:ORG"},"network":{"type":"string","description":"Target network, defaults to PEPPOL"},"profiles_with_extensions":{"type":"array","description":"List of profile names with extensions","items":{"type":"string"}},"network_settings":{"type":"object","description":"Additional network settings"}},"description":"Create network registration request"},"putV1CompanyProfilesIdExtensions":{"type":"object","properties":{"profile_name":{"type":"string","description":"Profile name"},"extensions":{"type":"array","description":"Extensions","items":{"type":"string","enum":["GACCOUNT10"]}}},"required":["profile_name","extensions"],"description":"EXPERIMENTAL Create extensions for profiles"},"patchV1CompanyProfilesId":{"type":"object","properties":{"network_settings":{"type":"object","description":"Additional network settings"}},"description":"Update a network registration"},"API_Entities_CompanySettings_Settings":{"type":"object","properties":{"details":{"$ref":"#/definitions/API_Entities_CompanySettings_CompanyDetails","description":"Company details"},"address":{"$ref":"#/definitions/API_Entities_CompanySettings_CompanyAddress","description":"Company address"},"invoice_notifications":{"$ref":"#/definitions/API_Entities_CompanySettings_CompanyInvoiceNotifications","description":"Company invoice notifications"},"send_invoice_email":{"$ref":"#/definitions/API_Entities_CompanySettings_CompanySendInvoiceEmail","description":"Company send invoices via emails"},"send_invoice_print":{"$ref":"#/definitions/API_Entities_CompanySettings_CompanySendInvoicePrintSettings","description":"Company invoice sending print settings"},"send_invoice_general":{"$ref":"#/definitions/API_Entities_CompanySettings_CompanySendInvoiceGeneralSettings","description":"Company invoice sending general settings"},"logos":{"$ref":"#/definitions/API_Entities_CompanySettings_CompanyLogos","description":"Company logos"},"email_reports":{"$ref":"#/definitions/API_Entities_CompanySettings_CompanyEmailReports","description":"Company email reports settings"},"billing_details":{"$ref":"#/definitions/API_Entities_CompanySettings_CompanyBillingDetails","description":"Company billing details"}},"description":"API_Entities_CompanySettings_Settings model"},"API_Entities_CompanySettings_CompanyDetails":{"type":"object","properties":{"name":{"type":"string","description":"Name of the company"},"email":{"type":"string","description":"Main email address"},"website":{"type":"string","description":"URL to company web pages"},"country":{"type":"string","description":"Company's country"},"bid":{"type":"string","description":"Company's business id"},"vat_number":{"type":"string","description":"Company's VAT number"}}},"API_Entities_CompanySettings_CompanyAddress":{"type":"object","properties":{"street_address":{"type":"string","description":"Street address"},"post_code":{"type":"string","description":"Post code"},"post_office":{"type":"string","description":"Post office"},"city":{"type":"string","description":"City"},"country":{"type":"string","description":"Country as a two letter country code"}}},"API_Entities_CompanySettings_CompanyInvoiceNotifications":{"type":"object","properties":{"on_receiving":{"$ref":"#/definitions/API_Entities_CompanySettings_CompanySendInvoiceEmailOnReceivingData","description":"Company receives notifications for incoming invoices"},"on_send_errors":{"$ref":"#/definitions/API_Entities_CompanySettings_CompanySendInvoiceEmailOnSendErrorsData","description":"Email addresses for sending related errors"}}},"API_Entities_CompanySettings_CompanySendInvoiceEmailOnReceivingData":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Enable notifications for incoming invoices"},"how_to_send":{"type":"string","description":"Sent to company email or other email"},"other_email":{"type":"string","description":"Email address for receiving notifications for incoming invoices"}}},"API_Entities_CompanySettings_CompanySendInvoiceEmailOnSendErrorsData":{"type":"object","properties":{"to_user":{"type":"boolean","description":"Users get informed on invoice send errors"},"to_emails":{"type":"array","items":{"type":"string"},"description":"Email addresses for sending related errors"}}},"API_Entities_CompanySettings_CompanySendInvoiceEmail":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Describe if send via email is enabled"},"how_to_send":{"type":"string","enum":["EMBEDDED","WITH_OBJECTIONS","WITH_LINK","EMBEDDED_MERGE"],"description":"Describe which method to use to send invoices via email."},"reminder_frequency":{"type":"number","description":"Describes the frequency of email reminder’s for open invoices in days."},"content_data":{"$ref":"#/definitions/API_Entities_CompanySettings_CompanySendInvoiceEmailContentData","description":"Define the content to be added to the email"}}},"API_Entities_CompanySettings_CompanySendInvoiceEmailContentData":{"type":"object","properties":{"note_to_receiver":{"type":"string","description":"What message to be added to the sent email"},"contact":{"$ref":"#/definitions/API_Entities_CompanySettings_CompanySendInvoiceEmailContentDataContactData","description":"Define the content to the added to the email"}}},"API_Entities_CompanySettings_CompanySendInvoiceEmailContentDataContactData":{"type":"object","properties":{"email":{"type":"string","description":"reply-to email, which needs to be verified"},"name":{"type":"string","description":"Name of the person to be contacted"},"phone":{"type":"string","description":"Phone number to be contacted"}}},"API_Entities_CompanySettings_CompanySendInvoicePrintSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Print service enabled"},"letter_class":{"type":"string","description":"Print service letter class (FI SE NL only)"},"color_scheme":{"type":"string","description":"Print color (FI SE NO DK only)"},"attachment_print":{"type":"boolean","description":"Attachment print"},"marketing_page":{"type":"boolean","description":"Automatic e-invoice marketing page (FI only)"},"use_own_pdf":{"type":"boolean","description":"Use own PDFs for print service (FI NO SE DK only). NL has always on."}}},"API_Entities_CompanySettings_CompanySendInvoiceGeneralSettings":{"type":"object","properties":{"stop_duplicate_numbers":{"type":"boolean","description":"Stop duplicate invoice numbers"},"hold_multiple_recipients":{"type":"boolean","description":"Hold invoices on multiple recipients"}}},"API_Entities_CompanySettings_CompanyLogos":{"type":"object","properties":{"pdf":{"$ref":"#/definitions/API_Entities_CompanySettings_CompanyLogoData","description":"Logo used in PDFs"},"email_header":{"$ref":"#/definitions/API_Entities_CompanySettings_CompanyHeaderImage","description":"Header image used in emails"}}},"API_Entities_CompanySettings_CompanyLogoData":{"type":"object","properties":{"content":{"type":"string","description":"Base64-encoded content for logo"}},"required":["content"]},"API_Entities_CompanySettings_CompanyHeaderImage":{"type":"object","properties":{"content":{"type":"string","description":"Base64-encoded content for header image. PNG only"}},"required":["content"]},"API_Entities_CompanySettings_CompanyEmailReports":{"type":"object","properties":{"report_interval":{"type":"string","description":"Email reports interval"},"email_reports":{"type":"array","items":{"type":"string"},"description":"Email address for reports"}}},"API_Entities_CompanySettings_CompanyBillingDetails":{"type":"object","properties":{"electronic_invoicing_details":{"$ref":"#/definitions/API_Entities_CompanySettings_CompanyBillingDetailsElectronicInvoicingData","description":"Electronic invoicing details (eia and operator)"},"invoicing_email":{"type":"string","description":"Email address for billing"},"invoicing_street_address1":{"type":"string","description":"Street address for billing"},"invoicing_street_address2":{"type":"string","description":"Additional street address for billing"},"invoicing_post_code":{"type":"string","description":"Postal code for billing"},"invoicing_post_office":{"type":"string","description":"Postal office for billing"},"billing_company_id":{"type":"string","description":"Billing company UUID"}}},"API_Entities_CompanySettings_CompanyBillingDetailsElectronicInvoicingData":{"type":"object","properties":{"invoicing_eia":{"type":"string","description":"Company electronic invoicing address"},"invoicing_operator":{"type":"string","description":"Company electronic invoicing operator"}}},"patchV1CompanySettings":{"type":"object","properties":{"details":{"$ref":"#/definitions/API_Entities_CompanySettings_CompanyDetails","description":"Company details"},"address":{"$ref":"#/definitions/API_Entities_CompanySettings_CompanyAddress","description":"Company address"},"invoice_notifications":{"$ref":"#/definitions/API_Entities_CompanySettings_CompanyInvoiceNotifications","description":"Company invoice notifications"},"send_invoice_email":{"$ref":"#/definitions/API_Entities_CompanySettings_CompanySendInvoiceEmail","description":"Company send invoices via emails"},"send_invoice_print":{"$ref":"#/definitions/API_Entities_CompanySettings_CompanySendInvoicePrintSettings","description":"Company invoice sending print settings"},"send_invoice_general":{"$ref":"#/definitions/API_Entities_CompanySettings_CompanySendInvoiceGeneralSettings","description":"Company invoice sending general settings"},"logos":{"$ref":"#/definitions/API_Entities_CompanySettings_CompanyLogos","description":"Company logos"},"email_reports":{"$ref":"#/definitions/API_Entities_CompanySettings_CompanyEmailReports","description":"Email reports"},"billing_details":{"$ref":"#/definitions/API_Entities_CompanySettings_CompanyBillingDetails","description":"Company billing details"}},"required":["details","address","invoice_notifications"],"description":"Modify company settings"},"API_Entities_Notifications_Notification":{"type":"object","properties":{"id":{"type":"string","description":"Notification id"},"destination_type":{"type":"string","description":"Type of notification. Possible values: WEBHOOK, VENDOR_WEBHOOK"},"destination":{"type":"string","description":"Notification destination. For WEBHOOK and VENDOR_WEBHOOK types, must be an HTTPS URL."},"vendor_key":{"type":"string","description":"Name/Key of registered vendor key"},"events":{"type":"array","items":{"type":"string"},"description":"Type of events"}},"required":["id","destination_type","destination","events"],"description":"API_Entities_Notifications_Notification model"},"postV1CompanyNotifications":{"type":"object","properties":{"destination_type":{"type":"string","description":"Type of notification. Possible values: WEBHOOK, VENDOR_WEBHOOK"},"destination":{"type":"string","description":"Notification destination. For WEBHOOK and VENDOR_WEBHOOK types, must be an HTTPS URL."},"vendor_key":{"type":"string","description":"Name/Key of registered vendor key"},"events":{"type":"array","description":"Type of events","items":{"type":"string"}}},"required":["destination_type","destination","events"],"description":"Create new notification subscription"},"API_Entities_LinkVendorAPIKey":{"type":"object","properties":{"state":{"type":"string","description":"Link result"}},"required":["state"],"description":"API_Entities_LinkVendorAPIKey model"},"API_Entities_CompanyAuthorizationStatus":{"type":"object","properties":{"auth_state":{"type":"string","description":"The authorization state. Possible values are PENDING,SENT,SIGNED,CANCELED,NONE"},"auth_email":{"type":"string","description":"The authorization email"},"company_state":{"type":"string","description":"Trustated state of the company. Possible values are VERIFIED,UNVERIFIED,UNKNOWN"}},"required":["auth_state","auth_email","company_state"],"description":"API_Entities_CompanyAuthorizationStatus model"},"postV1CompanyAuthorization":{"type":"object","properties":{"auth_email":{"type":"string","description":"Email to send the Visma sign request to. The person signing will be strongly authenticated."},"locale":{"type":"string","description":"Locale to use on the signin invitation email, visma sign portal and agreement PDF.","enum":["FI","NO","SE","EN","NL","DK"]},"options":{"type":"string","description":"JSON string used to provide proof of KYC process. Mandatory when partner has own KYC process."}},"required":["auth_email","locale"],"description":"Authorize your company. Required to complete KYC process and take company account into use"},"API_Entities_CompanyAuthorization":{"type":"object","properties":{"status":{"type":"string","description":"The authorization result"},"count":{"type":"integer","format":"int32","description":"The number of companies that were authorized"}},"required":["status"],"description":"API_Entities_CompanyAuthorization model"},"API_Entities_CompanyUsers_User":{"type":"object","properties":{"id":{"type":"string","description":"User ID"},"email":{"type":"string","description":"Email"},"notifications_disabled":{"type":"number","description":"If set to 1, user will not receive e-mail notifications for their invoices."},"emails_disabled":{"type":"number","description":"If set to 1, user will not receive any e-mail notifications e.g. invoice send errors and such."},"role":{"type":"string","description":"User role"}},"required":["id","email"],"description":"API_Entities_CompanyUsers_User model"},"postV1CompanyUsers":{"type":"object","properties":{"email":{"type":"string","description":"User email"},"first_name":{"type":"string","description":"First name"},"last_name":{"type":"string","description":"Last name"},"phone":{"type":"string","description":"Phone number"},"user_role":{"type":"string","description":"User role","enum":["ADMIN","USER"]},"notifications_disabled":{"type":"boolean","description":"If set to true, user will not receive e-mail notifications for their invoices."},"emails_disabled":{"type":"boolean","description":"If set to true, user will not receive any e-mail notifications e.g. invoice send errors and such."}},"required":["email","first_name"],"description":"Add a new or existing user to a company"},"API_Entities_CompanyUsers_NewUser":{"type":"object","properties":{"id":{"type":"string","description":"User ID"},"email":{"type":"string","description":"Email"},"notifications_disabled":{"type":"number","description":"If set to 1, user will not receive e-mail notifications for their invoices."},"emails_disabled":{"type":"number","description":"If set to 1, user will not receive any e-mail notifications e.g. invoice send errors and such."},"role":{"type":"string","description":"User role"},"api_key":{"type":"string","description":"User API key"}},"required":["id","email","api_key"],"description":"API_Entities_CompanyUsers_NewUser model"},"patchV1CompanyUsersUserId":{"type":"object","properties":{"first_name":{"type":"string","description":"First name"},"last_name":{"type":"string","description":"Last name"},"phone":{"type":"string","description":"Phone number"},"notifications_disabled":{"type":"boolean","description":"If set to true, user will not receive e-mail notifications for their invoices."},"emails_disabled":{"type":"boolean","description":"If set to true, user will not receive any e-mail notifications e.g. invoice send errors and such."}},"description":"Update user info"},"postV1CompanyUsersUserIdRoles":{"type":"object","properties":{"user_role":{"type":"string","description":"User role","enum":["ADMIN","USER"]}},"required":["user_role"],"description":"Update user role"},"API_Entities_Company":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"description":"API_Entities_Company model"},"postV1CompanySuppliersQuery":{"type":"object","properties":{"include_notified":{"type":"boolean","description":"Include already notified suppliers","default":false},"oldest_invoice_time":{"type":"string","format":"date-time","description":"How far back to see for sent PDFss. Max 1 month. In ISO8601 format"}},"description":"[EXPERIMENTAL] Query suppliers that could send e-invoices instead PDFs"},"Suppliers_HttpApi_Entities_SuppliersQueryResult":{"type":"object","properties":{"query_id":{"type":"string","description":"Unique query identifier, valid only while query is pending"},"status":{"type":"string","enum":["pending","completed"],"description":"State of the query"},"suppliers":{"type":"array","items":{"$ref":"#/definitions/Suppliers_HttpApi_Entities_SupplierInfo"},"description":"List of suppliers"}},"required":["status"],"description":"Suppliers_HttpApi_Entities_SuppliersQueryResult model"},"Suppliers_HttpApi_Entities_SupplierInfo":{"type":"object","properties":{"company_bid":{"type":"string","description":"Business ID"},"company_country":{"type":"string","description":"Country code (ISO 3166-2)"},"company_name":{"type":"string","description":"Name of the supplier"},"email_address":{"type":"string","description":"Email address of the supplier"},"invoice_count":{"type":"integer","format":"int32","description":"Number of invoices the supplier has sent you within the specified time frame"}},"required":["company_bid","company_country","company_name"]},"postV1CompanySuppliersNotifications":{"type":"object","properties":{"suppliers":{"type":"array","description":"Suppliers related functions","items":{"type":"object","properties":{"email_address":{"type":"string","description":"Supplier email address"},"name":{"type":"string","description":"Supplier name"},"language":{"type":"string","description":"Two letter country code. Possible values: en, se, fi, nl"}},"required":["email_address","name","language"]}}},"required":["suppliers"],"description":"[EXPERIMENTAL] Create and send notifications to suppliers"},"Suppliers_HttpApi_Entities_SuppliersNotificationResult":{"type":"object","properties":{"failures":{"type":"array","items":{"$ref":"#/definitions/Suppliers_HttpApi_Entities_NotificationFailure"},"description":"List of notifications that failed to send (empty if all succeeded)"}},"description":"Suppliers_HttpApi_Entities_SuppliersNotificationResult model"},"Suppliers_HttpApi_Entities_NotificationFailure":{"type":"object","properties":{"email":{"type":"string","description":"Supplier email address"},"reason":{"type":"string","description":"Reason for failure"}}},"API_Entities_UserCompany":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier"},"name":{"type":"string","description":"Name"},"bid":{"type":"string","description":"Bid"}},"description":"API_Entities_UserCompany model"},"postV1CompaniesAuthorizations":{"type":"object","properties":{"auth_email":{"type":"string","description":"Email to send the Visma sign request to. The person signing will be strongly authenticated."},"company_ids":{"type":"array","description":"Company UUIDs to authorize. Admin user needs to have access to all of the companies given.","items":{"type":"string"}},"locale":{"type":"string","description":"Locale to use on the signin invitation email, visma sign portal and agreement PDF.","enum":["FI","NO","SE","EN","NL","DK"]},"options":{"type":"string","description":"JSON string used to provide proof of KYC process. Mandatory when partner has own KYC process."}},"required":["auth_email","company_ids","locale"],"description":"Authorize one or multiple companies. Required to complete KYC process and take company account into use"},"API_Entities_OperatorParticipant":{"type":"object","properties":{"id":{"type":"string","description":"Profile unique id"},"status":{"type":"string","enum":["active","pending","error"],"description":"Status of profile registration"},"last_event":{"$ref":"#/definitions/API_Entities_CompanyProfileEvent","description":"Latest error related event for the registration"},"profiles":{"type":"array","items":{"type":"string"},"description":"List of profile names"},"profile_version":{"type":"string","description":"Profile version, eg. EHF30, PEPPOLBIS30"},"endpoint_id":{"type":"string","description":"Endpoint identifier"},"scheme":{"type":"string","description":"ISO6523 code of the endpoint_id scheme. eg. 0192 for NO:ORG"},"network":{"type":"string","description":"The participants network"},"profiles_with_extensions":{"type":"array","items":{"$ref":"#/definitions/API_Entities_CompanyProfileProfilesWithExtensions"},"description":"List of profile names with extensions"},"role":{"type":"string","description":"Role of the participant in the network. For example SENDER or RECEIVER."},"name":{"type":"string","description":"Name of the participant"},"email":{"type":"string","description":"Email address for the participant"},"country":{"type":"string","description":"Two letter country code of the party"},"external_id":{"type":"string","description":"Unique external id for the participant"},"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp"}},"required":["network","name","email","external_id","updated_at"],"description":"API_Entities_OperatorParticipant model"},"postV1OperatorParticipants":{"type":"object","properties":{"profile":{"type":"string","description":"Profile name (DEPRECATED)"},"profiles":{"type":"array","description":"List of profile names","items":{"type":"string"}},"profile_version":{"type":"string","description":"Profile version, eg. EHF30, PEPPOLBIS30"},"endpoint_id":{"type":"string","description":"Endpoint identifier"},"scheme":{"type":"string","description":"ISO6523 code of the endpoint_id scheme. eg. 0192 for NO:ORG"},"network":{"type":"string","description":"The participants network"},"profiles_with_extensions":{"type":"array","description":"List of profile names with extensions","items":{"type":"string"}},"role":{"type":"string","description":"Role of the participant in the network. For example SENDER or RECEIVER."},"name":{"type":"string","description":"Name of the participant"},"email":{"type":"string","description":"Email address for the participant"},"country":{"type":"string","description":"Two letter country code of the party"},"external_id":{"type":"string","description":"Unique external id for the participant"}},"required":["network","name","email","external_id"],"description":"Register a participant"},"postV1OperatorNotifications":{"type":"object","properties":{"destination_type":{"type":"string","description":"Type of notification. Possible values: WEBHOOK, VENDOR_WEBHOOK"},"destination":{"type":"string","description":"Notification destination. For WEBHOOK and VENDOR_WEBHOOK types, must be an HTTPS URL."},"vendor_key":{"type":"string","description":"Name/Key of registered vendor key"},"events":{"type":"array","description":"Type of events","items":{"type":"string"}}},"required":["destination_type","destination","events"],"description":"Create new notification subscription"},"API_Entities_OperatorCompany":{"type":"object","properties":{"id":{"type":"string","description":"unique identifier"},"name":{"type":"string","description":"Name"}},"description":"API_Entities_OperatorCompany model"},"API_Entities_Endpoint":{"type":"object","properties":{"bid":{"type":"string","description":"Business ID / Organisation number"},"sending":{"type":"array","items":{"type":"string"},"description":"Available options for sending"}},"description":"API_Entities_Endpoint model"},"API_Entities_Consumer":{"type":"object","properties":{"reference_id":{"type":"string","description":"Reference to lookup entry"},"routes":{"type":"object","properties":{"dpi":{"$ref":"#/definitions/API_Entities_DpiRoute","description":"DPI route information"},"yes2all":{"$ref":"#/definitions/API_Entities_Yes2AllRoute","description":"Netbank via Yes2All registry"}}}},"description":"API_Entities_Consumer model"},"API_Entities_DpiRoute":{"type":"object","properties":{"status":{"type":"string","description":"Route status. (RECEIVING,NOT_RECEIVING,NOT_AVAILABLE,TEMPORARY_UNAVAILABLE)"},"details":{"type":"string","description":"Additional details about the route"}}},"API_Entities_Yes2AllRoute":{"type":"object","properties":{"status":{"type":"string","description":"Route status. (RECEIVING,NOT_RECEIVING,NOT_AVAILABLE,TEMPORARY_UNAVAILABLE)"},"details":{"type":"string","description":"Additional details about the route"},"efaktura_identifier":{"type":"string"}}},"API_Entities_LookupEntryReceiver":{"type":"object","properties":{"eia":{"type":"string","description":"Full Electronic Address eg: 0192:123456789"},"identifier":{"$ref":"#/definitions/API_Entities_Identifier","description":"Information about the EIA"},"network":{"type":"string","description":"Network the address belongs to"},"operator":{"type":"string","description":"Operator the address belongs to"},"document_types":{"type":"array","items":{"$ref":"#/definitions/API_Entities_DocumentType"},"description":"Document profiles supported"},"participant":{"$ref":"#/definitions/API_Entities_Participant","description":"Extra information about the participant"}},"description":"API_Entities_LookupEntryReceiver model"},"API_Entities_Identifier":{"type":"object","properties":{"scheme":{"type":"string","description":"The scheme of the identifier"},"eaid_name":{"type":"string","description":"Name of the electronic address id"},"eaid_code":{"type":"string","description":"Code of the electronic address id"},"endpoint_id":{"type":"string","description":"Endpoint id"}}},"API_Entities_DocumentType":{"type":"object","properties":{"document_type":{"type":"string","description":"The type of document supported"},"document_identifier":{"type":"string","description":"Exact definition of the document type"},"process_identifier":{"type":"string","description":"Exact definition of the process"}}},"API_Entities_Participant":{"type":"object","properties":{"id":{"type":"string","description":"A unique id for the participant"},"name":{"type":"string","description":"Name of the participant"},"bid":{"type":"string","description":"Participants Business ID"},"country":{"type":"string","description":"Two letter country code of the participant"}}},"API_Entities_JWKEntries":{"type":"object","properties":{"keys":{"type":"array","items":{"$ref":"#/definitions/API_Entities_JWKEntry"},"description":"Active keys"}},"description":"API_Entities_JWKEntries model"},"API_Entities_JWKEntry":{"type":"object","properties":{"kty":{"type":"string","description":"Key type"},"e":{"type":"string","description":"e value"},"n":{"type":"string","description":"n value"},"kid":{"type":"string","description":"Key ID"}}},"API_Entities_Operator":{"type":"object","properties":{"operator_id":{"type":"string","description":"The id of the operator"},"name":{"type":"string","description":"The name of the operator"},"country":{"type":"string","description":"The country code for this operator"}},"description":"API_Entities_Operator model"},"CheckDefinitions":{"type":"object","properties":{"app_version":{"type":"string","description":"Version of the application the definitions correspond to"},"checks":{"type":"array","items":{"$ref":"#/definitions/CheckDefinition"},"description":"All supported checks with their definitions"}},"description":"CheckDefinitions model"},"CheckDefinition":{"type":"object","properties":{"name":{"type":"string","description":"Check name"},"friendly_name":{"type":"string","description":"Check friendly name"},"friendly_names":{"type":"array","items":{"$ref":"#/definitions/Translation"},"description":"Check friendly name, translated in all supported languages"},"title":{"type":"string","description":"Check title"},"titles":{"type":"array","items":{"$ref":"#/definitions/Translation"},"description":"Check title, translated in all supported languages"},"description":{"type":"string","description":"Check description"},"descriptions":{"type":"array","items":{"$ref":"#/definitions/Translation"},"description":"Check description, translated in all supported languages"},"doc_description":{"type":"string","description":"Check documentation description"},"resource_type":{"type":"string","description":"Resource type the check is run for"},"scope":{"type":"string","description":"Resource scope the check is run for"},"scopes":{"type":"array","items":{"$ref":"#/definitions/Translation"},"description":"Resource scope the check is run for, translated in all supported languages"},"sources":{"type":"array","items":{"$ref":"#/definitions/Source"},"description":"Sources used when running the check"},"metadata":{"$ref":"#/definitions/WarningListMetadata","description":"Additional data about the check"},"possible_results":{"type":"array","items":{"$ref":"#/definitions/ResultDefinition"},"description":"List of possible results of the check"}}},"Source":{"type":"object","properties":{"name":{"type":"string","description":"Source name"},"names":{"type":"array","items":{"$ref":"#/definitions/Translation"},"description":"Source name, translated in all supported languages"}}},"WarningListMetadata":{"type":"object","properties":{"criteria":{"type":"array","items":{"$ref":"#/definitions/Criteria"},"description":"Warning List criteria"}}},"ResultDefinition":{"type":"object","properties":{"status":{"type":"string","description":"Status of the check run"},"result":{"type":"string","description":"Status of the returned result of the check "},"reason":{"type":"string","description":"Check result reason text"},"reason_code":{"type":"string","description":"Check result reason code"}}},"postV1Users":{"type":"object","properties":{"vendor_api_key":{"type":"string","description":"Vendor API key"},"email":{"type":"string","description":"User email"},"first_name":{"type":"string","description":"User first name"},"last_name":{"type":"string","description":"User last name"}},"required":["vendor_api_key","email"],"description":"Create a User"},"API_Entities_ApiUser":{"type":"object","properties":{"user_api_key":{"type":"string"}},"description":"API_Entities_ApiUser model"},"API_Entities_DocumentFileInDocument":{"type":"object","properties":{"id":{"type":"string","description":"ID of Document File"},"filename":{"type":"string","description":"File name"},"file_format":{"type":"string","description":"File format"},"mimetype":{"type":"string","description":"Mime type passed when created or inferred from file extension"},"href":{"type":"string","description":"Direct link for accesing the file content (ex: \"https://ax.maventa.com/v1/files/1234\")"},"created_at":{"type":"string","format":"date-time","description":"File creation timestamp"},"type":{"type":"string","description":"File type"},"format_version":{"type":"string","description":"Version of file format (ex.: 20)"},"document_file_links":{"type":"array","items":{"type":"object"},"example":[{"document_id":"845fd5a3-d59f-4217-b7ec-c849baefb79e","type":"ATTACHMENT"}],"description":"Array of JSONs, each containing a document_id and the corresponding document's type"}},"required":["id"],"description":"API_Entities_DocumentFileInDocument model"},"API_Entities_Document":{"type":"object","properties":{"id":{"type":"string","description":"Id as a GUID"},"type":{"type":"string","enum":["UNKNOWN","INVOICE","CREDIT_NOTE","ORDER","ORDER_RESPONSE","CATALOGUE","CATALOGUE_RESPONSE","SELF_BILLING_INVOICE","DESPATCH_ADVICE","RECEIPT","VOUCHER","BANK_FILE","REMINDER","SCAN","INVOICE_RESPONSE","MESSAGE_LEVEL_RESPONSE","EXPRESSION_OF_INTEREST_REQUEST","EXPRESSION_OF_INTEREST_RESPONSE","TENDER_STATUS_REQUEST","CALL_FOR_TENDERS","TENDER","TENDER_RECEIPT","ORDER_CHANGE","ORDER_CANCELLATION","SELF_BILLING_CREDIT_NOTE"],"description":"Type of document"},"document_identifier":{"type":"string","description":"Document identifier"},"process_identifier":{"type":"string","description":"Process identifier"},"status":{"type":"string","enum":["PROCESSING","RESERVED","DELIVERED","CONFIRMED_DELIVERY","FAILED"],"description":"Current status of document"},"reference":{"type":"string","description":"Document reference"},"number":{"type":"string","description":"Document number"},"sender":{"$ref":"#/definitions/API_Entities_DocumentParty","description":"Document sender"},"recipient":{"$ref":"#/definitions/API_Entities_DocumentRecipientParty","description":"Document recipient"},"created_at":{"type":"string","format":"date-time","description":"Document creation time"},"delivered_at":{"type":"string","format":"date-time","description":"The timestamp when sent document was delivered to the destination route"},"received_at":{"type":"string","format":"date-time","description":"The timestamp when received document was delivered to the recipient"},"last_event":{"$ref":"#/definitions/API_Entities_DocumentEvent","description":"Latest event information"},"source_format":{"type":"string","description":"Source format of the document"},"supported_formats":{"type":"array","items":{"type":"string"},"description":"Supported document formats"},"transmission_id":{"type":"string","description":"Transmission id"},"transmission_at":{"type":"string","format":"date-time","description":"Document transmission time"},"network":{"type":"string","description":"The network document is originated from"},"origin":{"type":"string","description":"The origin of the document"},"external_id":{"type":"string","description":"External identifier linked to the document"},"files":{"type":"array","items":{"$ref":"#/definitions/API_Entities_DocumentFileInDocument"},"description":"Files related to the document"}},"description":"API_Entities_Document model"},"API_Entities_DocumentParty":{"type":"object","properties":{"eia":{"type":"string","description":"Electronic Identifier Address"},"bid":{"type":"string","description":"Business ID / Organisation number"},"name":{"type":"string","description":"Name of party"},"country":{"type":"string","description":"Two letter country code of the party"},"vat":{"type":"string","description":"VAT number"}}},"API_Entities_DocumentRecipientParty":{"type":"object","properties":{"eia":{"type":"string","description":"Electronic Identifier Address"},"bid":{"type":"string","description":"Business ID / Organisation number"},"name":{"type":"string","description":"Name of party"},"country":{"type":"string","description":"Two letter country code of the party"},"vat":{"type":"string","description":"VAT number"},"operator":{"type":"string","description":"Company operator"}}},"API_Entities_DocumentEvent":{"type":"object","properties":{"code":{"type":"string","description":"Event code"},"message":{"type":"string","description":"Information about the event"},"details":{"type":"string","description":"More information about the event"},"created_at":{"type":"string","format":"date-time","description":"Created timestamp"}},"required":["created_at"],"description":"API_Entities_DocumentEvent model"},"patchV1DocumentsId":{"type":"object","properties":{"status":{"type":"string","description":"Change the state of the document.\n                                      Possible values: CONFIRMED_DELIVERY"}},"description":"Update existing document"},"Analysis":{"type":"object","properties":{"analysis_id":{"type":"string","description":"Detect status"},"analysis_type":{"type":"string","description":"Detect type"},"friendly_name":{"type":"string","description":"Detect check friendly name"},"friendly_names":{"type":"array","items":{"$ref":"#/definitions/Translation"},"description":"Detect check friendly name, translated in all supported languages"},"analysis_status":{"type":"string","description":"Detect status"},"analysis_title":{"type":"string","description":"Detect title"},"analysis_titles":{"type":"array","items":{"$ref":"#/definitions/Translation"},"description":"Detect title, translated in all supported languages"},"analysis_trigger_date":{"type":"string","format":"date-time","description":"Timestamp when check was triggered"},"analysis_origin":{"type":"string","description":"Detect resource origin"},"analysis_result":{"$ref":"#/definitions/AnalysisResult","description":"Result of the detect checks"},"analysis_results":{"type":"array","items":{"$ref":"#/definitions/AnalysisResult"},"description":"All results of the detect checks"}},"description":"Analysis model"},"AnalysisResult":{"type":"object","properties":{"status":{"type":"string","description":"Detect result status"},"text":{"type":"string","description":"Detect result text"},"texts":{"type":"array","items":{"$ref":"#/definitions/Translation"},"description":"Detect result text, translated in all supported languages"},"reason_code":{"type":"string","description":"Detect result reason code"},"check_date":{"type":"string","format":"date-time","description":"Timestamp when check was performed"},"data":{"type":"object","description":"Detect metadata"}}},"Partner_HttpApi_Entities_InvoiceEventsReceived":{"type":"object","properties":{"company_id":{"type":"string","description":"Company ID"},"invoice_id":{"type":"string","description":"Invoice ID"},"state":{"type":"string","enum":["CREATED","HANDLED"],"description":"Invoice event state"},"created_at":{"type":"string","format":"date-time","description":"When the event happened"}},"description":"Partner_HttpApi_Entities_InvoiceEventsReceived model"},"Partner_HttpApi_Entities_InvoiceEventsSentError":{"type":"object","properties":{"company_id":{"type":"string","description":"Company ID"},"invoice_id":{"type":"string","description":"Invoice ID"}},"description":"Partner_HttpApi_Entities_InvoiceEventsSentError model"},"Partner_HttpApi_Entities_CompanyLookups":{"type":"object","properties":{"company_bid":{"type":"string","description":"Company BID"},"company_status":{"type":"string","description":"Company status (FREE or RESERVED)"}},"description":"Partner_HttpApi_Entities_CompanyLookups model"},"postV1PartnerScanServiceLyanthe":{"type":"object","properties":{"company_id":{"type":"string","description":"Company id"},"lyanthe_email_address":{"type":"string","description":"Lyanthe scan email address"}},"required":["company_id","lyanthe_email_address"],"description":"[EXPERIMENTAL] Mark Lyanthe scan service as active."},"API_Entities_ScanService":{"type":"object","properties":{"scan_address":{"$ref":"#/definitions/API_Entities_ScanAddress"}},"description":"API_Entities_ScanService model"},"API_Entities_ScanAddress":{"type":"object","properties":{"email_address":{"type":"string"}}},"postV1PartnerTakeovers":{"type":"object","properties":{"company_id":{"type":"string","description":"Id of company to take over"}},"required":["company_id"],"description":"[EXPERIMENTAL] Start takeover process"},"FiBankMessages_HttpApi_Entities_FiBankMessageStatus":{"type":"object","properties":{"status":{"type":"string","enum":["OK","ERROR"],"description":"Current status of message"},"error_message_id":{"type":"string","description":"Id for the associated error message if available. Only when status is ERROR"}},"description":"FiBankMessages_HttpApi_Entities_FiBankMessageStatus model"}}}